initial version

.github/dependabot.yml

@@ -0,0 +1,14 @@
+version: 2
+updates:
+  - package-ecosystem: 'github-actions'
+    directory: '/'
+    schedule:
+      interval: 'daily'
+  - package-ecosystem: 'gomod'
+    directory: '/'
+    schedule:
+      interval: 'daily'
+  - package-ecosystem: 'docker'
+    directory: '/'
+    schedule:
+      interval: 'daily'

.github/workflows/test.yml

@@ -0,0 +1,35 @@
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+name: Test
+jobs:
+  lint:
+    name: runner / golangci-lint
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out
+        uses: actions/[email protected]
+      - name: golangci-lint
+        uses: reviewdog/[email protected]
+  test:
+    strategy:
+      matrix:
+        go-version: [1.20.x, 1.21.x]
+        platform: [ubuntu-latest]
+    runs-on: ${{ matrix.platform }}
+    steps:
+      - name: Install Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: ${{ matrix.go-version }}
+      - name: Check out
+        uses: actions/[email protected]
+      - name: go test
+        run: go test -v -race -coverprofile=profile.cov ./...
+      #- name: Send coverage
+      #  uses: shogo82148/[email protected]
+      #  with:
+      #    path-to-profile: profile.cov

.golangci.yml

@@ -0,0 +1,176 @@
+# This file contains all available configuration options
+# with their default values.
+
+# options for analysis running
+run:
+  # default concurrency is a available CPU number
+  concurrency: 4
+
+  # timeout for analysis, e.g. 30s, 5m, default is 1m
+  deadline: 15m
+
+  # exit code when at least one issue was found, default is 1
+  issues-exit-code: 1
+
+  # include test files or not, default is true
+  tests: false
+
+  # list of build tags, all linters use it. Default is empty list.
+  #build-tags:
+  #  - mytag
+
+  # which dirs to skip: they won't be analyzed;
+  # can use regexp here: generated.*, regexp is applied on full path;
+  # default value is empty list, but next dirs are always skipped independently
+  # from this option's value:
+  #   	vendor$, third_party$, testdata$, examples$, Godeps$, builtin$
+  skip-dirs:
+    - /gen$
+
+  # which files to skip: they will be analyzed, but issues from them
+  # won't be reported. Default value is empty list, but there is
+  # no need to include all autogenerated files, we confidently recognize
+  # autogenerated files. If it's not please let us know.
+  skip-files:
+    - ".*\\.my\\.go$"
+    - lib/bad.go
+    - ".*\\.template\\.go$"
+
+# output configuration options
+output:
+  # colored-line-number|line-number|json|tab|checkstyle, default is "colored-line-number"
+  format: colored-line-number
+
+  # print lines of code with issue, default is true
+  print-issued-lines: true
+
+  # print linter name in the end of issue text, default is true
+  print-linter-name: true
+
+# all available settings of specific linters
+linters-settings:
+  errcheck:
+    # report about not checking of errors in type assetions: `a := b.(MyStruct)`;
+    # default is false: such cases aren't reported by default.
+    check-type-assertions: false
+
+    # report about assignment of errors to blank identifier: `num, _ := strconv.Atoi(numStr)`;
+    # default is false: such cases aren't reported by default.
+    check-blank: false
+  govet:
+    # report about shadowed variables
+    check-shadowing: true
+
+    # Obtain type information from installed (to $GOPATH/pkg) package files:
+    # golangci-lint will execute `go install -i` and `go test -i` for analyzed packages
+    # before analyzing them.
+    # By default this option is disabled and govet gets type information by loader from source code.
+    # Loading from source code is slow, but it's done only once for all linters.
+    # Go-installing of packages first time is much slower than loading them from source code,
+    # therefore this option is disabled by default.
+    # But repeated installation is fast in go >= 1.10 because of build caching.
+    # Enable this option only if all conditions are met:
+    #  1. you use only "fast" linters (--fast e.g.): no program loading occurs
+    #  2. you use go >= 1.10
+    #  3. you do repeated runs (false for CI) or cache $GOPATH/pkg or `go env GOCACHE` dir in CI.
+    use-installed-packages: false
+  golint:
+    # minimal confidence for issues, default is 0.8
+    min-confidence: 0.8
+  gofmt:
+    # simplify code: gofmt with `-s` option, true by default
+    simplify: true
+  gocyclo:
+    # minimal code complexity to report, 30 by default (but we recommend 10-20)
+    min-complexity: 10
+  maligned:
+    # print struct with more effective memory layout or not, false by default
+    suggest-new: true
+  dupl:
+    # tokens count to trigger issue, 150 by default
+    threshold: 100
+  goconst:
+    # minimal length of string constant, 3 by default
+    min-len: 3
+    # minimal occurrences count to trigger, 3 by default
+    min-occurrences: 3
+  depguard:
+      rules:
+        main:
+          files:
+            - !$test
+          allow:
+            - $gostd
+            - github.com/Djarvur/go-silly-enum
+        cmd:
+          files:
+            - "cmd/*/*.go"
+          allow:
+            - $gostd
+            - github.com/Djarvur/go-silly-enum
+        tests:
+          files:
+            - $test
+          allow:
+            - $gostd
+            - github.com/Djarvur/go-silly-enum
+
+linters:
+  #enable:
+  #  - staticcheck
+  #  - unused
+  #  - gosimple
+  enable-all: true
+  disable:
+    - exhaustivestruct # The owner seems to have abandoned the linter. Replaced by exhaustruct.
+    - ifshort          # The repository of the linter has been deprecated by the owner.
+    - maligned         # The repository of the linter has been archived by the owner. Replaced by govet 'fieldalignment'.
+    - interfacer       # The repository of the linter has been archived by the owner.
+    - deadcode         # The owner seems to have abandoned the linter. Replaced by unused.
+    - golint           # The repository of the linter has been archived by the owner. Replaced by revive.
+    - varcheck         # The owner seems to have abandoned the linter. Replaced by unused.
+    - structcheck      # The owner seems to have abandoned the linter. Replaced by unused.
+    - nosnakecase      # The repository of the linter has been deprecated by the owner. Replaced by revive(var-naming).
+    - scopelint        # The repository of the linter has been deprecated by the owner. Replaced by exportloopref.
+    - varnamelen       # Useless in the scope of this project.
+    - gci              # too many false positives
+  disable-all: false
+  #presets:
+  #  - bugs
+  #  - unused
+  fast: false
+
+issues:
+  # List of regexps of issue texts to exclude, empty list by default.
+  # But independently from this option we use default exclude patterns,
+  # it can be disabled by `exclude-use-default: false`. To list all
+  # excluded by default patterns execute `golangci-lint run --help`
+  exclude:
+    - "`parseTained` is unused"
+    - "`parseState` is unused"
+
+  # Independently from option `exclude` we use default exclude patterns,
+  # it can be disabled by this option. To list all
+  # excluded by default patterns execute `golangci-lint run --help`.
+  # Default value for this option is false.
+  exclude-use-default: false
+
+  # Maximum issues count per one linter. Set to 0 to disable. Default is 50.
+  max-per-linter: 0
+
+  # Maximum count of issues with the same text. Set to 0 to disable. Default is 3.
+  max-same: 0
+
+  # Show only new issues: if there are unstaged changes or untracked files,
+  # only those changes are analyzed, else only changes in HEAD~ are analyzed.
+  # It's a super-useful option for integration of golangci-lint into existing
+  # large codebase. It's not practical to fix all existing issues at the moment
+  # of integration: much better don't allow issues in new code.
+  # Default is false.
+  new: false
+
+  # Show only new issues created after git revision `REV`
+  #new-from-rev: REV
+
+  # Show only new issues created in git patch with set file path.
+  #new-from-patch: path/to/patch/file

