.golangci.yml

# This code is licensed under the terms of the MIT license.

run:
    # Timeout for analysis, e.g. 30s, 5m.
    # Default: 1m
    timeout: 3m

# This file contains only configs which differ from defaults.
# All possible options can be found here https://github.com/golangci/golangci-lint/blob/master/.golangci.reference.yml
linters-settings:
    cyclop:
        # The maximal code complexity to report.
        # Default: 10
        max-complexity: 30
        # The maximal average package complexity.
        # If it's higher than 0.0 (float) the check is enabled
        # Default: 0.0
        package-average: 10.0

    errcheck:
        # Report about not checking of errors in type assertions: `a := b.(MyStruct)`.
        # Such cases aren't reported by default.
        # Default: false
        check-type-assertions: true

    funlen:
        # Checks the number of lines in a function.
        # If lower than 0, disable the check.
        # Default: 60
        lines: 100
        # Checks the number of statements in a function.
        # If lower than 0, disable the check.
        # Default: 40
        statements: 50

    gocognit:
        # Minimal code complexity to report
        # Default: 30 (but we recommend 10-20)
        min-complexity: 20

    gomnd:
        # List of function patterns to exclude from analysis.
        # Values always ignored: `time.Date`
        # Default: []
        ignored-functions:
            - os.Chmod
            - os.Mkdir
            - os.MkdirAll
            - os.OpenFile
            - os.WriteFile
            - strconv.FormatFloat
            - strconv.FormatInt
            - strconv.FormatUint
            - strconv.ParseFloat
            - strconv.ParseInt
            - strconv.ParseUint

    govet:
        # Enable all analyzers.
        # Default: false
        enable-all: true
        # Disable analyzers by name.
        # Run `go tool vet help` to see all analyzers.
        # Default: []
        disable:
            - fieldalignment # too strict
            - shadow # too many false positives

    nakedret:
        # Make an issue if func has more lines of code than this setting, and it has naked returns.
        # Default: 30
        max-func-lines: 10

    nolintlint:
        # Exclude following linters from requiring an explanation.
        # Default: []
        allow-no-explanation: [ funlen, gocognit, lll ]
        # Enable to require an explanation of nonzero length after each nolint directive.
        # Default: false
        require-explanation: true
        # Enable to require nolint directives to mention the specific linter being suppressed.
        # Default: false
        require-specific: true

    tenv:
        # The option `all` will run against whole test files (`_test.go`) regardless of method/function signatures.
        # Otherwise, only methods that take `*testing.T`, `*testing.B`, and `testing.TB` as arguments are checked.
        # Default: false
        all: true

    gosec:
        excludes:
            - G107 # variables in URLs
            - G404 # use of weak random generator

