.golangci.yml

# Generally copied from prometheus/prometheus.
# TODO(bwplotka): Add golangcilint, right now not
run:
  timeout: 15m

output:
  sort-results: true

linters:
  enable:
  - depguard
  - errorlint
  - gocritic
  - godot
  - gofumpt
  - goimports
  - misspell
  - nolintlint
  - perfsprint
  - predeclared
  - revive
  - testifylint
  - unconvert
  - unused
  - usestdlibvars
  - whitespace
  - loggercheck

issues:
  max-issues-per-linter: 0
  max-same-issues: 0
  # The default exclusions are too aggressive. For one, they
  # essentially disable any linting on doc comments. We disable
  # default exclusions here and add exclusions fitting our codebase
  # further down.
  exclude-use-default: false
  exclude-files:
  # Skip autogenerated files.
  - ^.*\.(pb|y)\.go$
  exclude-rules:
  - linters:
    - errcheck
    # Taken from the default exclusions (that are otherwise disabled above).
    text: Error return value of .((os\.)?std(out|err)\..*|.*Close|.*Flush|os\.Remove(All)?|.*print(f|ln)?|os\.(Un)?Setenv). is not checked
  - linters:
    - govet
    # We use many Seek methods that do not follow the usual pattern.
    text: "stdmethods: method Seek.* should have signature Seek"
  - path: _test.go
    linters:
    - errcheck
  - linters:
    - godot
    source: "^// ==="
  - linters:
    - perfsprint
    text: "fmt.Sprintf can be replaced with string concatenation"
linters-settings:
  depguard:
    rules:
      main:
        deny:
        - pkg: "sync/atomic"
          desc: "Use go.uber.org/atomic instead of sync/atomic"
        - pkg: "github.com/stretchr/testify/assert"
          desc: "Use github.com/stretchr/testify/require instead of github.com/stretchr/testify/assert"
        - pkg: "github.com/go-kit/kit/log"
          desc: "Use github.com/go-kit/log instead of github.com/go-kit/kit/log"
        - pkg: "io/ioutil"
          desc: "Use corresponding 'os' or 'io' functions instead."
        - pkg: "regexp"
          desc: "Use github.com/grafana/regexp instead of regexp"
        - pkg: "github.com/pkg/errors"
          desc: "Use 'errors' or 'fmt' instead of github.com/pkg/errors"
        - pkg: "gzip"
          desc: "Use github.com/klauspost/compress instead of gzip"
        - pkg: "zlib"
          desc: "Use github.com/klauspost/compress instead of zlib"
        - pkg: "golang.org/x/exp/slices"
          desc: "Use 'slices' instead."
  errcheck:
    exclude-functions:
    # Don't flag lines such as "io.Copy(io.Discard, resp.Body)".
    - io.Copy
    # The next two are used in HTTP handlers, any error is handled by the server itself.
    - io.WriteString
    - (net/http.ResponseWriter).Write
    # No need to check for errors on server's shutdown.
    - (*net/http.Server).Shutdown
    # Never check for logger errors.
    - (github.com/go-kit/log.Logger).Log
  goimports:
    local-prefixes: github.com/prometheus/prometheus
  gofumpt:
    extra-rules: true
  perfsprint:
    # Optimizes `fmt.Errorf`.
    errorf: false
  revive:
    # By default, revive will enable only the linting rules that are named in the configuration file.
    # So, it's needed to explicitly enable all required rules here.
    rules:
    # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md
    - name: blank-imports
    - name: comment-spacings
    - name: context-as-argument
      arguments:
      # Allow functions with test or bench signatures.
      - allowTypesBefore: "*testing.T,testing.TB"
    - name: context-keys-type
    - name: dot-imports
    - name: empty-block
    - name: error-naming
    - name: error-return
    - name: error-strings
    - name: errorf
    - name: exported
    - name: increment-decrement
    - name: indent-error-flow
    - name: package-comments
    - name: range
    - name: receiver-naming
    - name: redefines-builtin-id
    - name: superfluous-else
    - name: time-naming
    - name: unexported-return
    - name: unreachable-code
    - name: var-declaration
    - name: var-naming
      disabled: true # Consistency with dto type.
  testifylint:
    disable:
    - float-compare
    - go-require
    enable-all: true