From 9dea1c32d9884d58f58acf234e469f968053cd9b Mon Sep 17 00:00:00 2001 From: Kevin Franklin Kim Date: Tue, 3 Jun 2025 10:00:24 +0200 Subject: [PATCH 1/3] feat: update golangci-lint --- .github/workflows/test.yml | 4 +- .golangci.yml | 197 +++++++++++++++++++------------------ .husky.yaml | 4 +- Makefile | 3 +- 4 files changed, 109 insertions(+), 99 deletions(-) diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index f05e935..d44c689 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -26,13 +26,13 @@ jobs: with: token: ${{ secrets.GITHUB_TOKEN }} - - uses: golangci/golangci-lint-action@v6 + - uses: golangci/golangci-lint-action@v8 with: version: latest args: --timeout=5m - name: Run tests - run: GO_TEST_TAGS=-skip go test -coverprofile=coverage.out -race -json ./... | gotestfmt + run: make test - uses: coverallsapp/github-action@v2 with: diff --git a/.golangci.yml b/.golangci.yml index f881da4..7b4a7c5 100644 --- a/.golangci.yml +++ b/.golangci.yml @@ -1,99 +1,15 @@ # yaml-language-server: $schema=https://golangci-lint.run/jsonschema/golangci.jsonschema.json # https://golangci-lint.run/usage/configuration/ - +version: "2" run: - go: 1.24.1 + go: 1.24.3 build-tags: [safe] modules-download-mode: readonly - -issues: - exclude-dirs: - - 'bin' - - 'tmp' - exclude-rules: - - path: _test\.go - linters: - - forbidigo - - forcetypeassert - -linters-settings: - # https://golangci-lint.run/usage/linters/#misspell - misspell: - mode: restricted - # https://golangci-lint.run/usage/linters/#asasalint - asasalint: - ignore-test: true - # https://golangci-lint.run/usage/linters/#exhaustive - exhaustive: - default-signifies-exhaustive: true - # https://golangci-lint.run/usage/linters/#predeclared - predeclared: - ignore: "new,error" - # https://golangci-lint.run/usage/linters/#gocritic - gocritic: - disabled-checks: - - ifElseChain - - singleCaseSwitch - - commentFormatting - # https://golangci-lint.run/usage/linters/#testifylint - testifylint: - disable: - - float-compare - # https://golangci-lint.run/usage/linters/#gosec - gosec: - confidence: medium - # https://golangci-lint.run/usage/linters/#importas - importas: - no-unaliased: true - # https://golangci-lint.run/usage/linters/#gomoddirectives - gomoddirectives: - replace-local: true - # https://golangci-lint.run/usage/linters/#revive - revive: - ignore-generated-header: true - enable-all-rules: true - rules: - - name: line-length-limit - disabled: true - - name: cognitive-complexity - disabled: true - - name: unused-parameter - disabled: true - - name: add-constant - disabled: true - - name: cyclomatic - disabled: true - - name: function-length - disabled: true - - name: function-result-limit - disabled: true - - name: flag-parameter - disabled: true - - name: unused-receiver - disabled: true - - name: argument-limit - disabled: true - - name: max-control-nesting - disabled: true - - name: comment-spacings - disabled: true - - name: struct-tag - arguments: - - "json,inline" - - name: unhandled-error - arguments: - - "fmt.Println" - - "io.Writer.Write" - - "strings.Builder.WriteString" - - name: unnecessary-stmt - disabled: true - linters: - disable-all: true + default: none enable: ## Default linters - errcheck # errcheck is a program for checking for unchecked errors in Go code. These unchecked errors can be critical bugs in some cases [fast: false, auto-fix: false] - - gosimple # (megacheck) Linter for Go source code that specializes in simplifying code [fast: false, auto-fix: false] - govet # (vet, vetshadow) Vet examines Go source code and reports suspicious constructs. It is roughly the same as 'go vet' and uses its passes. [fast: false, auto-fix: false] - ineffassign # Detects when assignments to existing variables are not used [fast: true, auto-fix: false] - staticcheck # (megacheck) It's a set of rules from staticcheck. It's not the same thing as the staticcheck binary. The author of staticcheck doesn't support or approve the use of staticcheck as a library inside golangci-lint. [fast: false, auto-fix: false] @@ -109,8 +25,8 @@ linters: - contextcheck # check whether the function uses a non-inherited context [fast: false, auto-fix: false] - copyloopvar # (go >= 1.22) copyloopvar is a linter detects places where loop variables are copied [fast: true, auto-fix: false] - decorder # check declaration order and count of types, constants, variables and functions [fast: true, auto-fix: false] - - durationcheck # check for two durations multiplied together [fast: false, auto-fix: false] - errchkjson # Checks types passed to the json encoding functions. Reports unsupported types and reports occations, where the check for the returned error can be omitted. [fast: false, auto-fix: false] + - durationcheck # check for two durations multiplied together [fast: false, auto-fix: false] - errname # Checks that sentinel errors are prefixed with the `Err` and error types are suffixed with the `Error`. [fast: false, auto-fix: false] - errorlint # errorlint is a linter for that can be used to find code that will cause problems with the error wrapping scheme introduced in Go 1.13. [fast: false, auto-fix: false] - exhaustive # check exhaustiveness of enum switch statements [fast: false, auto-fix: false] @@ -122,9 +38,7 @@ linters: - gochecksumtype # Run exhaustiveness checks on Go "sum types" [fast: false, auto-fix: false] - goconst # Finds repeated strings that could be replaced by a constant [fast: true, auto-fix: false] - gocritic # Provides diagnostics that check for bugs, performance and style issues. [fast: false, auto-fix: true] - - gofmt # Gofmt checks whether code was gofmt-ed. By default this tool runs with -s option to check for code simplification [fast: true, auto-fix: true] - goheader # Checks is file header matches to pattern [fast: true, auto-fix: true] - - goimports # Check import statements are formatted according to the 'goimport' command. Reformat imports in autofix mode. [fast: true, auto-fix: true] - gomoddirectives # Manage the use of 'replace', 'retract', and 'excludes' directives in go.mod. [fast: true, auto-fix: false] - gomodguard # Allow and block list linter for direct Go module dependencies. This is different from depguard where there are different block types for example version constraints and module recommendations. [fast: true, auto-fix: false] - goprintffuncname # Checks that printf-like functions are named with `f` at the end. [fast: true, auto-fix: false] @@ -134,7 +48,6 @@ linters: - iface # Detect the incorrect use of interfaces, helping developers avoid interface pollution. [fast: false, auto-fix: false] - importas # Enforces consistent import aliases [fast: false, auto-fix: false] - inamedparam # reports interfaces with unnamed method parameters [fast: true, auto-fix: false] - - intrange # (go >= 1.22) intrange is a linter to find places where for loops could make use of an integer range. [fast: true, auto-fix: false] - loggercheck # (logrlint) Checks key value pairs for common logger libraries (kitlog,klog,logr,zap). [fast: false, auto-fix: false] - makezero # Finds slice declarations with non-zero initial length [fast: false, auto-fix: false] - mirror # reports wrong mirror patterns of bytes/strings usage [fast: false, auto-fix: true] @@ -157,7 +70,6 @@ linters: - rowserrcheck # checks whether Rows.Err of rows is checked successfully [fast: false, auto-fix: false] - spancheck # Checks for mistakes with OpenTelemetry/Census spans. [fast: false, auto-fix: false] - sqlclosecheck # Checks that sql.Rows, sql.Stmt, sqlx.NamedStmt, pgx.Query are closed. [fast: false, auto-fix: false] - - stylecheck # Stylecheck is a replacement for golint [fast: false, auto-fix: false] - testableexamples # linter checks if examples are testable (have an expected output) [fast: true, auto-fix: false] - testifylint # Checks usage of github.com/stretchr/testify. [fast: false, auto-fix: false] - testpackage # linter that makes you use a separate _test package [fast: true, auto-fix: false] @@ -179,7 +91,6 @@ linters: #- err113 # Go linter to check the errors handling expressions [fast: false, auto-fix: false] #- exhaustruct # Checks if all structure fields are initialized [fast: false, auto-fix: false] #- funlen # Tool for detection of long functions [fast: true, auto-fix: false] - #- gci # Gci controls Go package import order and makes it always deterministic. [fast: true, auto-fix: true] #- ginkgolinter # enforces standards of using ginkgo and gomega [fast: false, auto-fix: false] #- gochecknoglobals # Check that no global variables exist. [fast: false, auto-fix: false] #- gochecknoinits # Checks that no init functions are present in Go code [fast: true, auto-fix: false] @@ -187,7 +98,6 @@ linters: #- gocyclo # Computes and checks the cyclomatic complexity of functions [fast: true, auto-fix: false] #- godot # Check if comments end in a period [fast: true, auto-fix: true] #- godox # Tool for detection of comment keywords [fast: true, auto-fix: false] - #- gofumpt # Gofumpt checks whether code was gofumpt-ed. [fast: true, auto-fix: true] #- interfacebloat # A linter that checks the number of methods inside an interface. [fast: true, auto-fix: false] #- intrange # (go >= 1.22) intrange is a linter to find places where for loops could make use of an integer range. [fast: true, auto-fix: false] #- ireturn # Accept Interfaces, Return Concrete Types [fast: false, auto-fix: false] @@ -207,3 +117,102 @@ linters: #- wrapcheck # Checks that errors returned from external packages are wrapped [fast: false, auto-fix: false] #- wsl # add or remove empty lines [fast: true, auto-fix: false] #- zerologlint # Detects the wrong usage of `zerolog` that a user forgets to dispatch with `Send` or `Msg` [fast: false, auto-fix: false] + settings: + # https://golangci-lint.run/usage/linters/#exhaustive + exhaustive: + check: [ map, switch ] + # Only run exhaustive check on map literals with "//exhaustive:enforce" comment + explicit-exhaustive-map: true + # Only run exhaustive check on switches with "//exhaustive:enforce" comment + explicit-exhaustive-switch: true + # Presence of "default" case in switch statements satisfies exhaustiveness + default-signifies-exhaustive: true + # https://golangci-lint.run/usage/linters/#gosmopolitan + gosmopolitan: + # Allow and ignore `time.Local` usages + allow-time-local: true + # https://golangci-lint.run/usage/linters/#gocritic + gocritic: + disabled-checks: + - ifElseChain + - singleCaseSwitch + - commentFormatting + # https://golangci-lint.run/usage/linters/#gosec + gosec: + # Filter out the issues with a lower severity than the given value + confidence: medium + # https://golangci-lint.run/usage/linters/#importas + importas: + # Do not allow unaliased imports of aliased packages. + no-unaliased: true + # https://golangci-lint.run/usage/linters/#revive + revive: + enable-all-rules: true + rules: + - name: line-length-limit + disabled: true + - name: cognitive-complexity + disabled: true + - name: unused-parameter + disabled: true + - name: add-constant + disabled: true + - name: cyclomatic + disabled: true + - name: function-length + disabled: true + - name: function-result-limit + disabled: true + - name: flag-parameter + disabled: true + - name: unused-receiver + disabled: true + - name: argument-limit + disabled: true + - name: max-control-nesting + disabled: true + - name: comment-spacings + disabled: true + - name: struct-tag + arguments: + - json,inline + - name: unhandled-error + arguments: + - fmt.Println + - io.Writer.Write + - strings.Builder.WriteString + - name: unnecessary-stmt + disabled: true + exclusions: + generated: lax + presets: + - comments + - common-false-positives + - legacy + - std-error-handling + rules: + - linters: + - forbidigo + - forcetypeassert + path: _test\.go + - linters: + - asasalint + path: (.+)_test\.go + paths: + - bin + - tmp + - third_party$ + - builtin$ + - examples$ +formatters: + enable: + - gofmt + - goimports + exclusions: + generated: lax + paths: + - bin + - tmp + - third_party$ + - builtin$ + - examples$ diff --git a/.husky.yaml b/.husky.yaml index 2bbd935..0284970 100644 --- a/.husky.yaml +++ b/.husky.yaml @@ -1,6 +1,6 @@ hooks: pre-commit: - - golangci-lint run --fast + - golangci-lint run --fast-only - husky lint-staged commit-msg: # only execute if not in a merge @@ -8,7 +8,7 @@ hooks: lint-staged: '*.go': - - goimports -l -w + - golangci-lint fmt lint-commit: types: '^(feat|fix|build|chore|docs|perf|refactor|revert|style|test|wip)$' diff --git a/Makefile b/Makefile index 1e411c0..b2d6dbe 100644 --- a/Makefile +++ b/Makefile @@ -27,7 +27,8 @@ doc: .PHONY: test ## Run tests test: - @go test -coverprofile=coverage.out -race -json ./... | gotestfmt + @GO_TEST_TAGS=-skip go test -coverprofile=coverage.out --tags=safe -race ./... + #@GO_TEST_TAGS=-skip go test -coverprofile=coverage.out --tags=safe -race -json ./... | gotestfmt .PHONY: lint ## Run linter From cc960268e6b20ee6884cf31e5fa8f624fddddbc8 Mon Sep 17 00:00:00 2001 From: Kevin Franklin Kim Date: Tue, 3 Jun 2025 10:00:33 +0200 Subject: [PATCH 2/3] feat: go 1.24.3 --- go.mod | 6 +++--- go.sum | 8 ++++---- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/go.mod b/go.mod index 1433847..e06cc28 100644 --- a/go.mod +++ b/go.mod @@ -1,16 +1,16 @@ module github.com/foomo/gocontemplate -go 1.24.1 +go 1.24.3 require ( github.com/stretchr/testify v1.10.0 - golang.org/x/tools v0.31.0 + golang.org/x/tools v0.33.0 ) require ( github.com/davecgh/go-spew v1.1.1 // indirect github.com/pmezard/go-difflib v1.0.0 // indirect golang.org/x/mod v0.24.0 // indirect - golang.org/x/sync v0.12.0 // indirect + golang.org/x/sync v0.14.0 // indirect gopkg.in/yaml.v3 v3.0.1 // indirect ) diff --git a/go.sum b/go.sum index 5b86362..e52002f 100644 --- a/go.sum +++ b/go.sum @@ -8,10 +8,10 @@ github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOf github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY= golang.org/x/mod v0.24.0 h1:ZfthKaKaT4NrhGVZHO1/WDTwGES4De8KtWO0SIbNJMU= golang.org/x/mod v0.24.0/go.mod h1:IXM97Txy2VM4PJ3gI61r1YEk/gAj6zAHN3AdZt6S9Ww= -golang.org/x/sync v0.12.0 h1:MHc5BpPuC30uJk597Ri8TV3CNZcTLu6B6z4lJy+g6Jw= -golang.org/x/sync v0.12.0/go.mod h1:1dzgHSNfp02xaA81J2MS99Qcpr2w7fw1gpm99rleRqA= -golang.org/x/tools v0.31.0 h1:0EedkvKDbh+qistFTd0Bcwe/YLh4vHwWEkiI0toFIBU= -golang.org/x/tools v0.31.0/go.mod h1:naFTU+Cev749tSJRXJlna0T3WxKvb1kWEx15xA4SdmQ= +golang.org/x/sync v0.14.0 h1:woo0S4Yywslg6hp4eUFjTVOyKt0RookbpAHG4c1HmhQ= +golang.org/x/sync v0.14.0/go.mod h1:1dzgHSNfp02xaA81J2MS99Qcpr2w7fw1gpm99rleRqA= +golang.org/x/tools v0.33.0 h1:4qz2S3zmRxbGIhDIAgjxvFutSvH5EfnsYrRBj0UI0bc= +golang.org/x/tools v0.33.0/go.mod h1:CIJMaWEY88juyUfo7UbgPqbC8rU2OqfAV1h2Qp0oMYI= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= From 4ba5bc8569c5a7fcf1b92fe091dc9e3380142912 Mon Sep 17 00:00:00 2001 From: Kevin Franklin Kim Date: Tue, 3 Jun 2025 10:01:36 +0200 Subject: [PATCH 3/3] chore: update dependabot --- .github/dependabot.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 99b2138..44f8855 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -4,6 +4,7 @@ version: 2 updates: - package-ecosystem: 'github-actions' + open-pull-requests-limit: 1 directory: '/' schedule: day: 'sunday' @@ -13,6 +14,7 @@ updates: patterns: ['*'] - package-ecosystem: 'gomod' + open-pull-requests-limit: 1 directory: '/' schedule: day: 'sunday'