.golangci.yaml

# WARNING: please install diffutils macOS Ventura by: brew install diffutils
# https://github.com/golangci/golangci-lint/discussions/3327

linters:
  enable:
    - errcheck
    - goimports
    - revive
    - govet
    - staticcheck
    - misspell
    - gocritic
    - sqlclosecheck
    - rowserrcheck
    - nilerr
    - godot
    - forbidigo
    - mirror
    - bodyclose
    - exhaustive

# golangci-lint run --exclude="Rollback,logger.Sync,pgInstance.Stop"
issues:
  include:
    # https://golangci-lint.run/usage/configuration/#command-line-options
  exclude:
    - Rollback
    - logger.Sync
    - pgInstance.Stop
    - fmt.Printf
    - Enter(.*)_(.*)
    - Exit(.*)_(.*)
  skip-dirs:
    - proto/generated-go
    - frontend

run:
  timeout: 30m
  build-tags:
    - mysql

linters-settings:
  goimports:
    # Put imports beginning with prefix after 3rd-party packages.
    # It's a comma-separated list of prefixes.
    local-prefixes: github.com/bytebase/bytebase
  revive:
    # Default to run all linters so that new rules in the future could automatically be added to the static check.
    enable-all-rules: true
    rules:
      # The following rules are too strict and make coding harder. We do not enable them for now.
      - name: file-header
        disabled: true
      - name: line-length-limit
        disabled: true
      - name: function-length
        disabled: true
      - name: max-public-structs
        disabled: true
      - name: function-result-limit
        disabled: true
      - name: banned-characters
        disabled: true
      - name: argument-limit
        disabled: true
      - name: cognitive-complexity
        disabled: true
      - name: cyclomatic
        disabled: true
      - name: confusing-results
        disabled: true
      - name: add-constant
        disabled: true
      - name: flag-parameter
        disabled: true
      - name: nested-structs
        disabled: true
      - name: import-shadowing
        disabled: true
      - name: early-return
        disabled: true
      - name: max-control-nesting
        disabled: true
      - name: comment-spacings
        arguments:
          - exhaustive
  staticcheck:
    checks: ["all", "-SA1019"]
  gocritic:
    disabled-checks:
      - ifElseChain
  govet:
    settings:
      printf: # The name of the analyzer, run `go tool vet help` to see the list of all analyzers
        funcs: # Run `go tool vet help printf` to see the full configuration of `printf`.
          - common.Errorf
    enable-all: true
    disable:
      - fieldalignment
      - shadow
  exhaustive:
    explicit-exhaustive-switch: true
  forbidigo:
    forbid:
      - 'fmt\.Errorf(# Please use errors\.Wrap\|Wrapf\|Errorf instead)?'
      - 'ioutil\.ReadDir(# Please use os\.ReadDir)?'