nmon/.golangci.yml

# Enforces docs/MAINTAINABILITY.md. A hard rule: `make lint` must be clean for any gate to pass.
version: "2"

run:
  timeout: 10m
  tests: true

# Report every finding: funlen and gocognit flag the same line and must both show.
issues:
  max-issues-per-linter: 0
  max-same-issues: 0
  uniq-by-line: false

linters:
  default: none
  enable:
    - govet
    - errcheck
    - staticcheck
    - unused
    - ineffassign
    - funlen
    - cyclop
    - gocognit
    - nestif
    - dupl
    - lll
    - errorlint
    - usestdlibvars
    - misspell
    - revive
    - depguard
    - forbidigo
    - nolintlint
    - unconvert
    - bodyclose
    - copyloopvar

  settings:
    funlen:
      lines: 80
      statements: 50
      ignore-comments: true
    cyclop:
      max-complexity: 15
    gocognit:
      min-complexity: 20
    nestif:
      min-complexity: 4
    dupl:
      threshold: 150
    lll:
      line-length: 140
    misspell:
      # MikroTik's OS name and a profile name, not a typo of "routers".
      ignore-rules: [routeros]
    nolintlint:
      require-explanation: true
      require-specific: true
    revive:
      rules:
        - name: exported
          arguments: ["disableStutteringCheck"]
        - name: package-comments
        - name: var-naming
        - name: indent-error-flow
        - name: error-strings
        - name: receiver-naming
        - name: unexported-return
    forbidigo:
      analyze-types: true
      forbid:
        - pattern: '^time\.(Now|Sleep|After|Tick|NewTicker|NewTimer)$'
          msg: "use internal/clock so tests control time (docs/MAINTAINABILITY.md)"
    depguard:
      rules:
        orm-only-in-store:
          files: ["$all", "!**/internal/store/**"]
          deny:
            - pkg: github.com/uptrace/bun
              desc: SQL and the ORM live only in internal/store
            - pkg: database/sql
              desc: SQL lives only in internal/store
        app-only-from-cmd:
          files: ["$all", "!**/cmd/**"]
          deny:
            - pkg: github.com/v10networks/nmon/internal/app
              desc: only cmd/* wires the application
        api-only-from-app:
          files: ["$all", "!**/internal/app/**", "!**/internal/api/**", "!$test"]
          deny:
            - pkg: github.com/v10networks/nmon/internal/api
              desc: only internal/app mounts the API
        collection-paths-independent:
          files:
            - "**/internal/poller/**"
            - "**/internal/discovery/**"
            - "**/internal/traps/**"
            - "**/internal/ingest/**"
            - "**/internal/checks/**"
            - "**/internal/rollup/**"
            - "**/internal/alert/**"
            - "**/internal/l2/**"
          deny:
            - pkg: github.com/v10networks/nmon/internal/poller
              desc: collection paths share code via a lower package, not each other
            - pkg: github.com/v10networks/nmon/internal/discovery
              desc: collection paths share code via a lower package, not each other
            - pkg: github.com/v10networks/nmon/internal/traps
              desc: collection paths share code via a lower package, not each other
            - pkg: github.com/v10networks/nmon/internal/l2
              desc: collection paths share code via a lower package, not each other
        devtools-not-in-nmon:
          # The product binary never links dev/test machinery. `nmon profile record` needs only the
          # .snmprec format, which lives in internal/snmprec.
          files: ["**/cmd/nmon/**", "!$test"]
          deny:
            - pkg: github.com/v10networks/nmon/internal/simagent
              desc: the simulator belongs to cmd/nmon-devtools and tests, never the shipped binary
            - pkg: github.com/v10networks/nmon/internal/fixturegen
              desc: the fixture generator belongs to cmd/nmon-devtools and tests, never the shipped binary
            - pkg: github.com/v10networks/nmon/internal/fixtures
              desc: fixtures are test data, never the shipped binary
            - pkg: github.com/v10networks/nmon/internal/testutil
              desc: test helpers are never in the shipped binary
        devtools-no-core:
          files: ["**/cmd/nmon-devtools/**"]
          deny:
            - pkg: github.com/v10networks/nmon/internal/app
              desc: nmon-devtools talks to a running nmon over HTTP
            - pkg: github.com/v10networks/nmon/internal/api
              desc: nmon-devtools talks to a running nmon over HTTP
        importer-not-in-nmon:
          files: ["**/cmd/nmon/**"]
          deny:
            - pkg: github.com/v10networks/nmon/internal/librenms
              desc: the LibreNMS importer is a separate tool (DEVIATIONS 9)

  exclusions:
    paths:
      - web/node_modules
    rules:
      # Table-driven tests are long by nature; every other linter still applies.
      - path: _test\.go
        linters: [funlen, cyclop, gocognit, nestif, dupl, lll, forbidigo]
      # The clock package wraps time; cmd/ and the test-only simulator may use real time.
      - path: internal/clock/
        linters: [forbidigo]
      - path: cmd/
        linters: [forbidigo]
      # A package is allowed to import itself's own test helpers and itself.
      - path: internal/(poller|discovery|traps)/.*_test\.go
        linters: [depguard]

formatters:
  enable:
    - gofmt
    - goimports
  exclusions:
    paths:
      - web/node_modules