README.adoc

@@ -0,0 +1,90 @@
+= go-silly-enum image:https://godoc.org/github.com/Djarvur/go-silly-enum?status.svg["GoDoc",link="http://godoc.org/github.com/Djarvur/go-silly-enum"] image:https://github.com/Djarvur/go-silly-enum/workflows/Test/badge.svg?branch=master["Build Status"] image:https://coveralls.io/repos/Djarvur/go-silly-enum/badge.svg?branch=master&service=github["Coverage Status",link="https://coveralls.io/github/Djarvur/go-silly-enum?branch=master"]
+Daniel Podolsky
+:toc:
+
+
+Simple code to extend quasi-enum support in Go
+
+== Goal
+
+We do not have standard Enum type in go, such a pity.
+
+The thing closest to Enum we have in Go is something like this:
+
+[source,go]
+----
+type Test1Enum uint8
+
+const (
+	TestVal11 Test1Enum = iota
+	TestVal12
+	TestVal13
+)
+----
+
+This is Ok (_not really_), but there a some glitches.
+
+The one most annoying for me is we will see the number printing the Enum value.
+
+[source,go]
+----
+fmt.Printf("TestVal11=%v\n", TestVal11)
+// Output is TestVal11=0x1, and I personally hate it.
+----
+
+Fortunately, we can fix with providing proper `String()` method for the type Test1Enum.
+
+[source,go]
+----
+type Test1Enum uint8
+
+func (v Test1Enum) String() string {
+	switch v {
+	case TestVal11:
+		return "TestVal11"
+	case TestVal12:
+		return "TestVal12"
+	case TestVal13:
+		return "TestVal13"
+	default:
+		return fmt.Sprintf("Test1Enum=%v", uint8(v))
+	}
+}
+
+const (
+	TestVal11 Test1Enum = iota
+	TestVal12
+	TestVal13
+)
+
+fmt.Printf("TestVal11=%v\n", TestVal11)
+// Output is TestVal11=TestVal11, nice.
+----
+
+Unfortunately, it could be annoying to maintain such `String()` methods for all the Enums we have.
+
+Fortunately, `String()` methods could be generated automatically!
+
+== How it works
+
+This app scanning the packages provided for the typed constants with type name has `Enum` suffix.
+
+For each such type it generates `String()`, `MarshalJSON() ([]byte, error)`, `UnmarshalJSON(data []byte) error` methods with all the found relative consts in use.
+
+== Installation
+
+[source,sh]
+----
+go install github.com/Djarvur/go-silly-enum/cmd/silly-enum-codegen@latest
+----
+
+== Usage
+
+[source,sh]
+----
+silly-enum-codegen generate --verbose ./internal/extractor/testdata
+----
+
+== Alternatives
+
+- https://github.com/abice/go-enum[go-enum] generates enums from comments. Great, but the values could not be used in the code without codegen, which could be annoing.

