.golangci.yml

run:
  timeout: 240m
  skip-dirs:
  - pkg/complianceoperator/api
  - scanner/updater/rhel        # TODO(ROX-21539): Remove when CSAF/VEX arrives
  build-tags:
  - integration
  - sql_integration
  modules-download-mode: readonly

output:
  format: "junit-xml:report.xml,colored-line-number"

issues:
  max-issues-per-linter: 0
  max-same-issues: 0
  exclude-use-default: false

  exclude-rules:
    - path: "(central|compliance|integration-tests|local|migrator|operator|pkg|scanner|sensor|tests|tools|scale)/"
      linters:
        - wrapcheck
    - path: "(central/graphql/schema/print|compliance|integration-tests|local|migrator|operator|pkg|scanner|sensor|tests|tools|scale|govulncheck)/"
      linters:
        - forbidigo
    - path: "roxctl/central/generate/interactive.go"
      linters:
      - forbidigo
    - path: _test\.go
      linters:
        - wrapcheck
        - forbidigo
    - path: roxctl/common/io/io\.go # io.go will by default use os.Stdin/os.StdErr.
      linters:
        - forbidigo
    - linters:
        - revive
      text: "should have a package comment"
    - linters:
        - revive
      text: "should not use dot imports"
    - linters:
        - revive
      text: "returns unexported type .* which can be annoying to use"
    - linters:
        - revive
      text: "error strings should not be capitalized or end with punctuation or a newline"
    - linters:
        - revive
      text: "should omit type int from declaration"
    - linters:
        - revive
      text: "don't use leading k in Go names"
    - linters:
        - revive
      text: "if-return"
    - path: .*/bleve@.*/index\.go
      linters:
        - staticcheck
      text: "SA4023" # github.com/blevesearch/bleve.OpenUsing never returns a nil interface value


linters-settings:
  gosec:
    includes:
    - G101
    - G102
    - G103
    - G104
    - G106
    - G108
    - G109
    - G111
    - G113
    - G201
    - G202
    - G203
    - G303
    - G307
    - G403
    - G502
    - G503
    - G504
    - G601
  revive:
    min-confidence: 0
  govet:
    enable-all: true
    disable:
      - shadow
      - fieldalignment
    settings:
      printf: # analyzer name, run `go tool vet help` to see all analyzers
        funcs: # run `go tool vet help printf` to see available settings for `printf` analyzer
          - Print
          - Printf
          - Println
          - Debug
          - Debugf
          - Info
          - Infof
          - Warn
          - Warnf
          - Error
          - Errorf
          - github.com/stackrox/rox/migrator/log.WritetoStderr
          - github.com/stackrox/rox/migrator/log.WritetoStderrf
  gocritic:
    enabled-checks:
      - commentFormatting
  nolintlint:
    allow-leading-space: false # require machine-readable nolint directives (i.e. with no leading space)
    allow-unused: false # report any unused nolint directives
    require-explanation: false # don't require an explanation for nolint directives
    require-specific: true # require nolint directives to be specific about which linter is being skipped
  forbidigo:
    # Forbid the following identifiers (list of regexp).
    forbid:
    - ^print\(.*\)$
    - 'fmt\.Print.*(# Disallowed function used\. Use environments functions for printing or to a specific writer from environment\.InputOutput\(\)\.)?'
    - 'os\.Stdout(# Disallowed output streams used\. Use environment\.InputOutput\(\).Out instead\.)?'
    - 'os\.Stderr(# Disallowed output streams used\. Use environment\.InputOutput\(\).Out instead\.)?'
    - 'os\.Stdin(# Disallowed output streams used\. Use environment\.InputOutput\(\).Out instead\.)?'
  staticcheck:
    go: "1.20"
    checks: [all,-ST1000,-ST1001,-ST1003,-ST1005,-SA1019,-SA4001,-ST1016]
  wrapcheck:
    ignoreSigRegexps:
      - utils\.Should
      - errox\..+\.CausedBy(f)?
      - retry\.MakeRetryable
      - policy\.NewErr.*

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
    # - deadcode
    # - depguard
    # - dogsled
    # - dupl
    # - errcheck
    # - funlen
    - forbidigo
    # - gochecknoglobals
    # - gochecknoinits
    # - gocognit
    # - goconst
    - exportloopref
    - gocritic
    # - gocyclo
    # - godot
    # - godox
    # - goerr113
    - gofmt
    - goimports
    - revive # replaces golint
    # - gomnd
    # - goprintffuncname
    - gosec
    - gosimple
    - govet
    - ineffassign
    # - interfacer
    # - lll
    # - maligned
    # - misspell
    # - nakedret TODO: add in follow-up
    # - nestif
    - nolintlint
    # - prealloc
    - rowserrcheck
    # - scopelint
    - staticcheck
    # - structcheck
    # - stylecheck
    # - testpackage
    # - typecheck
    # - unconvert TODO: add in follow-up
    # - unparam TODO: add in follow-up
    # - unused // enabled in Makefile as it fails with release tag
    # - varcheck
    # - whitespace
    - wrapcheck
    # - wsl