.golangci.yml

#   Copyright The containerd Authors.

#   Licensed under the Apache License, Version 2.0 (the "License");
#   you may not use this file except in compliance with the License.
#   You may obtain a copy of the License at

#       http://www.apache.org/licenses/LICENSE-2.0

#   Unless required by applicable law or agreed to in writing, software
#   distributed under the License is distributed on an "AS IS" BASIS,
#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#   See the License for the specific language governing permissions and
#   limitations under the License.

# -----------------------------------------------------------------------------
# From https://github.com/containerd/nerdctl/blob/v0.12.1/.golangci.yml
# -----------------------------------------------------------------------------
---
run:
  concurrency: 6
  timeout: 2m  # to avoid timeout locally
linters:
  disable-all: true
  enable:
  - depguard
  - gofmt
  - goimports
  - govet
  - ineffassign
  - misspell
  - nakedret
  # - prealloc
  - typecheck
  # - asciicheck
  - bodyclose
  - copyloopvar
  # - dogsled
  # - dupl
  - dupword
  - errcheck
  - errorlint
  # - exhaustive
  # - exportloopref
  # - funlen
  - forbidigo
  # - gci
  # - gochecknoglobals
  # - gochecknoinits
  # - gocognit
  # - goconst
  - gocritic
  # - gocyclo
  - godot
  # - godox
  - gofumpt
  # - goheader
  # - gomodguard
  # - goprintffuncname
  # - gosec
  - gosimple
  # - lll
  # - nestif
  # - nlreturn
  - noctx
  - nolintlint
  - perfsprint
  # - rowserrcheck
  # - sqlclosecheck
  - staticcheck
  # - stylecheck
  # - testpackage
  # - tparallel
  - revive
  # - unconvert
  # - unparam
  - unused
  - whitespace
  # - wrapcheck
  # - wsl
linters-settings:
  depguard:
    rules:
      main:
        deny:
        - pkg: "golang.org/x/net/context"
          desc: "use the 'context' package from the standard library"
  forbidigo:
    analyze-types: true
    forbid:
    - p: ^print(ln)?$
      msg: Do not use builtin print functions. It's for bootstrapping only and may be removed in the future.
    - p: ^fmt\.Print.*$
      msg: Do not use fmt.Print statements.
    - p: ^testing.T.Fatal.*$
      msg: Use assert functions from the gotest.tools/v3/assert package instead.
  gocritic:
    # See "Tags" section in https://github.com/go-critic/go-critic#usage
    enabled-tags:
    - diagnostic
    - performance
    - style
    - opinionated
    - experimental
    disabled-checks:
    - appendCombine
    - sloppyReassign
    - unlabelStmt
    - rangeValCopy
    - hugeParam
    - importShadow
    - sprintfQuotedString
    - builtinShadow
    - filepathJoin
    settings:
      ifElseChain:
        # Min number of if-else blocks that makes the warning trigger.
        minThreshold: 3
  errorlint:
    asserts: false
  perfsprint:
    int-conversion: false
    err-error: false
    errorf: true
    sprintf1: false
    strconcat: false
  revive:
    # Set below 0.8 to enable error-strings
    confidence: 0.6
    # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md
    rules:
    - name: blank-imports
    - name: context-as-argument
    - name: context-keys-type
    - name: deep-exit
    - name: dot-imports
      arguments:
      - allowedPackages:
        - github.com/lima-vm/lima/pkg/must
    - name: empty-block
    - name: error-naming
    - name: error-return
    - name: error-strings
    - name: errorf
    - name: exported
    - name: increment-decrement
    - name: indent-error-flow
    - name: package-comments
    - name: range
    - name: receiver-naming
    - name: redefines-builtin-id
    - name: superfluous-else
    - name: time-naming
    - name: unexported-return
    - name: unreachable-code
    - name: unused-parameter
    - name: var-declaration
    - name: var-naming
  staticcheck:
    # https://staticcheck.dev/docs/configuration/options/#checks
    checks:
    - "all"
    - "-SA3000"  # false positive for Go 1.15+. See https://github.com/golang/go/issues/34129
issues:
  # Maximum issues count per one linter.
  max-issues-per-linter: 0
  # Maximum count of issues with the same text.
  max-same-issues: 0
  include:
  - EXC0013  # revive: package comment should be of the form "(.+)..."
  - EXC0014  # revive: comment on exported (.+) should be of the form "(.+)..."
  exclude-rules:
  # Allow using Uid, Gid in pkg/osutil.
  - path: "pkg/osutil/"
    text: "uid"
  # Disable some linters for test files.
  - path: _test\.go
    linters:
    - godot
  # Disable revive.exported for constants.
  - text: "exported: comment on exported const"
    linters:
    - revive
  # Disable perfsprint for fmt.Sprint until https://github.com/catenacyber/perfsprint/issues/39 gets fixed.
  - text: "fmt.Sprint.* can be replaced with faster"
    linters:
    - perfsprint