.golangci.yml

run:
  timeout: 3m
linters:
  enable:
    - misspell
    - stylecheck
    - gocritic
    - unparam
    - unconvert
    - whitespace
    - makezero
    - gosec
    - bodyclose
    - testifylint
    - gofmt
    - revive
    - errcheck
    - copyloopvar
    - goimports
    - depguard
    - asasalint
    - asciicheck
    - bidichk
    - durationcheck
    - gocheckcompilerdirectives
    - gochecksumtype
    - makezero
    - protogetter
    - reassign
    - intrange
linters-settings:
  gocritic:
    # Which checks should be disabled; can't be combined with 'enabled-checks'; default is empty
    disabled-checks:
      - regexpMust
      - appendAssign
      - exitAfterDefer
      - ifElseChain
  gosec:
    # To specify a set of rules to explicitly exclude.
    # Available rules: https://github.com/securego/gosec#available-rules
    excludes:
      - G402
      - G404
      # TODO: enable G115 after fixing the issues
      - G115
  testifylint:
    enable:
      - blank-import
      - bool-compare
      - compares
      - empty
      - error-is-as
      - error-nil
      - expected-actual
      - formatter
      - len
      - negative-positive
      - require-error
      - suite-dont-use-pkg
      - suite-extra-assert-call
      - suite-subtest-run
      - useless-assert
    disable:
      - float-compare
      - go-require
  gofmt:
    # https://golangci-lint.run/usage/linters/#gofmt
    # disable for faster check
    simplify: false
    rewrite-rules:
      - pattern: "interface{}"
        replacement: "any"
  revive:
    ignore-generated-header: false
    severity: error
    confidence: 0.8
    rules:
      - name: atomic
        severity: warning
        exclude: [""]
        disabled: false
      - name: blank-imports
        severity: warning
        exclude: [""]
        disabled: false
      - name: confusing-naming
        severity: warning
        disabled: false
        exclude: [""]
      - name: confusing-results
        severity: warning
        disabled: false
        exclude: [""]
      - name: context-as-argument
        severity: warning
        disabled: false
        exclude: [""]
        arguments:
          - allowTypesBefore: "*testing.T,*github.com/user/repo/testing.Harness"
      - name: datarace
        severity: warning
        disabled: false
        exclude: [""]
      - name: defer
        severity: warning
        disabled: false
        exclude: [""]
        arguments:
          - ["call-chain", "loop"]
      - name: dot-imports
        severity: warning
        disabled: false
        exclude: [""]
      - name: duplicated-imports
        severity: warning
        disabled: false
        exclude: [""]
      - name: empty-block
        severity: warning
        disabled: false
        exclude: [""]
      - name: empty-lines
        severity: warning
        disabled: false
        exclude: [""]
      - name: error-return
        severity: warning
        disabled: false
        exclude: [""]
      - name: error-strings
        severity: warning
        disabled: false
        exclude: [""]
      - name: error-naming
        severity: warning
        disabled: false
        exclude: [""]
      - name: exported
        severity: warning
        disabled: false
        exclude: [""]
        arguments:
          - "checkPrivateReceivers"
          - "sayRepetitiveInsteadOfStutters"
      - name: identical-branches
        severity: warning
        disabled: false
        exclude: [""]
      - name: if-return
        severity: warning
        disabled: false
        exclude: [""]
      - name: modifies-parameter
        severity: warning
        disabled: false
        exclude: [""]
      - name: optimize-operands-order
        severity: warning
        disabled: false
        exclude: [""]
      - name: package-comments
        severity: warning
        disabled: false
        exclude: [""]
      - name: range
        severity: warning
        disabled: false
        exclude: [""]
      - name: range-val-in-closure
        severity: warning
        disabled: false
        exclude: [""]
      - name: range-val-address
        severity: warning
        disabled: false
        exclude: [""]
      - name: receiver-naming
        severity: warning
        disabled: false
        exclude: [""]
      - name: indent-error-flow
        severity: warning
        disabled: false
        exclude: [""]
      - name: superfluous-else
        severity: warning
        disabled: false
        exclude: [""]
      - name: unnecessary-stmt
        severity: warning
        disabled: false
        exclude: [""]
      - name: unreachable-code
        severity: warning
        disabled: false
        exclude: [""]
      - name: unused-parameter
        severity: warning
        disabled: false
        exclude: [""]
        arguments:
          - allowRegex: "^_"
      - name: unused-receiver
        severity: warning
        disabled: false
        exclude: [""]
      - name: useless-break
        severity: warning
        disabled: false
        exclude: [""]
      - name: var-naming
        severity: warning
        disabled: false
        exclude: [""]
      - name: waitgroup-by-value
        severity: warning
        disabled: false
        exclude: [""]
  errcheck:
    exclude-functions:
      - (*github.com/unrolled/render.Render).JSON
      - (*github.com/unrolled/render.Render).Data
      - (*github.com/unrolled/render.Render).Text
      - (net/http.ResponseWriter).Write
      - github.com/pingcap/log.Sync
      - (github.com/tikv/pd/pkg/ratelimit.Runner).RunTask
  depguard:
    rules:
      denied-deps:
        deny:
          - pkg: go.uber.org/atomic
            desc: "Use 'sync/atomic' instead of 'go.uber.org/atomic'"
          - pkg: github.com/pkg/errors
            desc: "Use 'github.com/pingcap/errors' instead of 'github.com/pkg/errors'"
issues:
  exclude-rules:
    - path: (_test\.go|pkg/mock/.*\.go|tests/.*\.go)
      linters:
        - errcheck
    # following path will enable in the future
    - path: (pd-analysis|pd-api-bench|pd-backup|pd-ctl|pd-heartbeat-bench|pd-recover|pd-simulator|pd-tso-bench|pd-ut|regions-dump|stores-dump)
      linters:
        - errcheck
  include:
    - EXC0012