.golangci.yml

# This file contains all available configuration options
# with their default values.

# options for analysis running
run:
  timeout: 5m
  issues-exit-code: 1
  build-tags:
    # include integration text files
    - integration

output:
  # colored-line-number|line-number|json|tab|checkstyle|code-climate, default is "colored-line-number"
  format: 'colored-line-number'

linters:
  disable-all: true
  enable:
    # detect possible issues in code or coding style
    - errcheck
    - gofmt
    - gofumpt
    - goimports
    - revive
    - gosec
    - gosimple
    - govet
    - ineffassign
    - megacheck
    - nolintlint
    - testpackage
    - staticcheck
    - stylecheck
      # restrict dependencies
    - depguard
      # detect unused, duplicate code
    - dupl
    - goconst
    - unconvert
    - unparam
    - unused
      # check code complexity
    - funlen
    - gocognit
    - gocyclo
    - lll
      # detect grammatical aspects
    - godot
    - misspell
      # detect possible optimizations
  fast: false

# all available settings of specific linters
linters-settings:

  errcheck:
    # report about assignment of errors to blank identifiers, default is false.
    check-blank: true

  depguard:
    rules:
      main:
        deny:
          - pkg: "github.com/ethereum/go-ethereum"
            desc: It contains code licensed under LGPL, import is allowed only inside perun-node/blockchain/ethereum
          - pkg: "perun.network/go-perun/backend/ethereum"
            desc: It uses code licensed under LGPL, import is allowed only inside perun-node/blockchain/ethereum"

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

  funlen:
    lines: 60
    statements: 40

  goconst:
    # minimal length of string constant, 3 by default
    min-len: 3
    # minimal occurrences count to trigger, 3 by default
    min-occurrences: 5

  gocognit:
    # minimal code complexity to report, 30 by default (but we recommend 10-20)
    min-complexity: 20

  gocyclo:
    # minimal code complexity to report, 30 by default (but we recommend 10-20)
    min-complexity: 20

  goimports:
    local-prefixes: github.com/hyperledger-labs/perun-node

  govet:
    check-shadowing: true

  lll:
    line-length: 120
    tab-width: 1

  misspell:
    locale: US

  testpackage:
  skip-regexp: internal_test\.go

issues:
  # Excluding configuration per-path, per-linter, per-text and per-source
  exclude-rules:
    # Exclude some linters from running on tests files and test helper packages.
    - path: _test\.go
      linters:
        - funlen
        - gosec
        - depguard
    
    - path: test/
      linters:
        - funlen
        - gosec

    - path: blockchain/ethereum/
      linters:
        - depguard

    # Grpc adapter does have some repetitive boilerplate code.
    - path: api/grpc/
      linters:
        - dupl

    # It is okay to return an unexported type when the type satisfies a public interface.
    - linters:
        - golint
      text: "returns unexported type"

    - linters:
        - lll
      source: "^//go:generate "

  # Default value for this option is true.
  # Set it to false, because it discards errors from golint.
  # Especially missing comments for exported types & variables.
  exclude-use-default: false