.golangci.yml

version: "2"
run:
  build-tags:
    - big
    - compatibility
    - dtest
    - integration
  modules-download-mode: readonly
  issues-exit-code: 1
  tests: true
linters:
  # NB: the v1 -> v2 migration (#4410) expanded the old `presets` blocks
  # against v2's linter set, which silently pulled in checks this repo had
  # never opted into. They were left disabled in that bump and re-enabled one
  # per follow-up PR: copyloopvar, canonicalheader, nilnesserr, iface,
  # exptostd, predeclared, intrange, prealloc, noctx, goconst.
  # recvcheck is deliberately left disabled: most of what it reports is the
  # value-receiver Marshal* / pointer-receiver Unmarshal* pairing that YAML and
  # JSON round-tripping requires, and the rest is not worth the churn.
  enable:
    - asasalint
    - canonicalheader
    - copyloopvar
    - exptostd
    - goconst
    - iface
    - intrange
    - nilnesserr
    - noctx
    - predeclared
    - prealloc
    - asciicheck
    - bidichk
    - decorder
    - dupl
    - durationcheck
    - errchkjson
    - errorlint
    - exhaustive
    - forbidigo
    - ginkgolinter
    - gocheckcompilerdirectives
    - gochecksumtype
    - gocritic
    - goheader
    - gomodguard_v2
    - goprintffuncname
    - grouper
    - importas
    - lll
    - loggercheck
    - makezero
    - misspell
    - nakedret
    - nosprintfhostport
    - reassign
    - rowserrcheck
    - sloglint
    - spancheck
    - sqlclosecheck
    - tparallel
    - unconvert
    - unparam
    - zerologlint
  disable:
    - bodyclose
    - containedctx
    - contextcheck
    - depguard
    - dogsled
    - err113
    - errname
    - exhaustruct
    - forcetypeassert
    - funlen
    - gochecknoglobals
    - gochecknoinits
    - gocyclo
    - godot
    - godox
    - gomoddirectives
    - gosec
    - gosmopolitan
    - inamedparam
    - interfacebloat
    - ireturn
    - mirror
    - mnd
    - musttag
    - nilerr
    - nilnil
    - nlreturn
    - nolintlint
    - nonamedreturns
    - paralleltest
    - promlinter
    - protogetter
    - recvcheck
    - revive
    - tagalign
    - tagliatelle
    - testifylint
    - testpackage
    - thelper
    - usestdlibvars
    - varnamelen
    - wastedassign
    - whitespace
    - wrapcheck
    - wsl
  settings:
    depguard:
      rules:
        main:
          deny:
            - pkg: github.com/sirupsen/logrus
              desc: logging is allowed only by logutils.Log
            - pkg: github.com/golang/protobuf/jsonpb
              desc: replace with github.com/gogo/protobuf/jsonpb
            - pkg: google.golang.org/protobuf/encoding/protojson
              desc: replace with github.com/gogo/protobuf/jsonpb
            - pkg: github.com/golang/protobuf/proto
              desc: replace with github.com/gogo/protobuf/proto
            - pkg: google.golang.org/protobuf/proto
              desc: replace with github.com/gogo/protobuf/proto
            - pkg: github.com/tj/assert
              desc: use github.com/stretchr/testify/assert
    dupl:
      threshold: 100
    exhaustive:
      default-signifies-exhaustive: true
    goconst:
      min-len: 3
      min-occurrences: 3
      # Count occurrences in non-test code only; test fixtures repeat
      # literals freely and would otherwise push production strings over
      # the threshold.
      ignore-tests: true
      # Boolean and sentinel words are not meaningful constants.
      ignore-string-values:
        - ^(true|false|unknown|none)$
    gocritic:
      disabled-checks:
        - hugeParam
        - rangeValCopy
        - ifElseChain
      enabled-tags:
        - performance
      settings:
        captLocal:
          paramsOnly: true
    govet:
      enable:
        - shadow
      disable:
        # new analyzer, did not run under v1.56
        - inline
    lll:
      line-length: 120
      tab-width: 1
    misspell:
      locale: US
      ignore-rules:
        - someword
    nakedret:
      max-func-lines: 30
    prealloc:
      simple: true
      range-loops: true
      for-loops: false
    staticcheck:
      checks:
        - all
        - -SA1019
        # stylecheck was merged into staticcheck in v2 but is disabled above;
        # QF is a new family. Neither ran under v1.56.
        - -ST*
        - -QF*
    unparam:
      check-exported: false
  exclusions:
    generated: lax
    rules:
      - linters:
          - lll
        source: '^//go:generate '
      - path: (.+)\.go$
        text: Using the variable on range scope `tt` in function literal
      - path: (.+)\.go$
        text: Using the variable on range scope `test` in function literal
      - path: (.+)\.go$
        text: 'shadow: declaration of "err" shadows declaration'
      - path: (.+)\.go$
        text: Profiling endpoint is automatically exposed on /debug/pprof
      - path: (.+)\.go$
        text: 'Blacklisted import `crypto/md5`: weak cryptographic primitive'
      - path: (.+)\.go$
        text: Error return value of `\(github.com\/go-kit\/kit\/log.Logger\).Log` is not checked
      - path: (.+)\.go$
        text: Error return value of `[a-zA-Z.]+.Body.Close` is not checked
      - path: (.+)\.go$
        text: 'G104: Errors unhandled'
      - path: (.+)\.go$
        text: 'G404: Use of weak random number generator (math/rand instead of crypto/rand)'
      - path: (.+)\.go$
        text: 'G103: Use of unsafe calls should be audited'
      # net.Listen / net.Dial only take a context via ListenConfig / Dialer,
      # and none of the call sites have one to pass: the replacement would be
      # (&net.ListenConfig{}).Listen(context.Background(), ...), which is
      # exactly what net.Listen already does. Keep the plain calls.
      - linters:
          - noctx
        text: '^net\.(Listen|Dial|DialTimeout) must not be called'
      - linters:
          - goconst
          - noctx
          - prealloc
        path: (.+)_test\.go
      # Test fixtures and harnesses that live in non-_test.go files.
      - linters:
          - goconst
        path: (^|/)(integration|stub|test)/
    paths:
      - .*_gen.go$
      - .*\.peg\.go$
      - generated/.*
      - eventlog/test$
      - third_party$
      - builtin$
      - examples$
issues:
  max-issues-per-linter: 0
  max-same-issues: 0
  new-from-rev: 30e1c10d456af9d3778288cfb7c247ecd06a4339
formatters:
  enable:
    - gci
    - gofmt
    - goimports
  settings:
    gci:
      sections:
        - standard
        - prefix(github.com/m3db/m3)
        - default
  exclusions:
    generated: lax
    paths:
      - .*_gen.go$
      - .*\.peg\.go$
      - generated/.*
      - eventlog/test$
      - third_party$
      - builtin$
      - examples$