.golangci.yml

---
# Linters that should pass for all FerretDB and tools code.

run:
  timeout: 3m

linters-settings:
  # asciicheck
  depguard:
    list-type: blacklist
    packages:
      - golang.org/x/net/context # use stdlib's context instead
      - github.com/FerretDB/FerretDB/internal/bson
      - github.com/FerretDB/FerretDB/internal/handlers/pg/pgdb
      - github.com/FerretDB/FerretDB/internal/handlers/pg/pjson
      - github.com/FerretDB/FerretDB/internal/handlers/tigris/tigrisdb
      - github.com/FerretDB/FerretDB/internal/handlers/tigris/tjson
      - github.com/FerretDB/FerretDB/internal/types/fjson
      - github.com/tigrisdata/tigris-client-go/api/client/v1/api
      - github.com/tigrisdata/tigris-client-go/filter # We use our own filter without generics (see tigris/tigrisdb/filter)
  exhaustive:
    default-signifies-exhaustive: false
  gci:
    sections:
      - standard
      - default
      - prefix(github.com/FerretDB/FerretDB)
  goconst:
    min-occurrences: 5
    ignore-tests: true
  godot:
    scope: toplevel
    exclude:
      - go-sumtype:decl
      - check interfaces
    capital: true
  godox:
    keywords:
      - BUG
      - FIXME
      - HACK
  goheader:
    # Please do not update it, including bumping a year.
    template: |-
      Copyright 2021 FerretDB Inc.

      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.
  goimports:
    local-prefixes: github.com/FerretDB/FerretDB
  gomodguard:
    blocked:
      modules:
        - go.mongodb.org/mongo-driver:
            reason: "FerretDB should not depend on MongoDB Go driver."
  gosimple:
    checks: ["all"]
  govet:
    enable-all: true
    disable:
      - fieldalignment
      - nilness
      - shadow
  importas:
    no-unaliased: false
    no-extra-aliases: true
    alias:
      - pkg: github.com/tigrisdata/tigris-client-go/api/server/v1
        alias: api
      - pkg: github.com/prometheus/client_model/go
        alias: dto
  # ineffassign
  lll:
    line-length: 130
    tab-width: 4
  misspell:
    ignore-words:
      - guiness # present in the test dataset
  nolintlint:
    allow-unused: false
    allow-leading-space: false
    allow-no-explanation: []
    require-explanation: true
    require-specific: true
  revive:
    ignore-generated-header: true
    severity: error
  staticcheck:
    checks:
      - all
      - -SA1019 # ignore deprecation errors in existing code; new code is checked by the other configuration
  # unused
  whitespace:
    multi-if: false
    multi-func: false

linters:
  disable-all: true
  enable:
    - asciicheck
    - depguard
    - exhaustive
    - gci
    - goconst
    - godot
    - godox
    - goheader
    - goimports
    - gomodguard
    - gosimple
    - govet
    - importas
    - ineffassign
    - lll
    - misspell
    - nolintlint
    - revive
    - staticcheck
    - unused
    - whitespace

issues:
  max-issues-per-linter: 0
  max-same-issues: 0

  exclude-use-default: false
  exclude-rules:
    # only `wire` package can import `bson` package
    - linters: [depguard]
      path: internal/wire
      text: bson

    # only `testutil`, `bson` (for testing), and `wire` packages can import `fjson` package
    - linters: [depguard]
      path: internal/util/testutil
      text: fjson
    - linters: [depguard]
      path: internal/bson
      text: fjson
    - linters: [depguard]
      path: internal/wire
      text: fjson

    # only `pg` handler can import `pgdb` package, no other handler can do that
    - linters: [depguard]
      path: internal/handlers/pg
      text: pgdb
    - linters: [depguard]
      path: internal/handlers/registry
      text: pgdb
    - linters: [depguard]
      path: cmd/envtool
      text: pgdb

    # only `pg` handler can import `pjson` package, no other handler can do that
    - linters: [depguard]
      path: internal/handlers/pg
      text: pjson

    # only `tigris` handler can import `tigrisdb` package, no other handler can do that
    - linters: [depguard]
      path: internal/handlers/tigris
      text: tigrisdb
    - linters: [depguard]
      path: internal/handlers/registry
      text: tigrisdb
    - linters: [depguard]
      path: cmd/envtool
      text: tigrisdb

    # only `tigris` handler can import `tjson` package, no other handler can do that
    - linters: [depguard]
      path: internal/handlers/tigris
      text: tjson

    # we don't want to introduce that constant
    - linters: [goconst]
      text: "^string `_id` has \\d+ occurrences, make it a constant"