Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

1.7 KB
Raw Blame

JavaScript and TypeScript linting

Oxlint runs the JavaScript and TypeScript checks in bun run lint, the staged-file checks and frontend CI, including module boundaries. Oxfmt formats the code and sorts imports. ESLint stays installed for the plugins oxlint runs through its JS plugin API, the compatibility tests and bun run module-boundaries, which the weekly stats collector runs.

Oxfmt moves value imports past side-effect imports when it sorts. A file whose import order matters at runtime keeps that order with // oxfmt-ignore comments.

Where the configuration lives

These files hold the lint configuration. Paths are relative to frontend/lint unless they say otherwise.

  • oxlint.config.mts in the repo root is the entry point oxlint loads.
  • config.mjs holds the rule options, file scopes, globals and settings. Both engines read it.
  • oxlint/config.mjs translates that policy into an oxlint config.
  • oxlint/rule-map.json maps each ESLint rule name to a native oxlint rule or a JS plugin rule.
  • recommended-rules.json and oxlint/rule-defaults.json are generated snapshots of the plugin presets and rule defaults.
  • eslint.config.mjs in the repo root supplies the parsers and plugins for the ESLint side of the compatibility tests.

After a dependency upgrade

Run bun run lint-config-update and review the snapshot changes. createConfig throws on an enabled rule that has no entry in oxlint/rule-map.json, so add an entry for each rule the upgrade enables. Then run bun run test-oxlint.

Known limits

The import resolver reuses its results within one CLI run over a fixed tree. Persistent caching and invalidation for editors or watch mode are not implemented.