cmd/simple-converters-codegen/internal/flags/exit.go

@@ -0,0 +1,12 @@
+package flags
+
+import (
+	"os"
+
+	"golang.org/x/exp/slog"
+)
+
+func exitWithLog(code int, log *slog.Logger, msg string, logArgs ...any) {
+	log.Error(msg, logArgs...)
+	os.Exit(code)
+}

cmd/simple-converters-codegen/internal/flags/flags.go

@@ -0,0 +1,2 @@
+// Package flags contains cobra CLI stuff
+package flags

cmd/simple-converters-codegen/internal/flags/generate.go

@@ -0,0 +1,44 @@
+package flags
+
+//nolint:gci
+import (
+	"github.com/spf13/cobra"
+
+	"github.com/Djarvur/go-simple-converters/internal/generator"
+)
+
+const (
+	generateErrorCode = 2
+
+	buildTagsFlag    = "buildTags"
+	excludeTestsFlag = "excludeTests"
+)
+
+// Generate is a generate CLI command.
+var Generate = func() *cobra.Command { //nolint:gochecknoglobals
+	cmd := &cobra.Command{ //nolint:exhaustruct
+		Use:   "generate",
+		Short: "read sources and generate the code",
+		Run:   generateRun,
+		Args:  cobra.ExactArgs(1),
+	}
+
+	cmd.Flags().StringArray(buildTagsFlag, nil, "build tags to be used for sources parsing")
+	cmd.Flags().Bool(excludeTestsFlag, false, "do not process test files")
+
+	return cmd
+}()
+
+func generateRun(cmd *cobra.Command, args []string) {
+	log := slogNew(must(cmd.Flags().GetBool("verbose")))
+
+	err := generator.Generate(
+		args[0],
+		must(cmd.Flags().GetStringArray(buildTagsFlag)),
+		!must(cmd.Flags().GetBool(excludeTestsFlag)),
+		log,
+	)
+	if err != nil {
+		exitWithLog(generateErrorCode, log, "generate", "error", err)
+	}
+}

cmd/simple-converters-codegen/internal/flags/must.go

@@ -0,0 +1,9 @@
+package flags
+
+func must[T any](v T, err error) T { //nolint:ireturn
+	if err != nil {
+		panic(err)
+	}
+
+	return v
+}