Skip to content

Repository files navigation

oxc-config-seek

Warning

This project is still under active development and is not yet ready for production use. APIs and behaviour may change without notice.

Shareable Oxfmt and Oxlint config for SEEK: the Oxc toolchain equivalent of eslint-config-seek

It aims for behavioural parity with those configs. Where oxlint or oxfmt cannot express something the ESLint/Prettier setup did, the source files carry an inline // oxc parity: comment recording the decision. See Parity notes.

Requirements

  • oxlint's TypeScript config (oxlint.config.ts) and oxfmt's oxfmt.config.ts require a Node.js runtime that can execute TypeScript: Node.js 22.18+ or 24+.
  • Install oxlint, oxfmt, and typescript (declared as peer dependencies).

Linting (oxlint)

Pick the entrypoint that matches your project and re-export it from your oxlint.config.ts via oxlint's extends:

import { defineConfig } from 'oxlint';
import config from 'oxc-config-seek';

export default defineConfig({
  extends: [config],
});
Entrypoint Project type
oxc-config-seek React
oxc-config-seek/base No React
oxc-config-seek/vitest React + Vitest
oxc-config-seek/vitest/base No React + Vitest

oxc-config-seek/extensions exports the js / ts file-extension arrays used to build globs, mirroring eslint-config-seek/extensions.

Composition mirrors eslint-config-seek: . = base + react, base = shared, vitest = vitest/base + react, vitest/base = shared + Vitest.

Formatting (oxfmt)

Re-export it from your oxfmt.config.ts

export { default } from 'oxc-config-seek/oxfmt';

This applies singleQuote, tabWidth: 2 and package.json key sorting.

About

🐂 Shareable Oxfmt and Oxlint config used by SEEK

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages