.golangci.yml

version: "2"

# run  `golangci-lint run --config .golangci.yml` to check changes

issues:
  # maximum number of issues to print per linter (0 means unlimited)
  max-issues-per-linter: 0

  # maximum number of issues with the same text to print
  max-same-issues: 0

linters:
  default: standard  ## 'none|standard|all'; enable
  disable:
    - errcheck
    - gosec
    - wsl
    - wsl_v5
  enable:
    - asciicheck
    - bodyclose
    - canonicalheader
    - copyloopvar
    - depguard
    - dogsled
    - dupl
    - dupword
    - durationcheck
    # errcheck
    - errorlint   ## excluding "wrapped errors"
    # exhaustive  ## TODO: "missing cases in switch of type"
    - fatcontext
    - gochecksumtype
    - gocritic
    - goheader
    - gomoddirectives
    - goprintffuncname
    # gosec
    - govet
    - importas
    - ineffassign
    - intrange
    # modernize  ## TODO: slicesbackward vs `config verify`
    - musttag
    - misspell
    - nakedret
    - nilnesserr
    - noctx
    - nolintlint
    - perfsprint
    - prealloc
    - protogetter
    - reassign
    - revive
    - staticcheck
    - testpackage
    - unconvert
    - unparam
    - unused
    - usetesting
    - wastedassign
    - whitespace
    # containedctx ## ("found a struct that contains a context.Context field")
    # ginkgolinter ## (TODO: use it to cleanup unit tests)
    # recvcheck    ## (config below)

# See: https://golangci-lint.run/usage/linters/
  settings:
    dupl:
      threshold: 100

    revive:
      # ignore-generated-header: true
      severity: warning
      rules:
        # name: import-shadowing
        # name: time-naming
        # name: unhandled-error
        # name: var-naming
        - name: blank-imports
        - name: context-as-argument
        - name: context-keys-type
        - name: early-return
        - name: error-naming
        - name: error-strings
        - name: if-return
        - name: increment-decrement
        - name: indent-error-flow
        - name: modifies-value-receiver
        - name: range
        - name: receiver-naming
        - name: redefines-builtin-id
        - name: string-of-int
        - name: superfluous-else
        - name: time-date
        - name: var-declaration
        - name: unconditional-recursion
        - name: unexported-naming
        - name: unexported-return
        - name: unnecessary-format
        - name: unnecessary-stmt
        - name: unreachable-code
        - name: unused-parameter
        - name: unused-receiver
        - name: use-fmt-print
        - name: waitgroup-by-value

    errcheck:
      check-type-assertions: true
      check-blank: true
      disable-default-exclusions: false
      # exclude-functions:
        # io/ioutil.ReadFile
        # io.Copy(*bytes.Buffer)
        # io.Copy(os.Stdout)

    govet:
      enable-all: true
      disable:
        - fieldalignment ## (fieldalignment -fix path)
        - shadow         ## ditto

    gocritic:
      enabled-tags:
        - performance
        - style
      disabled-checks:
        - unnamedResult
        - unnecessaryBlock
        - importShadow   ## TODO (wtp)

    gosec:
      excludes: ## integer overflow; weak rand
        - G115
        - G402
        - G404

    prealloc:
      simple: true # Report preallocation suggestions only on simple loops that have no returns/breaks/continues/gotos in them
      range-loops: true # Report preallocation suggestions on range loops, true by default
      for-loops: true # Report preallocation suggestions on for loops, false by default

    misspell:
      # Correct spellings using locale preferences for US or UK.
      # Default is to use a neutral variety of English.
      # Setting locale to US will correct the British spelling of 'colour' to 'color'.
      locale: US

    recvcheck:
      disable-builtin: true
      # The format is `struct_name.method_name` (ex: `Foo.MethodName`).
      # A wildcard `*` can use as a struct name (ex: `*.MethodName`).
      exclusions:
        - "*.UnmarshalJSON"
        - "*.UnmarshalYAML"

    modernize:
      # By default, all analyzers are enabled.
      disable:
        - omitzero
        - stringscut

    depguard:
      rules:
        main:
          deny:
            - pkg: io/ioutil
              desc: "replaced by io and os packages since Go 1.16: https://tip.golang.org/doc/go1.16#ioutil"
            - pkg: 'math/rand$'
              desc: "`math/rand` package has been deprecated use `math/rand/v2`"

  # Defines a set of rules to ignore issues.
  # It does not skip the analysis, and so does not ignore "typecheck" errors.
  exclusions:
    warn-unused: false ## TODO (e.g., warn skipped [Path: "tools/", Linters: "nakedret"])
    # Predefined exclusion rules.
    # Default: []
    presets:
      # comments
      # std-error-handling
      # common-false-positives
      - legacy

    # Excluding configuration per-path, per-linter, per-text and per-source.
    rules:
      # Exclude some linters from running on tests files.
      - path: _test\.go
        linters:
          - errcheck
          - dupl
          - gosec
          - nakedret
          - noctx
          - govet
          - modernize
          - prealloc
          - nolintlint
      - path: _gen\.go
        linters:
          - nakedret
          - dupl
          - gocritic
          - govet
          - goimports
      - path: bench/
        linters:
          - nakedret
          - noctx
          - modernize
      - path: tools/
        linters:
          - nakedret
          - noctx
          - govet
          - modernize
          - prealloc
      - path: ext/dsort/
        linters:
          - unused

      # Exclude certain staticcheck warnings, e.g.: "remove embedded field DemandBase", "Deprecated" - TODO remove
      - linters:
          - staticcheck
        text: "QF1008:"
      - linters:
          - staticcheck
        text: "SA1019:"

      # Exclude errorlint "wrapped errors. Use errors.Is" and "non-wrapping format ... Use `%w` to format error"
      - linters:
          - errorlint
        text: "wrapped errors"
      - linters:
          - errorlint
        text: "non-wrapping format"

formatters:
  enable:
    - gofmt
    - goimports
  settings:
    gofmt:
      rewrite-rules:
        - pattern: 'interface{}'
          replacement: 'any'
    goimports:
      local-prefixes:
        - github.com/NVIDIA/aistore
  # exclusions:
    # paths:
      # test/testdata

run:
  go: '1.26'
  tests: true # Enable linting test files.
  concurrency: 8
  timeout: 8m

    # NOTE: these are the default build tags for the linter;
    # use `TAGS=... make lint` to check that the corresponding alternative sources do lint correctly;
    # e.g. `TAGS=aws make lint`
  build-tags:
    - hrw
    - aws
    - azure
    - gcp
    - oci
    # - nethttp