diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index e53aa8c..20f80c0 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -25,7 +25,7 @@ jobs: with: token: ${{ secrets.GITHUB_TOKEN }} - - uses: golangci/golangci-lint-action@v6 + - uses: golangci/golangci-lint-action@v7 with: version: latest diff --git a/.golangci.yml b/.golangci.yml index 1a0241a..7be79ee 100644 --- a/.golangci.yml +++ b/.golangci.yml @@ -1,95 +1,27 @@ +# https://golangci-lint.run/usage/configuration/ +# yaml-language-server: $schema=https://golangci-lint.run/jsonschema/golangci.jsonschema.json +version: "2" run: - timeout: 5m - -issues: - exclude-dirs: - - 'tmp' - -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 - - 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" - - "yaml,squash" - - name: unhandled-error - arguments: - - "fmt.Println" - + go: 1.24.1 + build-tags: [safe] + modules-download-mode: readonly linters: - disable-all: true + default: none enable: - ## Enabled by default linters: + ## 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] - unused # (megacheck) Checks Go code for unused constants, variables, functions and types [fast: false, auto-fix: false] - ## Disabled by your configuration linters: + ## Recommended linters - asasalint # check for pass []any as any in variadic func(...any) [fast: false, auto-fix: false] - asciicheck # checks that all code identifiers does not have non-ASCII symbols in the name [fast: true, auto-fix: false] - bidichk # Checks for dangerous unicode character sequences [fast: true, auto-fix: false] - bodyclose # checks whether HTTP response body is closed successfully [fast: false, auto-fix: false] - #- containedctx # containedctx is a linter that detects struct contained context.Context field [fast: false, auto-fix: false] + - canonicalheader # checks whether net/http.Header uses canonical header [fast: false, auto-fix: false] + - containedctx # containedctx is a linter that detects struct contained context.Context field [fast: false, auto-fix: false] - 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] @@ -98,32 +30,32 @@ linters: - 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] - - exportloopref # checks for pointers to enclosing loop variables [fast: false, auto-fix: false] + - exptostd # Detects functions from golang.org/x/exp/ that can be replaced by std functions. [auto-fix] + - fatcontext # detects nested contexts in loops and function literals [fast: false, auto-fix: false] - forbidigo # Forbids identifiers [fast: false, auto-fix: false] - forcetypeassert # finds forced type assertions [fast: true, auto-fix: false] - gocheckcompilerdirectives # Checks that go compiler directive comments (//go:) are valid. [fast: true, auto-fix: false] - 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] - gosec # (gas) Inspects source code for security problems [fast: false, auto-fix: false] - gosmopolitan # Report certain i18n/l10n anti-patterns in your Go codebase [fast: false, auto-fix: false] - grouper # Analyze expression groups. [fast: true, auto-fix: false] + - 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] - - misspell # Finds commonly misspelled English words [fast: true, auto-fix: true] - mirror # reports wrong mirror patterns of bytes/strings usage [fast: false, auto-fix: true] + - misspell # Finds commonly misspelled English words [fast: true, auto-fix: true] - musttag # enforce field tags in (un)marshaled structs [fast: false, auto-fix: false] - nakedret # Checks that functions with naked returns are not longer than a maximum size (can be zero). [fast: true, auto-fix: false] - nilerr # Finds the code that returns nil even if it checks that the error is not nil. [fast: false, auto-fix: false] + - nilnesserr # Reports constructs that checks for err != nil, but returns a different nil value error. - nilnil # Checks that there is no simultaneous return of `nil` error and an invalid value. [fast: false, auto-fix: false] - noctx # Finds sending http request without context.Context [fast: false, auto-fix: false] - nolintlint # Reports ill-formed or insufficient nolint directives [fast: true, auto-fix: true] @@ -133,12 +65,11 @@ linters: - predeclared # find code that shadows one of Go's predeclared identifiers [fast: true, auto-fix: false] - promlinter # Check Prometheus metrics naming via promlint [fast: true, auto-fix: false] - reassign # Checks that package variables are not reassigned [fast: false, auto-fix: false] + - recvcheck # checks for receiver type consistency [fast: false, auto-fix: false] - revive # Fast, configurable, extensible, flexible, and beautiful linter for Go. Drop-in replacement of golint. [fast: false, auto-fix: false] - 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] - - tenv # tenv is analyzer that detects using os.Setenv instead of t.Setenv since Go1.17 [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] @@ -146,33 +77,35 @@ linters: - tparallel # tparallel detects inappropriate usage of t.Parallel() method in your Go test codes. [fast: false, auto-fix: false] - unconvert # Remove unnecessary type conversions [fast: false, auto-fix: false] - usestdlibvars # A linter that detect the possibility to use variables/constants from the Go standard library. [fast: true, auto-fix: false] + - usetesting # Reports uses of functions with replacement inside the testing package. [auto-fix] - wastedassign # Finds wasted assignment statements [fast: false, auto-fix: false] - whitespace # Whitespace is a linter that checks for unnecessary newlines at the start and end of functions, if, for, etc. [fast: true, auto-fix: true] - ## Don't enable + ## Discouraged linters #- cyclop # checks function and package cyclomatic complexity [fast: false, auto-fix: false] #- depguard # Go linter that checks if package imports are in a list of acceptable packages [fast: true, auto-fix: false] + #- dogsled # Checks assignments with too many blank identifiers (e.g. x, _, _, _, := f()) [fast: true, auto-fix: false] #- dupl # Tool for code clone detection [fast: true, auto-fix: false] #- dupword # checks for duplicate words in the source code [fast: true, auto-fix: false] #- dogsled # Checks assignments with too many blank identifiers (e.g. x, _, _, _, := f()) [fast: true, auto-fix: false] #- 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] - #- gci # Gci controls Go package import order and makes it always deterministic. [fast: true, auto-fix: true] - #- 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] - #- 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 FIXME, TODO and other comment keywords [fast: true, auto-fix: false] - #- gofumpt # Gofumpt checks whether code was gofumpt-ed. [fast: true, auto-fix: true] #- funlen # Tool for detection of long functions [fast: true, auto-fix: false] #- 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] #- gocognit # Computes and checks the cognitive complexity of functions [fast: true, auto-fix: false] + #- 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] #- interfacebloat # A linter that checks the number of methods inside an interface. [fast: true, auto-fix: false] - #- lll # Reports long lines [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] + #- lll # Reports long lines [fast: true, auto-fix: false] #- maintidx # maintidx measures the maintainability index of each function. [fast: true, auto-fix: false] #- nestif # Reports deeply nested if statements [fast: true, auto-fix: false] #- nlreturn # nlreturn checks for a new line before return and branch statements to increase code clarity [fast: true, auto-fix: false] + #- mnd # An analyzer to detect magic numbers. [fast: true, auto-fix: false] #- perfsprint # Checks that fmt.Sprintf can be replaced with a faster alternative. [fast: false, auto-fix: false] #- prealloc # Finds slice declarations that could potentially be pre-allocated [fast: true, auto-fix: false] #- protogetter # Reports direct reads from proto message fields when getters should be used [fast: false, auto-fix: true] @@ -184,3 +117,83 @@ 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: + exhaustive: + explicit-exhaustive-map: true + explicit-exhaustive-switch: true + default-signifies-exhaustive: true + gocritic: + disabled-checks: + - ifElseChain + - commentFormatting + gomoddirectives: + replace-local: true + replace-allow-list: + - github.com/foomo/gofunky + gosec: + confidence: medium + importas: + no-unaliased: true + misspell: + mode: restricted + 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 + - yaml,squash + - name: unhandled-error + arguments: + - fmt.Println + exclusions: + generated: lax + presets: + - comments + - common-false-positives + - legacy + - std-error-handling + rules: + - linters: + - asasalint + path: (.+)_test\.go + paths: + - tmp + - third_party$ + - builtin$ + - examples$ +formatters: + enable: + - gofmt + - goimports + exclusions: + generated: lax + paths: + - 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)$'