oxlint-config

wakamsha's oxlint rules as an extensible shared config.

Usage

1. Install dependencies (and peer dependencies)

npm install --save-dev @wakamsha/oxlint-config oxlint oxlint-tsgolint

2. Configure oxlint

Oxlint supports both oxlint.config.ts and .oxlintrc.json. Use either one in the same directory (not both).

Option A: oxlint.config.ts (recommended)

import { defineConfig } from 'oxlint';
import { essentials } from '@wakamsha/oxlint-config';

export default defineConfig({
  extends: [essentials],
});

If you need TypeScript support:

import { defineConfig } from 'oxlint';
import { essentials, typescript } from '@wakamsha/oxlint-config';

export default defineConfig({
  extends: [essentials, typescript],
});

typescript must be added after essentials.

You can also combine other provided rule sets:

import { defineConfig } from 'oxlint';
import {
  essentials,
  jsdoc,
  nextjs,
  node,
  react,
  test,
  typescript,
} from '@wakamsha/oxlint-config';

export default defineConfig({
  extends: [
    essentials,
    typescript,
    jsdoc,
    node,
    react,
    nextjs,
    test.essentials,
  ],
});

Option B: .oxlintrc.json

{
  "$schema": "./node_modules/oxlint/configuration_schema.json",
  "extends": ["./node_modules/@wakamsha/oxlint-config/configs/essentials.json"]
}

If you need TypeScript support:

{
  "$schema": "./node_modules/oxlint/configuration_schema.json",
  "extends": [
    "./node_modules/@wakamsha/oxlint-config/configs/essentials.json",
    "./node_modules/@wakamsha/oxlint-config/configs/typescript.json"
  ]
}

You can combine other JSON presets as well (for example react.json, nextjs.json, test/essentials.json).

| Rule set | Summary | | ----------------: | ------------------------------------------------------ | | essentials | Contains basic, import, and promise recommended rules. | | jsdoc | Contains JSDoc recommended rules. | | node | Contains Node.js recommended rules. | | react | Contains React and jsx-a11y recommended rules. | | nextjs | Contains Next.js recommended rules. | | test.essentials | Contains Vitest and Jest rules. | | typescript | Contains TypeScript recommended rules. |

Integration with ESLint

You can integrate oxlint with ESLint using the eslint-plugin-oxlint if you still need ESLint that oxlint does not cover yet. This plugin turns off all rules that are already covered by oxlint to avoid conflicts.

import oxlint from 'eslint-plugin-oxlint';

export default [
  // Other ESLint configs...

  ...oxlint.configs['flat/all'],
];

Then, run ESLint after oxlint:

npx oxlint --type-aware && npx eslint

Versioning

• Increment major version: Changed error rules.
• Increment minor version: Changed warn rules.
• Increment patch version: Not changed error and warn rules.

License

Open source licensed as MIT.