.golangci.yaml

run:
    timeout: 5m
    go: "1.20"
    issues-exit-code: 1
    skip-dirs:
        - "mocks"
    skip-dirs-use-default: true
    skip-files:
        - "mock_.*\\.go"

    modules-download-mode: mod
    allow-parallel-runners: false

output:
    format: colored-line-number
    print-issued-lines: true

    # print linter name in the end of issue text, default is true
    print-linter-name: true

    # make issues output unique by line, default is true
    uniq-by-line: true

    # add a prefix to the output file references; default is no prefix
    path-prefix: ""

    # sorts results by: filepath, line and column
    sort-results: false

severity:
    # Default value is empty string.
    # Set the default severity for issues. If severity rules are defined and the issues
    # do not match or no severity is provided to the rule this will be the default
    # severity applied. Severities should match the supported severity names of the
    # selected out format.
    # - Code climate: https://docs.codeclimate.com/docs/issues#issue-severity
    # -   Checkstyle: https://checkstyle.sourceforge.io/property_types.html#severity
    # -       GitHub: https://help.github.com/en/actions/reference/workflow-commands-for-github-actions#setting-an-error-message
    default-severity: error

    # The default value is false.
    # If set to true severity-rules regular expressions become case sensitive.
    case-sensitive: false

linters:
    disable-all: true
    enable:
        - asasalint
        - asciicheck
        - bidichk
        - containedctx
        - cyclop
        - decorder
        - depguard
        - dogsled
        - dupl
        - durationcheck
        - errcheck
        - errchkjson
        - errname
        - errorlint
        - execinquery
        - exhaustive
        - exportloopref
        - forbidigo
        - forcetypeassert
        - funlen
        - gci
        - gochecknoinits
        - goconst
        - gocritic
        - godot
        - gosimple
        - govet
        - ineffassign
        - revive
        - staticcheck
        - typecheck
        - megacheck
        - unused
        - wrapcheck
        - wsl

    disabled:
        - gosec # Enable in future
        - exhaustruct
        - contextcheck #Disabled due to issue https://github.com/golangci/golangci-lint/issues/2649.
        - bodyclose #Disabled due to issue https://github.com/timakin/bodyclose/issues/30
    fast: false

issues:
    # Excluding configuration per-path, per-linter, per-text and per-source
    exclude-rules:
        - path: _types\.go
          linters:
            - gochecknoinits
        - path: main\.go
          linters:
            - wrapcheck

    # Independently of option `exclude` we use default exclude patterns,
    # it can be disabled by this option. To list all
    # excluded by default patterns execute `golangci-lint run --help`.
    # Default value for this option is true.
    exclude-use-default: false

    # The default value is false. If set to true exclude and exclude-rules
    # regular expressions become case sensitive.
    exclude-case-sensitive: false

    #  # The list of ids of default excludes to include or disable. By default it's empty.
    #  include:
    #    - EXC0002 # disable excluding of issues about comments from golint

    # 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`
    #  new-from-rev: REV

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

    # Fix found issues (if it's supported by the linter)
    fix: true

