crowdsec/.golangci.yml

# https://github.com/golangci/golangci-lint/blob/master/.golangci.reference.yml

linters-settings:
  gci:
    sections:
     - standard
     - default
     - prefix(github.com/crowdsecurity)
     - prefix(github.com/crowdsecurity/crowdsec)

  gomoddirectives:
    replace-allow-list:
      - golang.org/x/time/rate

  govet:
    enable-all: true
    disable:
     - reflectvaluecompare
     - fieldalignment

  maintidx:
    # raise this after refactoring
    under: 15

  misspell:
    locale: US

  nestif:
    # lower this after refactoring
    min-complexity: 16

  nlreturn:
    block-size: 5

  nolintlint:
    allow-unused: false # report any unused nolint directives
    require-explanation: false # don't require an explanation for nolint directives
    require-specific: false # don't require nolint directives to be specific about which linter is being skipped

  interfacebloat:
    max: 12

  depguard:
    rules:
      wrap:
        deny:
          - pkg: "github.com/pkg/errors"
            desc: "errors.Wrap() is deprecated in favor of fmt.Errorf()"
        files:
          - "!**/pkg/database/*.go"
      yaml:
        files:
          - "!**/pkg/acquisition/acquisition.go"
          - "!**/pkg/acquisition/acquisition_test.go"
          - "!**/pkg/acquisition/modules/appsec/appsec.go"
          - "!**/pkg/acquisition/modules/cloudwatch/cloudwatch.go"
          - "!**/pkg/acquisition/modules/docker/docker.go"
          - "!**/pkg/acquisition/modules/file/file.go"
          - "!**/pkg/acquisition/modules/journalctl/journalctl.go"
          - "!**/pkg/acquisition/modules/kafka/kafka.go"
          - "!**/pkg/acquisition/modules/kinesis/kinesis.go"
          - "!**/pkg/acquisition/modules/kubernetesaudit/k8s_audit.go"
          - "!**/pkg/acquisition/modules/loki/loki.go"
          - "!**/pkg/acquisition/modules/loki/timestamp_test.go"
          - "!**/pkg/acquisition/modules/s3/s3.go"
          - "!**/pkg/acquisition/modules/syslog/syslog.go"
          - "!**/pkg/acquisition/modules/wineventlog/wineventlog_windows.go"
          - "!**/pkg/appsec/appsec.go"
          - "!**/pkg/appsec/loader.go"
          - "!**/pkg/csplugin/broker.go"
          - "!**/pkg/leakybucket/buckets_test.go"
          - "!**/pkg/leakybucket/manager_load.go"
          - "!**/pkg/parser/node.go"
          - "!**/pkg/parser/node_test.go"
          - "!**/pkg/parser/parsing_test.go"
          - "!**/pkg/parser/stage.go"
        deny:
          - pkg: "gopkg.in/yaml.v2"
            desc: "yaml.v2 is deprecated for new code in favor of yaml.v3"

  stylecheck:
    checks:
    - all
    - -ST1003   # should not use underscores in Go names; ...
    - -ST1005   # error strings should not be capitalized
    - -ST1012   # error var ... should have name of the form ErrFoo
    - -ST1016   # methods on the same type should have the same receiver name
    - -ST1022   # comment on exported var ... should be of the form ...

  revive:
    ignore-generated-header: true
    severity: error
    enable-all-rules: true
    rules:
      - name: add-constant
        disabled: true
      - name: cognitive-complexity
        # lower this after refactoring
        arguments: [119]
      - name: comment-spacings
        disabled: true
      - name: confusing-results
        disabled: true
      - name: cyclomatic
        # lower this after refactoring
        arguments: [39]
      - name: defer
        disabled: true
      - name: empty-block
        disabled: true
      - name: empty-lines
        disabled: true
      - name: error-naming
        disabled: true
      - name: flag-parameter
        disabled: true
      - name: function-result-limit
        arguments: [6]
      - name: function-length
        # lower this after refactoring
        arguments: [110, 237]
      - name: get-return
        disabled: true
      - name: increment-decrement
        disabled: true
      - name: import-alias-naming
        disabled: true
      - name: import-shadowing
        disabled: true
      - name: line-length-limit
        # lower this after refactoring
        arguments: [221]
      - name: max-control-nesting
        # lower this after refactoring
        arguments: [7]
      - name: max-public-structs
        disabled: true
      - name: nested-structs
        disabled: true
      - name: package-comments
        disabled: true
      - name: redundant-import-alias
        disabled: true
      - name: time-equal
        disabled: true
      - name: var-naming
        disabled: true
      - name: unchecked-type-assertion
        disabled: true
      - name: exported
        disabled: true
      - name: unexported-naming
        disabled: true
      - name: unexported-return
        disabled: true
      - name: unhandled-error
        disabled: true
        arguments:
          - "fmt.Print"
          - "fmt.Printf"
          - "fmt.Println"
      - name: unnecessary-stmt
        disabled: true
      - name: unused-parameter
        disabled: true
      - name: unused-receiver
        disabled: true
      - name: use-any
        disabled: true
      - name: useless-break
        disabled: true

  wsl:
    # Allow blocks to end with comments
    allow-trailing-comment: true

  gocritic:
    enable-all: true
    disabled-checks:
      - typeDefFirst
      - paramTypeCombine
      - httpNoBody
      - ifElseChain
      - importShadow
      - hugeParam
      - rangeValCopy
      - commentedOutCode
      - commentedOutImport
      - unnamedResult
      - sloppyReassign
      - appendCombine
      - captLocal
      - typeUnparen
      - commentFormatting
      - deferInLoop             #
      - sprintfQuotedString     #
      - whyNoLint
      - equalFold               #
      - unnecessaryBlock        #
      - ptrToRefParam           #
      - stringXbytes            #
      - appendAssign            #
      - tooManyResultsChecker
      - unnecessaryDefer
      - docStub
      - preferFprint

