.golangci.yml

issues:
  # Excluding configuration per-path, per-linter, per-text and per-source
  exclude-rules:
    # Exclude some linters from running on tests files.
    - path: _test\.go
      linters: [gosec, bodyclose, noctx]

    - path: crossdock
      linters: [noctx]

    # See https://github.com/jaegertracing/jaeger/issues/4488
    - path: internal/grpctest/
      linters: [staticcheck]

    - linters: [gocritic]
      text: "dupArg"
    - linters: [gocritic]
      text: "exitAfterDefer"
    - linters: [gocritic]
      text: "appendAssign"
  exclude-dirs-use-default: false
  exclude-dirs:
    - mocks
    - thrift-0.9.2
    - .*-gen
  exclude-files:
    - ".*.pb.go$"
  max-issues-per-linter: 0
  max-same-issues: 0

linters:
  disable:
    - errcheck
  enable:
    # Plain ASCII identifiers.
    - asciicheck

    # Checks for dangerous unicode character sequences.
    - bidichk

    # Checks whether HTTP response body is closed successfully.
    # TODO enable this but maybe find a way to disable in tests.
    - bodyclose

    # Check whether the function uses a non-inherited context.
    - contextcheck

    # Check declaration order of types, consts, vars and funcs.
    - decorder

    # Checks if package imports are in a list of acceptable packages (see cfg below).
    - depguard

    # Check for two durations multiplied together.
    - durationcheck

    # Checks `Err-` prefix for var and `-Error` suffix for error type.
    - errname

    # Suggests to use `%w` for error-wrapping.
    - errorlint

    # Checks for pointers to enclosing loop variables.
    - copyloopvar

    - gocritic
    - gofmt
    - gofumpt
    - goimports

    # Allow or ban replace directives in go.mod
    # or force explanation for retract directives.
    # Maybe enable once we get rid of old sarama.
    # - gomoddirectives

    - gosec

    # Linter that specializes in simplifying code.
    - gosimple
    - govet

    # Detects when assignments to existing variables are not used.
    - ineffassign

    - misspell

    # Finds naked/bare returns and requires change them.
    - nakedret

    # Require a bit more explicit returns.
    - nilerr

    # Finds sending HTTP request without context.Context.
    - noctx

    # Reports ill-formed or insufficient nolint directives.
    - nolintlint

    # Checks that fmt.Sprintf can be replaced with a faster alternative.
    - perfsprint

    # Fast, configurable, extensible, flexible, and beautiful linter for Go. Drop-in replacement of golint.
    - revive

    # Checks usage of github.com/stretchr/testify.
    - testifylint

    # TODO consider adding more linters, cf. https://olegk.dev/go-linters-configuration-the-right-version

linters-settings:
  depguard:
    rules:
      disallowed-deps:
        deny:
          - pkg: go.uber.org/atomic
            desc: "Use 'sync/atomic' instead of go.uber.org/atomic"
          - pkg: io/ioutil
            desc: "Use os or io instead of io/ioutil"
          - pkg: github.com/hashicorp/go-multierror
            desc: "Use errors.Join instead of github.com/hashicorp/go-multierror"
          - pkg: go.uber.org/multierr
            desc: "Use errors.Join instead of github.com/hashicorp/go-multierror"
      # crossdock-go provides assert/require similar to stretchr/testify
      # but we never want to use them outside of the crossdock tests.
      disallow-crossdock:
        deny:
          - pkg: github.com/crossdock/crossdock-go
            desc: "Do not refer to crossdock from other packages"
        files:
          - "!**/crossdock/**"

      disallow-uber/goleak:
        deny:
         - pkg: go.uber.org/goleak
           desc: "Use github.com/jaegertracing/jaeger/pkg/testutils"
        files:
          - "**_test.go"

  goimports:
    local-prefixes: github.com/jaegertracing/jaeger
  gosec:
    # To specify a set of rules to explicitly exclude.
    # Available rules: https://github.com/securego/gosec#available-rules
    excludes:
      - G104
      - G107
      - G404
      - G601
  govet:
    enable-all: true
    disable:
      # There is rarely performance differences due to padding,
      # the most noticable impact is memory usage. However,
      # the main trace data is Protobuf-generated and we ignore
      # those files from linting, so this linter is not useful.
      - fieldalignment
      # Disable shadow
      - shadow
  perfsprint:
    # Optimizes even if it requires an int or uint type cast.
    int-conversion: true
    # Optimizes into `err.Error()` even if it is only equivalent for non-nil errors.
    err-error: true
    # Optimizes `fmt.Errorf`.
    errorf: true
    # Optimizes `fmt.Sprintf` with only one argument.
    sprintf1: true
    # Optimizes into strings concatenation.
    strconcat: true
  revive:
      ignore-generated-header: true
      severity: error
      enable-all-rules: true
      # See https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md
      rules:
        # not a completely bad linter, but needs clean-up and sensible width (80 is too small)
        - name: line-length-limit
          disabled: true
          arguments: [80]
        # would be ok if we could exclude the test files, but otherwise too noisy
        - name: add-constant
          disabled: true
        # maybe enable in the future, needs more investigation
        - name: cognitive-complexity
          disabled: true
        # not sure how different from previous one
        - name: cyclomatic
          disabled: true
        # we use storage_v2, so...
        - name: var-naming
          disabled: true
        # could be useful to catch issues, but needs a clean-up and some ignores
        - name: unchecked-type-assertion
          disabled: true
        # wtf: "you have exceeded the maximum number of public struct declarations"
        - name: max-public-structs
          disabled: true
        # TBD - often triggered in tests
        - name: unhandled-error
          disabled: true
        # often looks like a red herring, needs investigation
        - name: flag-parameter
          disabled: true
        # looks like a good linter, needs cleanup
        - name: confusing-naming
          disabled: true
        # too pendantic
        - name: function-length
          disabled: true
        # definitely a good one, needs cleanup first
        - name: argument-limit
          disabled: true
        # maybe enable, needs invesitgation of the impact
        - name: import-alias-naming
          disabled: true
        # maybe enable, needs invesitgation of the impact
        - name: get-return
          disabled: true
        # investigate, could be real bugs. But didn't recent Go version changed loop variables semantics?
        - name: range-val-address
          disabled: true
        # this is idiocy, promotes less readable code. Don't enable.
        - name: var-declaration
          disabled: true
        # "no nested structs are allowed" - don't enable, doesn't make sense
        - name: nested-structs
          disabled: true
        # looks useful, but requires refactoring: "calls to log.Fatal only in main() or init() functions"
        - name: deep-exit
          disabled: true
        # this rule conflicts with nolintlint which does insist on no-space in //nolint
        - name: comment-spacings
          disabled: true
  testifylint:
    enable-all: true

run:
  go: "1.22"
  timeout: 20m