.golangcilint.yml

linters:
  # FIXME(roosd): For now, we disable all linters and turn them on one-by-one.
  disable-all: true
  enable:
    # Default linters.
    - errcheck
    - gosimple
    - govet
    - ineffassign
    - typecheck
    - unused
    # Extended linters.
    - depguard
    - exportloopref
    - rowserrcheck
    - sqlclosecheck
    - unconvert
    - gofmt
    - lll
    - misspell
    - goheader
linters-settings:
  lll:
    line-length: 100
    tab-width: 4
  depguard:
    list-type: blacklist
    include-go-root: true
    packages: "io/ioutil"
    packages-with-error-message:
      # specify an error message to output when a blacklisted package is used
      "io/ioutil": >
        "The use of 'io/ioutil' is deprecated. Check
        https://pkg.go.dev/io/ioutil for alternatives"
  errcheck:
    exclude-functions:
      - (*github.com/spf13/cobra.Command).MarkFlagRequired
  goheader:
    values:
      regexp:
        copyright-lines: "(Copyright 20[0-9][0-9] .*)(\nCopyright 20[0-9][0-9] .*)*"
    template: |-
      {{copyright-lines}}

      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.

issues:
  exclude-rules:
    # don't report long lines with long links
    - linters: [lll]
      source: "http[s]://\\S{80,}$"
    # don't report long lines with yaml/json/toml tags
    - linters: [lll]
      source: "`(yaml|toml|json):\"[^`]*`$"

    # these files originate from third-party projects
    - path: pkg/private/util/duration.go
      linters: [goheader]
    - path: pkg/private/serrors/stack.go
      linters: [goheader, errcheck]
    - path: scion-pki/certs/(certinfo|certformat).go
      linters: [lll, goheader, errcheck]
    - path: pkg/scrypto/cms
      linters: [goheader]

    # Exceptions to errcheck for some experimental colibri code and some old-ish convey tests.
    - linters: [errcheck]
      path: "^control/colibri/reservation/e2e/reservation_test.go$|\
             ^control/colibri/reservation/index_test.go$|\
             ^control/colibri/reservation/reservationdbtest/reservationdbtest.go$|\
             ^control/colibri/reservation/segment/reservation_test.go$|\
             ^control/colibri/reservation/sqlite/db_test.go$|\
             ^control/colibri/reservationstore/store.go$|\
             ^pkg/sock/reliable/reconnect/conn_io_test.go$|\
             ^pkg/sock/reliable/reconnect/network_test.go$|\
             ^pkg/sock/reliable/reconnect/reconnecter_test.go$"