.golangci.yml

# Copyright 2023 Google LLC
#
# 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.

---
run:
  concurrency: 2
  deadline: 5m
issues:
  # include:
  #   - EXC0012
  #   - EXC0013
  #   - EXC0014
  #   - EXC0015
  # Maximum issues count per one linter.
  # Set to 0 to disable.
  # Default: 50
  max-issues-per-linter: 0
  # Maximum count of issues with the same text.
  # Set to 0 to disable.
  # Default: 3
  max-same-issues: 0
  new-from-rev: ""
linters:
  disable-all: true
  enable:
    # Some linters have been removed because of the go 1.18 issues.
    # https://github.com/golangci/golangci-lint/issues/2649
    - asciicheck
    - contextcheck
    - copyloopvar
    - depguard
    - dogsled
    - err113
    - errcheck
    - errorlint
    - exhaustive
    - gci
    - gochecknoinits
    - gocognit
    - goconst
    - gocritic
    - gocyclo
    - godot
    - godox
    - gofmt
    - gofumpt
    - goheader
    - goimports
    - gomodguard
    - goprintffuncname
    - gosec
    - gosimple
    - govet
    - ineffassign
    - lll
    - makezero
    - misspell
    - nakedret
    - nestif
    - nolintlint
    - paralleltest
    - predeclared
    - revive
    - staticcheck
    - stylecheck
    - thelper
    - typecheck
    - unconvert
    - unused
    - whitespace
    - wrapcheck
linters-settings:
  depguard:
    rules:
      main:
        files:
          - $all
          - "!$test"
        allow:
          # Go standard library
          - $gostd

          # This project.
          - "github.com/ianlewis/todos"

          # Dependencies.
          - "github.com/fatih/color"
          - "github.com/go-enry/go-enry/v2"
          - "github.com/go-git/go-git/v5"
          - "github.com/gobwas/glob"
          - "github.com/ianlewis/runeio"
          - "github.com/saintfish/chardet"
          - "github.com/urfave/cli/v2"
          - "sigs.k8s.io/release-utils/version"
        deny:
          - pkg: "github.com/ianlewis/todos/internal/testutils"
            desc: Please don't use testutils package
          - pkg: "reflect"
            desc: Please don't use reflect package
          - pkg: "unsafe"
            desc: Please don't use unsafe package
      test:
        files:
          - $test
        allow:
          # Go standard library
          - $gostd

          # This project.
          - "github.com/ianlewis/todos"

          # Dependencies.
          - "github.com/gobwas/glob"
          - "github.com/google/go-cmp/cmp"
          - "github.com/google/go-github"
          - "github.com/urfave/cli/v2"
          - "github.com/migueleliasweb/go-github-mock/src/mock"
        deny:
          - pkg: "reflect"
            desc: Use go-cmp instead.
          - pkg: "unsafe"
            desc: Please don't use unsafe package

  errcheck:
    check-type-assertions: true
    check-blank: true
  gocognit:
    # Minimal code complexity to report
    # Increased beyond default to support table-driven tests and to preserve
    # some semblance of sanity.
    min-complexity: 40
  nestif:
    # Increased beyond default to preserve some semblance of sanity.
    min-complexity: 8
  govet:
    disable:
      # Too strict.
      - fieldalignment
    enable:
      - shadow
  godox:
    keywords:
      - BUG
      - FIXME
      - HACK
  gci:
    sections:
      - standard
      - default
      - prefix(github.com/ianlewis/todos)
  gocritic:
    disable-all: true
    enabled-checks:
      # Diagnostic
      - appendAssign
      - argOrder
      - badCond
      - caseOrder
      - codegenComment
      - commentedOutCode
      - deprecatedComment
      - dupArg
      - dupBranchBody
      - dupCase
      - dupSubExpr
      - exitAfterDefer
      - flagDeref
      - flagName
      - nilValReturn
      - offBy1
      - sloppyReassign
      - weakCond
      - octalLiteral

      # Performance
      - appendCombine
      - equalFold
      - hugeParam
      - indexAlloc
      - rangeExprCopy
      - rangeValCopy

      # Style
      - assignOp
      - boolExprSimplify
      - captLocal
      - commentFormatting
      - commentedOutImport
      - defaultCaseOrder
      - docStub
      - elseif
      - emptyFallthrough
      - emptyStringTest
      - hexLiteral
      - ifElseChain
      - methodExprCall
      - regexpMust
      - singleCaseSwitch
      - sloppyLen
      - stringXbytes
      - switchTrue
      - typeAssertChain
      - typeSwitchVar
      - underef
      - unlabelStmt
      - unlambda
      - unslice
      - valSwap
      - wrapperFunc
      - yodaStyleExpr

      # Opinionated
      - builtinShadow
      - importShadow
      - initClause
      - nestingReduce
      - paramTypeCombine
      - ptrToRefParam
      - typeUnparen
      - unnecessaryBlock