.golangci.yml

---
# Ref: https://golangci-lint.run/usage/configuration/
linters:
  enable-all: true

  disable:
    - cyclop # some functions need refactoring, I'll deal with that later
    - exhaustruct # it's ok not to specify all the fields in a struct definition
    - godox # I like leaving TODOs in the code
    - testpackage # keep the tests close to the code
    - varnamelen # short variable names are okay

    # deprecated
    - exportloopref

issues:
  exclude-rules:
    - path: _test.go
      linters:
        - bodyclose
        - funlen
        - revive

    - path: internal/cmd
      linters:
        # using init() is recommended with spf13/cobra
        - gochecknoinits
        # using globals is recommended with spf13/cobra
        - gochecknoglobals

    - path: internal/repl
      linters:
        # returning interface is the way to work with charmbracelet/bubbletea
        - ireturn

linters-settings:
  nolintlint:
    require-explanation: true

  gci:
    sections:
      - standard
      - default
      - localmodule

  mnd:
    ignored-numbers:
      # UNIX permissions mask
      - "0o700" # rwx------
      - "0o600" # rw-------

    ignored-functions:
      # Functions that require a UNIX permissions mask
      - "os.WriteFile"
      - "os.OpenFile"
      - "os.MkdirAll"

  depguard:
    rules:
      main:
        files:
          - $all
        allow:
          - $gostd
          - github.com/cli/go-gh
          - github.com/nobe4/gh-not
          - github.com/charmbracelet/bubbletea
          - github.com/charmbracelet/bubbles
          - github.com/charmbracelet/lipgloss
          - github.com/spf13/cobra
          - github.com/spf13/viper
          - github.com/itchyny/gojq

  revive:
    enable-all-rules: true
    rules:
      - name: add-constant
        disabled: true

      - name: context-as-argument
        arguments:
          - allowTypesBefore: "*testing.T"

      - name: comment-spacings
        arguments:
          - "nolint"

      - name: cognitive-complexity
        disabled: true # TODO: re enable to simplify functions

      - name: cyclomatic
        disabled: true # TODO: re enable to simplify functions

      - name: max-public-structs
        disabled: true # I might enable that later


      - name: import-alias-naming
        arguments:
          - "^[a-z][A-Za-z0-9]{0,}$"

      - name: line-length-limit
        disabled: true # using lll

      - name: unhandled-error
        arguments:
          - "fmt.Printf"
          - "fmt.Println"
          - "fmt.Fprint"
          - "fmt.Fprintf"
          - "fmt.Fprintln"

  tagliatelle:
    case:
      rules:
        json: snake

  misspell:
    locale: US
    mode: default