.golangci.yml

# This file contains all available configuration options
# with their default values (in comments).
#
# This file is not a configuration example,
# it contains the exhaustive configuration with explanations of the options.

issues:
  # Which files to exclude: they will be analyzed, but issues from them won't be reported.
  # There is no need to include all autogenerated files,
  # we confidently recognize autogenerated files.
  # If it's not, please let us know.
  # "/" will be replaced by current OS file path separator to properly work on Windows.
  # Default: []
  exclude-files:
    - ".*_ssz\\.go$"

  include:
    - 'EXC0002'
    - 'EXC0005'
    - 'EXC0009'
    - 'EXC0011'
    - 'EXC0012'
    - 'EXC0014'
      #
# Options for analysis running.
run:
  # The default concurrency value is the number of available CPU.
  # concurrency: 4

  # Timeout for analysis, e.g. 30s, 5m.
  # Default: 1m
  timeout: 10m

  # Exit code when at least one issue was found.
  # Default: 1
  # issues-exit-code: 2

  # Include test files or not.
  # Default: true
  tests: false

  # List of build tags, all linters use it.
  # Default: [].
  # build-tags:
  #   - mytag

  # Which dirs to skip: issues from them won't be reported.
  # Can use regexp here: `generated.*`, regexp is applied on full path.
  # Default value is empty list,
  # but default dirs are skipped independently of this option's value (see skip-dirs-use-default).
  # "/" will be replaced by current OS file path separator to properly work on Windows.
  # skip-dirs:
  #   - autogenerated_by_my_lib

  # Enables skipping of directories:
  # - vendor$, third_party$, testdata$, examples$, Godeps$, builtin$
  # Default: true
  # skip-dirs-use-default: false

  # If set we pass it to "go list -mod={option}". From "go help modules":
  # If invoked with -mod=readonly, the go command is disallowed from the implicit
  # automatic updating of go.mod described above. Instead, it fails when any changes
  # to go.mod are needed. This setting is most useful to check that go.mod does
  # not need updates, such as in a continuous integration and testing system.
  # If invoked with -mod=vendor, the go command assumes that the vendor
  # directory holds the correct copies of dependencies and ignores
  # the dependency descriptions in go.mod.
  #
  # Allowed values: readonly|vendor|mod
  # By default, it isn't set.
  modules-download-mode: readonly

  # Allow multiple parallel golangci-lint instances running.
  # If false (default) - golangci-lint acquires file lock on start.
  allow-parallel-runners: true

  # Define the Go version limit.
  # Mainly related to generics support since go1.18.
  # Default: use Go version from the go.mod file, fallback on the env var `GOVERSION`, fallback on 1.18
  # go: '1.20'


# output configuration options
output:
  # Format: colored-line-number|line-number|json|tab|checkstyle|code-climate|junit-xml|github-actions
  #
  # Multiple can be specified by separating them by comma, output can be provided
  # for each of them by separating format name and path by colon symbol.
  # Output path can be either `stdout`, `stderr` or path to the file to write to.
  # Example: "checkstyle:report.json,colored-line-number"
  #
  # Default: colored-line-number
  # format: json

  # Print lines of code with issue.
  # Default: true
  # print-issued-lines: false

  # Print linter name in the end of issue text.
  # Default: true
  # print-linter-name: false

  # Make issues output unique by line.
  # Default: true
  # uniq-by-line: false

  # Add a prefix to the output file references.
  # Default is no prefix.
  # path-prefix: ""

  # Sort results by: filepath, line and column.
  # sort-results: true


# All available settings of specific linters.
linters-settings:
  goheader:
    values:
      regexp:
        YEARS: '(20\d\d - 20\d\d|20\d\d, 20\d\d|20\d\d)'
    template: |-
      Copyright © {{ YEARS }} Attestant Limited.
      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.

  gosec:
    excludes:
      - G115 # This generates a lot of false positives, recheck once https://github.com/securego/gosec/issues/1212 is closed

  lll:
    line-length: 132

  nlreturn:
    # Allow two-line blocks without requiring a newline
    block-size: 3

  revive:
    ignore-generated-header: false
    severity: error
    confidence: 0.8
    errorCode: 0
    warningCode: 0
    enable-all-rules: true
    rules:
      - name: add-constant
        disabled: true
      - name: cyclomatic
        disabled: true
      - name: cognitive-complexity
        disabled: true
      - name: confusing-results
      - name: function-length
        disabled: true
      - name: line-length-limit
        arguments: [132]
      - name: max-public-structs
        disabled: true
      - name: package-comments
        disabled: true
      - name: struct-tag
        arguments: ["json,allowempty"]
      - name: unhandled-error
        arguments:
          - "fmt.Fprint"
          - "fmt.Fprintf"
      - name: unnecessary-stmt
        disabled: true

  stylecheck:
    checks: [ "all", "-ST1000" ]

  tagliatelle:
    case:
      # use-field-name: true
      rules:
        json: snake
        yaml: snake

linters:
  # Enable all available linters.
  # Default: false
  enable-all: true
  # Disable specific linter
  # https://golangci-lint.run/usage/linters/#disabled-by-default
  disable:
    - cyclop
    - depguard
    - dupl
    - err113
    - execinquery
    - exhaustive
    - exhaustruct
    - exportloopref
    - forcetypeassert
    - funlen
    - gci
    - gochecknoglobals
    - gocognit
    - goconst
    - gomnd
    - ireturn
    - lll
    - maintidx
    - mnd
    - musttag
    - perfsprint
    - tagliatelle
    - varnamelen
    - wrapcheck
    - wsl