.golangci.yml

version: "2"

# options for analysis running
run:
  # timeout for analysis, e.g. 30s, 5m, default is 0
  timeout: 30m

  # exit code when at least one issue was found, default is 1
  issues-exit-code: 1

  # include test files or not, default is true
  tests: true

# output configuration options
output:
  formats:
    text:
      path: stdout
      print-issued-lines: true
      print-linter-name: true

  # Show stats by default in v2
  show-stats: false

# all available settings of specific linters
linters:
  settings:
    errcheck:
      # report about not checking of errors in type assetions: `a := b.(MyStruct)`;
      # default is false: such cases aren't reported by default.
      check-type-assertions: false

      # report about assignment of errors to blank identifier: `num, _ := strconv.Atoi(numStr)`;
      # default is false: such cases aren't reported by default.
      check-blank: false

      # path to a file containing a list of functions to exclude from checking
      # see https://github.com/kisielk/errcheck#excluding-functions for details
      # exclude: /path/to/file.txt

    # Disable error checking, as errorcheck detects more errors and is more configurable.
    gosec:
      excludes:
      - "G104"

    funlen:
      lines: 60
      statements: 40

    govet:
      enable:
        - shadow

      # settings per analyzer
      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
            - (github.com/golangci/golangci-lint/pkg/logutils.Log).Infof
            - (github.com/golangci/golangci-lint/pkg/logutils.Log).Warnf
            - (github.com/golangci/golangci-lint/pkg/logutils.Log).Errorf
            - (github.com/golangci/golangci-lint/pkg/logutils.Log).Fatalf

      # enable or disable analyzers by name
      # enable:
      #   - atomicalign
      # enable-all: false
      # disable:
      #   - shadow
      # disable-all: false

    gocyclo:
      # minimal code complexity to report, 30 by default (but we recommend 10-20)
      min-complexity: 30

    gocognit:
      # minimal code complexity to report, 30 by default (but we recommend 10-20)
      min-complexity: 20

    depguard:
      rules:
        main:
          allow:
            - $gostd
            - gitlab.com/gitlab-org/gitlab-shell
            - gitlab.com/gitlab-org/labkit
            - gitlab.com/gitlab-org/gitaly
            - gitlab.com/gitlab-org/cells/topology-service
            - github.com/charmbracelet/git-lfs-transfer
            - github.com/git-lfs/pktline
            - github.com/golang-jwt/jwt
            - github.com/grpc-ecosystem/go-grpc-prometheus
            - github.com/hashicorp/go-retryablehttp
            - github.com/mattn/go-shellwords
            - github.com/mikesmitty/edkey
            - github.com/otiai10/copy
            - github.com/pires/go-proxyproto
            - github.com/prometheus/client_golang/prometheus
            - github.com/sirupsen/logrus
            - github.com/stretchr/testify
            - golang.org/x/crypto
            - golang.org/x/sync
            - google.golang.org/grpc
            - google.golang.org/protobuf
            - gopkg.in/yaml.v3

    dupl:
      # tokens count to trigger issue, 150 by default
      threshold: 100

    goconst:
      # minimal length of string constant, 3 by default
      min-len: 3
      # minimal occurrences count to trigger, 3 by default
      min-occurrences: 3

    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
      ignore-rules:
        - GitLab

    lll:
      # max line length, lines longer will be reported. Default is 120.
      # '\t' is counted as 1 character by default, and can be changed with the tab-width option
      line-length: 120
      # tab width in spaces. Default to 1.
      tab-width: 1

    unparam:
      # Inspect exported functions, default is false. Set to true if no external program/library imports your code.
      # XXX: if you enable this setting, unparam will report a lot of false-positives in text editors:
      # if it's called for subdir of a project it can't find external interfaces. All text editor integrations
      # with golangci-lint call it on a directory with the changed file.
      check-exported: false

    nakedret:
      # make an issue if func has more lines of code than this setting and it has naked returns; default is 30
      max-func-lines: 30

    prealloc:
      # XXX: we don't recommend using this linter before doing performance profiling.
      # For most programs usage of prealloc will be a premature optimization.

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

    gocritic:
      # Which checks should be enabled; can't be combined with 'disabled-checks';
      # See https://go-critic.github.io/overview#checks-overview
      # To check which checks are enabled run `GL_DEBUG=gocritic golangci-lint run`
      # By default list of stable checks is used.
      # enabled-checks:
      #   - rangeValCopy

      # Which checks should be disabled; can't be combined with 'enabled-checks'; default is empty
      # disabled-checks:
      #   - regexpMust

      # Enable multiple checks by tags, run `GL_DEBUG=gocritic golangci-lint run` to see all tags and checks.
      # Empty list by default. See https://github.com/go-critic/go-critic#usage -> section "Tags".
      # enabled-tags:
      #   - performance

      settings: # settings passed to gocritic
        captLocal: # must be valid enabled check name
          paramsOnly: true
      # rangeValCopy:
      #   sizeThreshold: 32

    godox:
      # report any comments starting with keywords, this is useful for TODO or FIXME comments that
      # might be left in the code accidentally and should be resolved before merging
      keywords: # default keywords are TODO, BUG, and FIXME, these can be overwritten by this setting
        - TODO
        - BUG
        - FIXME
        - NOTE
        - OPTIMIZE # marks code that should be optimized before merging
        - HACK # marks hack-arounds that should be removed before merging

    dogsled:
      # checks assignments with too many blank identifiers; default is 2
      max-blank-identifiers: 2

    whitespace:
      multi-if: false   # Enforces newlines (or comments) after every multi-line if statement
      multi-func: false # Enforces newlines (or comments) after every multi-line function signature

    wsl:
      # If true append is only allowed to be cuddled if appending value is
      # matching variables, fields or types on line above. Default is true.
      strict-append: true
      # Allow calls and assignments to be cuddled as long as the lines have any
      # matching variables, fields or types. Default is true.
      allow-assign-and-call: true
      # Allow multiline assignments to be cuddled. Default is true.
      allow-multiline-assign: true
      # Allow declarations (var) to be cuddled.
      allow-cuddle-declarations: false
      # Allow trailing comments in ending of blocks
      allow-trailing-comment: false
      # Force newlines in end of case at this limit (0 = never).
      force-case-trailing-whitespace: 0

  # 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
  default: none
  enable:
    - bodyclose
    - copyloopvar
    - depguard
    - dogsled
    - dupl
    - errcheck
    - funlen
    - gocognit
    - goconst
    - gocritic
    - godox
    - gosec
    - govet
    - ineffassign
    - misspell
    - nakedret
    - revive
    - staticcheck  # includes gosimple, staticcheck, and stylecheck
    - testifylint
    - unconvert
    - unparam
    - unused
    - whitespace
  # don't enable:
  # - deadcode (removed in v2)
  # - gochecknoglobals
  # - gochecknoinits
  # - gocyclo
  # - lll
  # - maligned
  # - prealloc
  # - varcheck (removed in v2)

  exclusions:
    # Maintain v1 behavior for generated files exclusion
    generated: strict

    # Default directories that were excluded by skip-dirs-use-default: true
    paths:
      - vendor$
      - third_party$
      - testdata$
      - examples$
      - Godeps$
      - builtin$

    rules:
      # Exclude some linters from running on tests files.
      - path: _test\.go
        linters:
          - gocyclo
          - errcheck
          - dupl
          - gosec
          - funlen

      # Exclude known linters from partially hard-vendored code,
      # which is impossible to exclude via "nolint" comments.
      # - path: internal/hmac/
      #   text: "weak cryptographic primitive"
      #   linters:
      #     - gosec

      # Exclude some staticcheck messages
      # - linters:
      #     - staticcheck
      #   text: "SA9003:"

      # Exclude lll issues for long lines with go:generate
      - linters:
          - lll
        source: "^//go:generate "

# Formatters section for formatting linters
formatters:
  settings:
    gofmt:
      # simplify code: gofmt with `-s` option, true by default
      simplify: true
    # goimports:
      # put imports beginning with prefix after 3rd-party packages;
      # it's a comma-separated list of prefixes
      # local-prefixes: github.com/org/project

  enable:
    - gofmt
    - goimports

issues:
  # Maximum issues count per one linter. Set to 0 to disable. Default is 50.
  max-issues-per-linter: 0

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

  # Show only new issues: if there are unstaged changes or untracked files,
  # only those changes are analyzed, else only changes in HEAD~ are analyzed.
  # It's a super-useful option for integration of golangci-lint into existing
  # large codebase. It's not practical to fix all existing issues at the moment
  # of integration: much better don't allow issues in new code.
  # Default is false.
  new: false

  # Show only new issues created after git revision `REV`
  # This should be passed as flag during individual CI jobs.
  # new-from-rev: REV

  # Show only new issues created in git patch with set file path.
  # new-from-patch: path/to/patch/file