.golangci.yml

# https://golangci-lint.run/usage/configuration/
run:
  timeout: 10m
  # skip auto-generated files.
  skip-files:
    - ".*\\.pb\\.go$"
    - ".*mock.*"

issues:
  # Maximum count of issues with the same text. Set to 0 to disable. Default is 3.
  max-same-issues: 0

linters:
  # please, do not use `enable-all`: it's deprecated and will be removed soon.
  # inverted configuration with `enable-all` and `disable` is not scalable during updates of golangci-lint
  disable-all: true
  enable:
    - asciicheck
    - bodyclose
    - depguard
    - errcheck
    - exportloopref
    - forbidigo
    - goconst
    - gocritic
    - gofmt
    - gofumpt
    - goimports
    - goprintffuncname
    - gosec
    - gosimple
    - govet
    - ineffassign
    - misspell
    - nakedret
    - noctx
    - nolintlint
    - prealloc
    - revive
    - staticcheck
    - stylecheck
    - typecheck
    - unconvert
    - unparam
    - unused
    - whitespace
    # - errorlint (TODO: re-enable in go1.20 migration)
    # - goerr113
    # - gomnd
    # - lll

linters-settings:
  goimports:
    local-prefixes: github.com/ava-labs/avalanchego
  depguard:
    list-type: blacklist
    packages-with-error-message:
      - io/ioutil: 'io/ioutil is deprecated. Use package io or os instead.'
      - github.com/stretchr/testify/assert: 'github.com/stretchr/testify/require should be used instead.'
    include-go-root: true
  errorlint:
    # Check for plain type assertions and type switches.
    asserts: false
    # Check for plain error comparisons.
    comparison: false
  # https://golangci-lint.run/usage/linters/#forbidigo
  forbidigo:
    # Forbid the following identifiers (list of regexp).
    forbid:
      - 'require\.Error$(# ErrorIs should be used instead)?'
      - 'require\.ErrorContains$(# ErrorIs should be used instead)?'
      - 'require\.EqualValues$(# Equal should be used instead)?'
      - 'require\.NotEqualValues$(# NotEqual should be used instead)?'
    exclude_godoc_examples: false
  # https://golangci-lint.run/usage/linters#gosec
  gosec:
    excludes:
      - G107 # https://securego.io/docs/rules/g107.html
  revive:
    rules:
      # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#bool-literal-in-expr
      - name: bool-literal-in-expr
        disabled: false
      # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#early-return
      - name: early-return
        disabled: false
      # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#empty-lines
      - name: empty-lines
        disabled: false
      # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#string-format
      - name: string-format
        disabled: false
        arguments:
        - ["fmt.Errorf[0]", "/.*%.*/", "no format directive, use errors.New instead"]
      # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#struct-tag
      - name: struct-tag
        disabled: false
      # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unexported-naming
      - name: unexported-naming
        disabled: false
      # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unhandled-error
      - name: unhandled-error
        disabled: false
        arguments:
          - "fmt\\.Fprint"
          - "fmt\\.Fprintf"
          - "fmt\\.Print"
          - "fmt\\.Printf"
          - "fmt\\.Println"
          - "math/rand\\.Read"
          - "strings\\.Builder\\.WriteString"
      # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unused-parameter
      - name: unused-parameter
        disabled: false
      # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unused-receiver
      - name: unused-receiver
        disabled: false
      # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#useless-break
      - name: useless-break
        disabled: false
  staticcheck:
    go: "1.19"
    # https://staticcheck.io/docs/options#checks
    checks:
      - "all"
      - "-SA6002" # argument should be pointer-like to avoid allocation, for sync.Pool
      - "-SA1019" # deprecated packages e.g., golang.org/x/crypto/ripemd160