linters:
  enable-all: true
  disable:
    #
    # DEPRECATED by golangi-lint
    #
    - execinquery
    - exportloopref
    - gomnd

    #
    # Redundant
    #

    - gocyclo  # revive
    - cyclop   # revive
    - lll      # revive
    - funlen   # revive
    - gocognit # revive

    # Disabled atm

    - intrange              # intrange is a linter to find places where for loops could make use of an integer range.

    #
    # Recommended? (easy)
    #

    - dogsled               # Checks assignments with too many blank identifiers (e.g. x, _, _, _, := f())
    - errchkjson            # Checks types passed to the json encoding functions. Reports unsupported types and reports occasions, where the check for the returned error can be omitted.
    - exhaustive            # check exhaustiveness of enum switch statements
    - gci                   # Gci control golang package import order and make it always deterministic.
    - godot                 # Check if comments end in a period
    - gofmt                 # Gofmt checks whether code was gofmt-ed. By default this tool runs with -s option to check for code simplification
    - goimports             # Check import statements are formatted according to the 'goimport' command. Reformat imports in autofix mode.
    - gosec                 # (gas): Inspects source code for security problems
    - inamedparam           # reports interfaces with unnamed method parameters
    - musttag               # enforce field tags in (un)marshaled structs
    - promlinter            # Check Prometheus metrics naming via promlint
    - protogetter           # Reports direct reads from proto message fields when getters should be used
    - tagalign              # check that struct tags are well aligned
    - thelper               # thelper detects tests helpers which is not start with t.Helper() method.
    - wrapcheck             # Checks that errors returned from external packages are wrapped

    #
    # Recommended? (requires some work)
    #

    - containedctx          # containedctx is a linter that detects struct contained context.Context field
    - errname               # Checks that sentinel errors are prefixed with the `Err` and error types are suffixed with the `Error`.
    - ireturn               # Accept Interfaces, Return Concrete Types
    - mnd                   # An analyzer to detect magic numbers.
    - nilnil                # Checks that there is no simultaneous return of `nil` error and an invalid value.
    - noctx                 # Finds sending http request without context.Context
    - unparam               # Reports unused function parameters

    #
    # Formatting only, useful in IDE but should not be forced on CI?
    #

    - gofumpt               # Gofumpt checks whether code was gofumpt-ed.
    - nlreturn              # nlreturn checks for a new line before return and branch statements to increase code clarity
    - whitespace            # Whitespace is a linter that checks for unnecessary newlines at the start and end of functions, if, for, etc.
    - wsl                   # add or remove empty lines

    #
    # Well intended, but not ready for this
    #
    - dupl                  # Tool for code clone detection
    - forcetypeassert       # finds forced type assertions
    - godox                 # Tool for detection of FIXME, TODO and other comment keywords
    - err113                # Go linter to check the errors handling expressions
    - paralleltest          # Detects missing usage of t.Parallel() method in your Go test
    - testpackage           # linter that makes you use a separate _test package

    #
    # Too strict / too many false positives (for now?)
    #
    - exhaustruct           # Checks if all structure fields are initialized
    - forbidigo             # Forbids identifiers
    - gochecknoglobals      # Check that no global variables exist.
    - goconst               # Finds repeated strings that could be replaced by a constant
    - tagliatelle           # Checks the struct tags.
    - varnamelen            # checks that the length of a variable's name matches its scope

    #
    # Under evaluation
    #

    - prealloc              # Finds slice declarations that could potentially be preallocated


