golangci-lint: Golang 快速 lint 工具

$ golangci-lint --help
Smart, fast linters runner.

Usage:
  golangci-lint [flags]
  golangci-lint [command]

Available Commands:
  cache       Cache control and information
  completion  Generate the autocompletion script for the specified shell
  config      Config file information
  custom      Build a version of golangci-lint with custom linters
  help        Help
  linters     List current linters configuration
  run         Run the linters
  version     Version

Flags:
      --color string   Use color when printing; can be 'always', 'auto', or 'never' (default "auto")
  -h, --help           Help for a command
  -v, --verbose        Verbose output
      --version        Print version

Use "golangci-lint [command] --help" for more information about a command.

run:
  deadline: 12m
  timeout: 10m
  go: '1.21'

linters:
  enable:
  - depguard
  - godot
  - gofumpt
  - goimports
  - revive
  - whitespace

issues:
  exclude-rules:
  - path: _test.go
    linters:
    - errcheck

linters-settings:
  depguard:
    rules:
      Main:
        deny:
        - pkg: sync/atomic
          desc: Use go.uber.org/atomic instead of sync/atomic
        - pkg: github.com/stretchr/testify/assert
          desc: Use github.com/stretchr/testify/require instead of github.com/stretchr/testify/assert
        - pkg: github.com/pkg/errors
          desc: Use fmt.Errorf instead
  errcheck:
    exclude-functions:
    - (hash.Hash).Write
  goimports:
    local-prefixes: github.com/xiexianbin/go-echo-demo
  gofumpt:
    extra-rules: true
  misspell:
    locale: US
  revive:
    rules:
    # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unexported-return
    - name: unexported-return
      severity: warning
      disabled: true

# https://golangci-lint.run/usage/quick-start/
run:
  timeout: 12m
  skip-dirs:
    - dist
    - docs
    - examples
    - hack
    - manifests
    - pkg/client
    - sdks
    - ui
    - vendor
  skip-files:
    - server/static/files.go
  build-tags:
    - api
    - cli
    - cron
    - executor
    - examples
    - corefunctional
    - functional
    - plugins
linters:
  enable:
    - asasalint
    - bidichk
    - bodyclose
    - errcheck
    - exportloopref
    - goimports
    # only minor issues
    # - errorlint
    # seems to have bugs in recent version, also slow
    # - gci
    - gosec
    - gosimple
    - govet
    - ineffassign
    - misspell
    - nakedret
    - nosprintfhostport
    - reassign
    - rowserrcheck
    - sqlclosecheck
    - staticcheck
    - typecheck
    - unparam
    - unused
linters-settings:
  goimports:
    local-prefixes: github.com/argoproj/argo-workflows/
  gosec:
    includes:
      - G304
      - G307
    excludes:
      # G106: Use of ssh InsecureIgnoreHostKey should be audited
      - G106
      # G402: TLS InsecureSkipVerify set true
      - G402
      # G601: Implicit memory aliasing in for loop.
      - G601
issues:
  exclude-rules:
    - path: server/artifacts/artifact_server_test.go
      text: "response body must be closed"

run:
  timeout: 5m
  skip-dirs:
    - pkg/client
    - vendor
    - "eventsources/common/naivewatcher"
  skip-files:
    - ".*generated.*"
linters:
  enable:
    - deadcode
   # - depguard
    - dogsled
    - goconst
    - gocritic
    - gofmt
    - goimports
    - goprintffuncname
    - gosimple
    - govet
    - ineffassign
    - misspell
    - nakedret
    - rowserrcheck
    - staticcheck
   # - structcheck
    - typecheck
    - unconvert
    - unused
    - varcheck
    - whitespace

issues:
  exclude:
    - SA1019
    - SA5011
  exclude-rules:
    - path: "(applicationset|cmd|cmpserver|controller|pkg|reposerver|server|test)/"
      text: "require-error:"
      linters:
        - testifylint
    - path: "util/(argo|cache|cert|clusterauth|config|db|dex|git|gpg|grpc|helm|http|io|kube|kustomize|lua|notification|oidc|rbac|security|session|settings|tls|webhook)/"
      text: "require-error:"
      linters:
        - testifylint
  max-issues-per-linter: 0
  max-same-issues: 0
linters:
  enable:
    - errcheck
    - errorlint
    - gocritic
    - gofumpt
    - goimports
    - gosimple
    - govet
    - ineffassign
    - misspell
    - staticcheck
    - testifylint
    - unused
    - whitespace
linters-settings:
  gocritic:
    disabled-checks:
      - appendAssign
      - assignOp  # Keep it disabled for readability
      - badCond
      - commentFormatting
      - exitAfterDefer
      - ifElseChain
      - mapKey
      - singleCaseSwitch
      - typeSwitchVar
  goimports:
    local-prefixes: github.com/argoproj/argo-cd/v2
  testifylint:
    enable-all: true
    disable:
      - error-is-as
      - float-compare
      - go-require
run:
  timeout: 50m