.golangci.yaml

---
run:
  timeout: 30m
issues:
  max-same-issues: 0
  # Excluding configuration per-path, per-linter, per-text and per-source
  exclude-rules:
    # exclude ineffassing linter for generated files for conversion
    - path: conversion\.go
      linters: [ineffassign]
    - text: "S1000" # TODO: Fix me
      linters:
        - gosimple
  exclude-files:
    - ^zz_generated.*
linters:
  disable-all: true
  enable: # please keep this alphabetized
    # Don't use soon to deprecated[1] linters that lead to false
    # https://github.com/golangci/golangci-lint/issues/1841
    # - deadcode
    # - structcheck
    # - varcheck
    - errorlint
    - gofumpt
    - goimports
    - gosimple
    - ineffassign
    - nakedret
    - revive
    - staticcheck
    - stylecheck
    - tenv
    - testifylint
    - unconvert # Remove unnecessary type conversions
    - unparam
    - unused
    - usestdlibvars
    - whitespace
linters-settings: # please keep this alphabetized
  goimports:
    local-prefixes: go.etcd.io # Put imports beginning with prefix after 3rd-party packages.
  nakedret:
    # Align with https://github.com/alexkohler/nakedret/blob/v1.0.2/cmd/nakedret/main.go#L10
    max-func-lines: 5
  revive:
    ignore-generated-header: false
    severity: error
    confidence: 0.8
    enable-all-rules: false
    rules:
      - name: blank-imports
        severity: error
        disabled: false
      - name: context-as-argument
        severity: error
        disabled: false
      - name: dot-imports
        severity: error
        disabled: false
      - name: error-return
        severity: error
        disabled: false
      - name: error-naming
        severity: error
        disabled: false
      - name: if-return
        severity: error
        disabled: false
      - name: increment-decrement
        severity: error
        disabled: false
      - name: var-declaration
        severity: error
        disabled: false
      - name: package-comments
        severity: error
        disabled: false
      - name: range
        severity: error
        disabled: false
      - name: receiver-naming
        severity: error
        disabled: false
      - name: time-naming
        severity: error
        disabled: false
      - name: indent-error-flow
        severity: error
        disabled: false
      - name: errorf
        severity: error
        disabled: false
      - name: context-keys-type
        severity: error
        disabled: false
      - name: error-strings
        severity: error
        disabled: false
      - name: var-naming
        disabled: false
        arguments:
          # The following is the configuration for var-naming rule, the first element is the allow list and the second element is the deny list.
          - [] # AllowList: leave it empty to use the default (empty, too). This means that we're not relaxing the rule in any way, i.e. elementId will raise a violation, it should be elementID, refer to the next line to see the list of denied initialisms.
          - ["GRPC", "WAL"] # DenyList: Add GRPC and WAL to strict the rule not allowing instances like Wal or Grpc. The default values are located at commonInitialisms, refer to: https://github.com/mgechev/revive/blob/v1.3.7/lint/utils.go#L93-L133.
      # TODO: enable the following rules
      - name: exported
        disabled: true
      - name: unexported-return
        disabled: true
  staticcheck:
    checks:
      - all
      - -SA1019 # TODO(fix) Using a deprecated function, variable, constant or field
      - -SA2002 # TODO(fix) Called testing.T.FailNow or SkipNow in a goroutine, which isn’t allowed
  stylecheck:
    checks:
      - ST1019 # Importing the same package multiple times.
  testifylint:
    enable-all: true
    formatter:
      # Require f-assertions (e.g. assert.Equalf) if a message is passed to the assertion, even if
      # there is no variable-length variables, i.e. require require.NoErrorf for both cases below:
      # require.NoErrorf(t, err, "whatever message")
      # require.NoErrorf(t, err, "whatever message: %v", v)
      #
      # Note from golang programming perspective, we still prefer non-f-functions (i.e. fmt.Print)
      # to f-functions (i.e. fmt.Printf) when there is no variable-length parameters. It's accepted
      # to always require f-functions for stretchr/testify, but not for golang standard lib.
      # Also refer to https://github.com/etcd-io/etcd/pull/18741#issuecomment-2422395914
      require-f-funcs: true