issues:
  # “Look, that’s why there’s rules, understand? So that you think before you
  # break ‘em.” ― Terry Pratchett

  exclude-dirs:
    - pkg/time/rate
    - pkg/metabase

  exclude-files:
    - pkg/yamlpatch/merge.go
    - pkg/yamlpatch/merge_test.go

  exclude-generated: strict

  max-issues-per-linter: 0
  max-same-issues: 0
  exclude-rules:

    # Won't fix:

    # `err` is often shadowed, we may continue to do it
    - linters:
        - govet
      text: "shadow: declaration of \"(err|ctx)\" shadows declaration"

    - linters:
        - errcheck
      text: "Error return value of `.*` is not checked"

    # Will fix, trivial - just beware of merge conflicts

    - linters:
        - perfsprint
      text: "fmt.Sprintf can be replaced .*"

    #
    # Will fix, easy but some neurons required
    #

    - linters:
        - errorlint
      text: "non-wrapping format verb for fmt.Errorf. Use `%w` to format errors"

    - linters:
        - errorlint
      text: "type assertion on error will fail on wrapped errors. Use errors.As to check for specific errors"

    - linters:
        - errorlint
      text: "type switch on error will fail on wrapped errors. Use errors.As to check for specific errors"

    - linters:
        - nosprintfhostport
      text: "host:port in url should be constructed with net.JoinHostPort and not directly with fmt.Sprintf"

    # https://github.com/timakin/bodyclose
    - linters:
        - bodyclose
      text: "response body must be closed"

    # named/naked returns are evil, with a single exception
    # https://go.dev/wiki/CodeReviewComments#named-result-parameters
    - linters:
        - nonamedreturns
      text: "named return .* with type .* found"

    - linters:
        - revive
      path: pkg/leakybucket/manager_load.go
      text: "confusing-naming: Field '.*' differs only by capitalization to other field in the struct type BucketFactory"

    - linters:
        - revive
      path: pkg/exprhelpers/helpers.go
      text: "confusing-naming: Method 'flatten' differs only by capitalization to function 'Flatten' in the same source file"

    - linters:
        - revive
      path: pkg/appsec/query_utils.go
      text: "confusing-naming: Method 'parseQuery' differs only by capitalization to function 'ParseQuery' in the same source file"

    - linters:
        - revive
      path: pkg/acquisition/modules/loki/internal/lokiclient/loki_client.go
      text: "confusing-naming: Method 'QueryRange' differs only by capitalization to method 'queryRange' in the same source file"

    - linters:
        - revive
      path: cmd/crowdsec-cli/copyfile.go

    - linters:
        - revive
      path: pkg/hubtest/hubtest_item.go
      text: "cyclomatic: .*RunWithLogFile"

    # tolerate complex functions in tests for now
    - linters:
        - maintidx
      path: "(.+)_test.go"

    # tolerate long functions in tests
    - linters:
        - revive
      path: "pkg/(.+)_test.go"
      text: "function-length: .*"

    # tolerate long lines in tests
    - linters:
        - revive
      path: "pkg/(.+)_test.go"
      text: "line-length-limit: .*"

    # tolerate deep exit in tests, for now
    - linters:
        - revive
      path: "pkg/(.+)_test.go"
      text: "deep-exit: .*"

    # we use t,ctx instead of ctx,t in tests
    - linters:
        - revive
      path: "pkg/(.+)_test.go"
      text: "context-as-argument: context.Context should be the first parameter of a function"

    # tolerate deep exit in cobra's OnInitialize, for now
    - linters:
        - revive
      path: "cmd/crowdsec-cli/main.go"
      text: "deep-exit: .*"

    - linters:
        - revive
      path: "cmd/crowdsec-cli/clihub/item_metrics.go"
      text: "deep-exit: .*"

    - linters:
        - revive
      path: "cmd/crowdsec-cli/idgen/password.go"
      text: "deep-exit: .*"

    - linters:
        - revive
      path: "pkg/leakybucket/overflows.go"
      text: "deep-exit: .*"

    - linters:
        - revive
      path: "cmd/crowdsec/crowdsec.go"
      text: "deep-exit: .*"

    - linters:
        - revive
      path: "cmd/crowdsec/api.go"
      text: "deep-exit: .*"

    - linters:
        - revive
      path: "cmd/crowdsec/win_service.go"
      text: "deep-exit: .*"