.golangci-strict.yml

# Copyright 2025-Present Couchbase, Inc.
#
# Use of this software is governed by the Business Source License included
# in the file licenses/BSL-Couchbase.txt.  As of the Change Date specified
# in that file, in accordance with the Business Source License, use of this
# software will be governed by the Apache License, Version 2.0, included in
# the file licenses/APL2.txt.

version: "2"
linters:
  enable:
    - exhaustive
    - forbidigo # Forbids identifiers - used here to keep dev-time printing out of shipping code
    - gocritic # The most opinionated Go source code linter
    #- goprintffuncname # Checks that printf-like functions are named with `f` at the end
    #- gosec # Inspects source code for security problems
    #- gosimple # (megacheck) Linter for Go source code that specializes in simplifying a code
    - govet # (vet, vetshadow) Vet examines Go source code and reports suspicious constructs, such as Printf calls whose arguments do not align with the format string
    - ineffassign # Detects when assignments to existing variables are not used
    - misspell # Finds commonly misspelled English words in comments
    #- nakedret # Finds naked returns in functions greater than a specified function length
    #- prealloc # Finds slice declarations that could potentially be preallocated
    #- revive # Golint differs from gofmt. Gofmt reformats Go source code, whereas golint prints out style mistakes
    - staticcheck # (megacheck) Staticcheck is a go vet on steroids, applying a ton of static analysis checks
    - unconvert # Remove unnecessary type conversions
    #- unparam # Reports unused function parameters
    - unused # (megacheck) Checks Go code for unused constants, variables, functions and types
  settings:
    exhaustive:
      check:
        - switch
        - map
      default-signifies-exhaustive: true
      explicit-exhaustive-map: true
      ignore-enum-members: "(auditdSyncGatewayEndID|levelCount)" # these mark end of an enum
    forbidigo:
      # Listed explicitly rather than relying on forbidigo's defaults, which don't cover log.Print*.
      forbid:
        - pattern: ^fmt\.Print(f|ln)?$
          msg: use the context-aware base logging wrappers (base.InfofCtx, base.WarnfCtx, base.DebugfCtx, base.TracefCtx) so log keys and redaction are applied
        - pattern: ^log\.Print(f|ln)?$
          msg: use the context-aware base logging wrappers (base.InfofCtx, base.WarnfCtx, base.DebugfCtx, base.TracefCtx) so log keys and redaction are applied
    gocritic:
      enabled-checks:
        - ruleguard
      disabled-checks:
        - appendAssign
        - assignOp
        - badCond
        - captLocal
        - commentFormatting
        - deprecatedComment
        - elseif
        - ifElseChain
        - regexpMust
        - singleCaseSwitch
        - sloppyLen
        - unlambda
        - valSwap
        - wrapperFunc
      settings:
        ruleguard:
          failOn: all
          rules: ${base-path}/ruleguard/rules-*.go
    govet:
      enable:
        - nilness
    staticcheck:
      checks:
        - all # enable all
        # disable some checks until fixed
        - -QF1001 # Apply De Morgan's law.
        - -QF1003 # could use tagged switch
        - -QF1004 # Use 'strings.ReplaceAll' instead of 'strings.Replace' with 'n == -1'.
        - -QF1007 # could merge conditional assignment into variable declaration
        - -QF1008 # Omit embedded fields from selector expression.
        - -QF1010 # Convert slice of bytes to string when printing it.
        - -QF1011 # Omit redundant type from variable declaration.
        - -QF1012 # Use 'fmt.Fprintf(x, ...)' instead of 'x.Write(fmt.Sprintf(...))'.
        - -S1000 # Use plain channel send or receive instead of single-case select.
        - -S1002 # Omit comparison with boolean constant.
        - -S1005 # unnecssary assignment to the blank identifier
        - -S1008 # Simplify returning boolean expression.
        - -S1009 # Omit redundant nil check on slices, maps, and channels.
        - -S1011 # Use a single 'append' to concatenate two slices.
        - -S1021 # Merge variable declaration and assignment.
        - -S1025 # Don't use 'fmt.Sprintf("%s", x)' unnecessarily.
        - -S1024 # Replace 'x.Sub(time.Now())' with 'time.Until(x)'.
        - -S1031 # unnecessary nil check around range
        - -ST1003 # Poorly chosen identifier.
        - -ST1005 # errors strings should not end with punctuation or newlines
        - -ST1006 # Poorly chosen receiver name.
        - -ST1008 # A function's error value should be its last return value.
        - -ST1011 # Poorly chosen name for variable of type 'time.Duration'.
        - -ST1012 # Poorly chosen name for error variable.
        - -ST1016 # methods on the same type should have the same receiver name
        - -ST1017 # Don't use Yoda conditions.
        - -ST1023 # Redundant type in variable declaration.
  exclusions:
    generated: strict
    rules:
      # Disable goconst in test files, often we have duplicated strings across tests, but don't make sense as constants.
      - linters:
          - goconst
        # cover _testing.go (utility testing files) and _test.go files
        # base/util_testing.go / rest/utilities_testing\.*.go
        path: (_test.*\.go)
      - linters:
          - unused
        path: rest/debug.go
      # The logging implementation itself, the standalone CLIs under tools/, and tests (which print
      # diagnostics and generate data) write to stdout by design.
      - linters:
          - forbidigo
        path: (base/logging\.go|base/redactor\.go|^tools/|_test.*\.go)
      - text: "ST1000:" # at least one file in a package should have a package comment
        linters:
          - staticcheck
      - text: "ST1020:" # comment on exported method should be of the form "MethodName ..."
        linters:
          - staticcheck
      - text: "ST1021:" # comment on exported type should be of the form "TypeName ..."
        linters:
          - staticcheck
      - text: "ST1022:" # comment on exported type should be of the form "TypeName ..."
        linters:
          - staticcheck
      - text:  "missing cases in switch"
        linters:
          - exhaustive
        path: (_test.go)

formatters:
  enable:
    - goimports
  exclusions:
    generated: strict

run:
  allow-parallel-runners: true