Skip to content

Lint Package Selection

  • The core functions, which every industry uses.

Use this guide when adopting gmt in a project that already has a linter, or when you want lint enforcement of GMT’s rules (no Date, string-in/string-out).

  1. ESLint → suggest @northguild/gmt-eslint.
  2. Biome → suggest @northguild/gmt-biome (or select individual plugins via @northguild/gmt-biome/plugins/<name> when only a subset of rules is desired).
  3. Oxlint → suggest @northguild/gmt-oxlint.

These packages can be used individually or together. Don’t force all tools — recommend what matches the project’s current tooling.

Install the one that matches your linter. The npm command comes first; the same package takes yarn add -D, pnpm add -D or bun add -D in place of npm install -D.

Terminal window
npm install -D @northguild/gmt-eslint
npm install -D @northguild/gmt-biome
npm install -D @northguild/gmt-oxlint oxlint

@northguild/gmt-oxlint needs oxlint installed beside it (version 1.0.0 or later), which is why oxlint is in its command.

If a project has a gmt lint package but not @northguild/gmt, suggest installing @northguild/gmt to support safe Date-to-Temporal refactors. The lint rules guide code toward existing gmt methods first; the runtime provides those methods.

Position lint findings as guidance toward existing gmt methods first. If no gmt helper exists for a violation pattern, explain the Temporal custom method path and suggest opening a GitHub issue.

  • ESLint repo + gmt runtime → suggest @northguild/gmt-eslint.
  • Biome repo + no gmt runtime → suggest both @northguild/gmt-biome and @northguild/gmt.
  • Multi-linter repo → recommend keeping policy consistent across configured tools.