# all available settings of specific linters
linters-settings:
    bidichk:
        left-to-right-embedding: true
        right-to-left-embedding: true
        pop-directional-formatting: true
        left-to-right-override: true
        right-to-left-override: true
        left-to-right-isolate: true
        right-to-left-isolate: true
        first-strong-isolate: true
        pop-directional-isolate: true

    cyclop:
        # the maximal code complexity to report
        max-complexity: 10

        # the maximal average package complexity. If it's higher than 0.0 (float) the check is enabled (default 0.0)
        package-average: 0.0

        # should ignore tests (default false)
        skip-tests: false

    depguard:
        list-type: blacklist
        include-go-root: false
        packages:
            - github.com/sirupsen/logrus
        packages-with-error-message:
            # specify an error message to output when a blacklisted package is used
            - github.com/sirupsen/logrus: "logging is allowed only by logutils.Log"

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

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

    errcheck:
        # report about not checking of errors in type assertions: `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

        # [deprecated] comma-separated list of pairs of the form pkg:regex
        # the regex is used to ignore names within pkg. (default "fmt:.*").
        # see https://github.com/kisielk/errcheck#the-deprecated-method for details
        ignore: fmt:.*,io/ioutil:^Read.*

        #    # [deprecated] use exclude-functions instead.
        #    # 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

        # list of functions to exclude from checking, where each entry is a single function to exclude.
        # see https://github.com/kisielk/errcheck#excluding-functions for details
        exclude-functions:
            - io/ioutil.ReadFile
            - io.Copy(*bytes.Buffer)
            - io.Copy(os.Stdout)

    errchkjson:
        # With check-error-free-encoding set to true, errchkjson does warn about errors
        # from json encoding functions that are safe to be ignored,
        # because they are not possible to happen.
        #
        # if check-error-free-encoding is set to true and errcheck linter is enabled,
        # it is recommended to add the following exceptions to prevent from false positives:
        #
        #     linters-settings:
        #       errcheck:
        #         exclude-functions:
        #           - encoding/json.Marshal
        #           - encoding/json.MarshalIndent
        #
        # Default: false
        check-error-free-encoding: true
        # Issue on struct encoding that doesn't have exported fields.
        # Default: false
        report-no-exported: false

    errorlint:
        # Check whether fmt.Errorf uses the %w verb for formatting errors.
        # See the https://github.com/polyfloyd/go-errorlint for caveats.
        # Default: true
        errorf: false
        # Check for plain type assertions and type switches.
        # Default: true
        asserts: false
        # Check for plain error comparisons.
        # Default: true
        comparison: false

    exhaustive:
        # check switch statements in generated files also
        check-generated: false
        # presence of "default" case in switch statements satisfies exhaustiveness,
        # even if all enum members are not listed
        default-signifies-exhaustive: true
        # enum members matching the supplied regex do not have to be listed in
        # switch statements to satisfy exhaustiveness
        ignore-enum-members: ""
        # consider enums only in package scopes, not in inner scopes
        package-scope-only: false

    forbidigo:
        # Forbid the following identifiers (identifiers are written using regexp):
        forbid:
            - ^print.*$
            - 'fmt\.Print.*'
        # Exclude godoc examples from forbidigo checks.  Default is true.
        exclude_godoc_examples: false

    funlen:
        lines: 60
        statements: 40

    gci:
        # Section configuration to compare against.
        # Section names are case-insensitive and may contain parameters in ().
        # The default order of sections is `standard > default > custom > blank > dot`,
        # If `custom-order` is `true`, it follows the order of `sections` option.
        # Default: ["standard", "default"]
        sections:
            - standard # Standard section: captures all standard packages.
            - blank # Blank section: contains all blank imports. This section is not present unless explicitly enabled.
            - dot # Dot section: contains all dot imports. This section is not present unless explicitly enabled.
            - default # Default section: contains all imports that could not be matched to another section type.
            - prefix(github.com/epam) # Custom section: groups all imports with the specified Prefix.
            - prefix(github.com/epam/edp-component-operator) # Custom section: groups all imports with the specified Prefix.

        # Skip generated files.
        skip-generated: true

        # Enable custom order of sections.
        # If `true`, make the section order the same as the order of `sections`.
        # Default: false
        custom-order: true

    goconst:
        # minimal length of string constant, 3 by default
        min-len: 3
        # minimum occurrences of constant string count to trigger issue, 3 by default
        min-occurrences: 3
        # ignore test files, false by default
        ignore-tests: false
        # look for existing constants matching the values, true by default
        match-constant: true
        # search also for duplicated numbers, false by default
        numbers: false
        # minimum value, only works with goconst.numbers, 3 by default
        min: 3
        # maximum value, only works with goconst.numbers, 3 by default
        max: 3
        # ignore when constant is not used as function argument, true by default
        ignore-calls: true

    gocritic:
        enabled-tags:
            - diagnostic
            - style
            - performance
            - experimental
            - opinionated

        # Settings passed to gocritic.
        # The settings key is the name of a supported gocritic checker.
        # The list of supported checkers can be find in https://go-critic.github.io/overview.
        settings:
            captLocal: # must be valid enabled check name
                # whether to restrict checker to params only (default true)
                paramsOnly: true
            elseif:
                # whether to skip balanced if-else pairs (default true)
                skipBalanced: true
            hugeParam:
                # size in bytes that makes the warning trigger (default 80)
                sizeThreshold: 80
            nestingReduce:
                # min number of statements inside a branch to trigger a warning (default 5)
                bodyWidth: 5
            rangeExprCopy:
                # size in bytes that makes the warning trigger (default 512)
                sizeThreshold: 512
                # whether to check test functions (default true)
                skipTestFuncs: true
            rangeValCopy:
                # size in bytes that makes the warning trigger (default 128)
                sizeThreshold: 128
                # whether to check test functions (default true)
                skipTestFuncs: true
            ruleguard:
                # Enable debug to identify which 'Where' condition was rejected.
                # The value of the parameter is the name of a function in a ruleguard file.
                #
                # When a rule is evaluated:
                # If:
                #   The Match() clause is accepted; and
                #   One of the conditions in the Where() clause is rejected,
                # Then:
                #   ruleguard prints the specific Where() condition that was rejected.
                #
                # The flag is passed to the ruleguard 'debug-group' argument.
                debug: 'emptyDecl'
                # Deprecated, use 'failOn' param.
                # If set to true, identical to failOn='all', otherwise failOn=''
                failOnError: false
                # Determines the behavior when an error occurs while parsing ruleguard files.
                # If flag is not set, log error and skip rule files that contain an error.
                # If flag is set, the value must be a comma-separated list of error conditions.
                # - 'all':    fail on all errors.
                # - 'import': ruleguard rule imports a package that cannot be found.
                # - 'dsl':    gorule file does not comply with the ruleguard DSL.
                failOn: dsl
            truncateCmp:
                # whether to skip int/uint/uintptr types (default true)
                skipArchDependent: true
            underef:
                # whether to skip (*x).method() calls where x is a pointer receiver (default true)
                skipRecvDeref: true
            unnamedResult:
                # whether to check exported functions
                checkExported: true

    godot:
        # comments to be checked: `declarations`, `toplevel`, or `all`
        scope: declarations

        # check that each sentence starts with a capital letter
        capital: false

    gosimple:
        # Sxxxx checks in https://staticcheck.io/docs/configuration/options/#checks
        checks: ["all"]

    govet:
        # report about shadowed variables
        check-shadowing: true

        # 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

    revive:
        # see https://github.com/mgechev/revive#available-rules for details.
        ignore-generated-header: true
        severity: error
        rules:
            # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#add-constant
            - name: add-constant
              severity: warning
              disabled: false
              arguments:
                  - maxLitCount: "3"
                    allowStrs: '""'
                    allowInts: "0,1,2"
                    allowFloats: "0.0,0.,1.0,1.,2.0,2."
            # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#atomic
            - name: atomic
              severity: warning
              disabled: false
            # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#blank-imports
            - name: blank-imports
              severity: warning
              disabled: false
            # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#bool-literal-in-expr
            - name: bool-literal-in-expr
              severity: warning
              disabled: false
            # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#call-to-gc
            - name: call-to-gc
              severity: warning
              disabled: false
            # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#confusing-naming
            - name: confusing-naming
              severity: warning
              disabled: false
            # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#confusing-results
            - name: confusing-results
              severity: warning
              disabled: false
            # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#constant-logical-expr
            - name: constant-logical-expr
              severity: warning
              disabled: false
            # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#context-as-argument
            - name: context-as-argument
              severity: warning
              disabled: false
            # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#context-keys-type
            - name: context-keys-type
              severity: warning
              disabled: false
            # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#datarace
            - name: datarace
              severity: warning
              disabled: false
            # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#dot-imports
            - name: dot-imports
              severity: warning
              disabled: false
            # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#duplicated-imports
            - name: duplicated-imports
              severity: warning
              disabled: false
            # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#early-return
            - name: early-return
              severity: warning
              disabled: false
            # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#empty-block
            - name: empty-block
              severity: warning
              disabled: false
            # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#empty-lines
            - name: empty-lines
              severity: warning
              disabled: false
            # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#error-naming
            - name: error-naming
              severity: warning
              disabled: false
            # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#error-return
            - name: error-return
              severity: warning
              disabled: false
            # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#error-strings
            - name: error-strings
              severity: warning
              disabled: false
            # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#errorf
            - name: errorf
              severity: warning
              disabled: false
            # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#get-return
            - name: get-return
              severity: warning
              disabled: false
            # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#identical-branches
            - name: identical-branches
              severity: warning
              disabled: false
            # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#if-return
            - name: if-return
              severity: warning
              disabled: false
            # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#increment-decrement
            - name: increment-decrement
              severity: warning
              disabled: false
            # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#indent-error-flow
            - name: indent-error-flow
              severity: warning
              disabled: false
            # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#optimize-operands-order
            - name: optimize-operands-order
              severity: warning
              disabled: false
            # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#range
            - name: range
              severity: warning
              disabled: false
            # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#range-val-in-closure
            - name: range-val-in-closure
              severity: warning
              disabled: false
            # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#range-val-address
            - name: range-val-address
              severity: warning
              disabled: false
            # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#receiver-naming
            - name: receiver-naming
              severity: warning
              disabled: false
            # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#redefines-builtin-id
            - name: redefines-builtin-id
              severity: warning
              disabled: false
            # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#string-of-int
            - name: string-of-int
              severity: warning
              disabled: false
            # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#superfluous-else
            - name: superfluous-else
              severity: warning
              disabled: false
            # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#time-equal
            - name: time-equal
              severity: warning
              disabled: false
            # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unnecessary-stmt
            - name: unnecessary-stmt
              severity: warning
              disabled: false
            # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unreachable-code
            - name: unreachable-code
              severity: warning
              disabled: false
            # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unused-parameter
            - name: unused-parameter
              severity: warning
              disabled: false
            # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unused-receiver
            - name: unused-receiver
              severity: warning
              disabled: false
            # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#useless-break
            - name: useless-break
              severity: warning
              disabled: false
            # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#waitgroup-by-value
            - name: waitgroup-by-value
              severity: warning
              disabled: false

    staticcheck:
        # SAxxxx checks in https://staticcheck.io/docs/configuration/options/#checks
        checks: ["all"]

    wsl:
        # See https://github.com/bombsimon/wsl/blob/master/doc/configuration.md for
        # documentation of available settings. These are the defaults for
        # `golangci-lint`.
        allow-assign-and-anything: false
        allow-assign-and-call: true
        allow-cuddle-declarations: false
        allow-multiline-assign: true
        allow-separated-leading-comment: false
        allow-trailing-comment: false
        force-case-trailing-whitespace: 0
        force-err-cuddling: false
        force-short-decl-cuddling: false
        strict-append: true