linters:
    disable-all: true
    enable:
        ## enabled by default
        - errcheck # checking for unchecked errors, these unchecked errors can be critical bugs in some cases
        - gosimple # specializes in simplifying a code
        - govet # reports suspicious constructs, such as Printf calls whose arguments do not align with the format string
        - ineffassign # detects when assignments to existing variables are not used
        - staticcheck # is a go vet on steroids, applying a ton of static analysis checks
        - typecheck # like the front-end of a Go compiler, parses and type-checks Go code
        - unused # checks for unused constants, variables, functions and types
        ## disabled by default
        - asasalint # checks for pass []any as any in variadic func(...any)
        - asciicheck # checks that your code does not contain non-ASCII identifiers
        - bidichk # checks for dangerous unicode character sequences
        - bodyclose # checks whether HTTP response body is closed successfully
        #- contextcheck # checks the function whether use a non-inherited context # TODO: enable after golangci-lint uses https://github.com/sylvia7788/contextcheck/releases/tag/v1.0.7
        - cyclop # checks function and package cyclomatic complexity
        - dupl # tool for code clone detection
        - durationcheck # checks for two durations multiplied together
        - errname # checks that sentinel errors are prefixed with the Err and error types are suffixed with the Error
        - errorlint # finds code that will cause problems with the error wrapping scheme introduced in Go 1.13
        - execinquery # checks query string in Query function which reads your Go src files and warning it finds
        - exhaustive # checks exhaustiveness of enum switch statements
        - exportloopref # checks for pointers to enclosing loop variables
        - forbidigo # forbids identifiers
        - funlen # tool for detection of long functions
        #- gochecknoglobals # checks that no global variables exist
        #- gochecknoinits # checks that no init functions are present in Go code
        - gocognit # computes and checks the cognitive complexity of functions
        - goconst # finds repeated strings that could be replaced by a constant
        #- gocritic # provides diagnostics that check for bugs, performance and style issues
        - gocyclo # computes and checks the cyclomatic complexity of functions
        #- godot # checks if comments end in a period
        #- goimports # in addition to fixing imports, goimports also formats your code in the same style as gofmt
        #- gomnd # detects magic numbers                                                                                  - ENABLE LATER
        #- gomoddirectives # manages the use of 'replace', 'retract', and 'excludes' directives in go.mod
        - gomodguard # allow and block lists linter for direct Go module dependencies. This is different from depguard where there are different block types for example version constraints and module recommendations
        - goprintffuncname # checks that printf-like functions are named with f at the end
        - gosec # inspects source code for security problems
        - lll # reports long lines
        #- makezero # finds slice declarations with non-zero initial length
        - nakedret # finds naked returns in functions greater than a specified function length
        - nestif # reports deeply nested if statements
        - nilerr # finds the code that returns nil even if it checks that the error is not nil
        - nilnil # checks that there is no simultaneous return of nil error and an invalid value
        #- noctx # finds sending http request without context.Context
        - nolintlint # reports ill-formed or insufficient nolint directives
        #- nonamedreturns # reports all named returns
        - nosprintfhostport # checks for misuse of Sprintf to construct a host with port in a URL
        - predeclared # finds code that shadows one of Go's predeclared identifiers
        #- promlinter # checks Prometheus metrics naming via promlint
        - reassign # checks that package variables are not reassigned
        - revive # fast, configurable, extensible, flexible, and beautiful linter for Go, drop-in replacement of golint
        #- rowserrcheck # checks whether Err of rows is checked successfully
        #- sqlclosecheck # checks that sql.Rows and sql.Stmt are closed
        - stylecheck # is a replacement for golint
        - tenv # detects using os.Setenv instead of t.Setenv since Go1.17
        #- testpackage # makes you use a separate _test package
        - tparallel # detects inappropriate usage of t.Parallel() method in your Go test codes
        #- unconvert # removes unnecessary type conversions
        - unparam # reports unused function parameters
        - usestdlibvars # detects the possibility to use variables/constants from the Go standard library
        #- wastedassign # finds wasted assignment statements
        #- whitespace # detects leading and trailing whitespace

        ## you may want to enable
        #- decorder # checks declaration order and count of types, constants, variables and functions
        #- exhaustruct # checks if all structure fields are initialized
        #- gci # controls golang package import order and makes it always deterministic
        - godox # detects FIXME, TODO and other comment keywords
        #- goheader # checks is file header matches to pattern
        - interfacebloat # checks the number of methods inside an interface
        #- ireturn # accept interfaces, return concrete types
        #- prealloc # [premature optimization, but can be used in some cases] finds slice declarations that could potentially be preallocated
        #- varnamelen # [great idea, but too many false positives] checks that the length of a variable's name matches its scope
        #- wrapcheck # checks that errors returned from external packages are wrapped

        ## disabled
        #- containedctx # detects struct contained context.Context field
        #- depguard # [replaced by gomodguard] checks if package imports are in a list of acceptable packages
        #- dogsled # checks assignments with too many blank identifiers (e.g. x, _, _, _, := f())
        #- errchkjson # [don't see profit + I'm against of omitting errors like in the first example https://github.com/breml/errchkjson] checks types passed to the json encoding functions. Reports unsupported types and optionally reports occasions, where the check for the returned error can be omitted
        #- forcetypeassert # [replaced by errcheck] finds forced type assertions
        #- goerr113 # [too strict] checks the errors handling expressions
        #- gofmt # [replaced by goimports] checks whether code was gofmt-ed
        #- gofumpt # [replaced by goimports, gofumports is not available yet] checks whether code was gofumpt-ed
        #- grouper # analyzes expression groups
        #- importas # enforces consistent import aliases
        #- logrlint # [owner archived repository] checks logr arguments
        #- maintidx # measures the maintainability index of each function
        #- misspell # [useless] finds commonly misspelled English words in comments
        #- nlreturn # [too strict and mostly code is not more readable] checks for a new line before return and branch statements to increase code clarity
        #- paralleltest # [too many false positives] detects missing usage of t.Parallel() method in your Go test
        #- tagliatelle # checks the struct tags
        #- thelper # detects golang test helpers without t.Helper() call and checks the consistency of test helpers
        #- wsl # [too strict and mostly code is not more readable] whitespace linter forces you to use empty lines

        ## deprecated
        #- deadcode # [deprecated, replaced by unused] finds unused code
        #- exhaustivestruct # [deprecated, replaced by exhaustruct] checks if all struct's fields are initialized
        #- golint # [deprecated, replaced by revive] golint differs from gofmt. Gofmt reformats Go source code, whereas golint prints out style mistakes
        #- ifshort # [deprecated] checks that your code uses short syntax for if-statements whenever possible
        #- interfacer # [deprecated] suggests narrower interface types
        #- maligned # [deprecated, replaced by govet fieldalignment] detects Go structs that would take less memory if their fields were sorted
        #- nosnakecase # [deprecated, replaced by revive var-naming] detects snake case of variable naming and function name
        #- scopelint # [deprecated, replaced by exportloopref] checks for unpinned variables in go programs
        #- structcheck # [deprecated, replaced by unused] finds unused struct fields
        #- varcheck # [deprecated, replaced by unused] finds unused global variables and constants


issues:
    # Maximum count of issues with the same text.
    # Set to 0 to disable.
    # Default: 3
    max-same-issues: 50

    exclude-rules:
        - source: "^//\\s*go:generate\\s"
          linters: [ lll ]
        - source: "(noinspection|TODO)"
          linters: [ godot, godox ]
        - source: "//noinspection"
          linters: [ gocritic ]
        - source: "^\\s+if _, ok := err\\.\\([^.]+\\.InternalError\\); ok {"
          linters: [ errorlint ]
        - path: ".skeleton"
          linters:
              - unused
              - unparam
        - path: "cli"
          linters:
              - forbidigo # need to use fmt.Print, as this is an interactive CLI
        - linters:
              - gocritic
          text: "appendAssign:"
        - linters:
              - revive
          text: "unexported-return:"
        - linters:
              - govet
          text: "shadow: declaration of \"err\" shadows declaration"