Getting started
はじめに
プラグインを導入し、プリセットを選んで Oxlint を実行します。
インストール
TypeScript プロジェクトにパッケージと Oxlint を導入します。対象は Node.js 24 以降です。 npm リリース workflow は有効ですが、owner による初回公開と Trusted Publisher 設定は未完了です。レジストリで実際に利用可能になるまでは npm pack の配布アーカイブを使います。workspace パスで代用しないでください。
# Before publication, install a supplied package archive:
npm install --save-dev ./totto2727-oxlint-0.0.0.tgz oxlint
# After npm publication:
npm install --save-dev @totto2727/oxlint oxlint設定
ESM の oxlint.config.ts を作成し、プリセットオブジェクトを import します。
import { defineConfig } from 'oxlint'
import typescript from '@totto2727/oxlint/typescript'
export default defineConfig({ extends: [typescript] })Effect のみには @totto2727/oxlint/effect、両グループには @totto2727/oxlint/preset を使います。 default export のプラグインは rules/ 名前空間です。名前付き export の typescriptRuleNames、effectRuleNames、compatibilityRuleNames で所属を参照できます。 プリセットは native Ultracite 7.12.3 core 設定の MIT 固定移植を含みます。ライブラリは Ultracite CLI パッケージ全体に依存せず、Oxlint で直接実行します。別の Ultracite プリセットや CLI wrapper は不要です。 React、type-aware ルール、Ultracite JavaScript plugins、oxfmt 統合は個別の opt-in であり、自動的には有効化しません。 プリセットを使わず .oxlintrc.json で明示的にルールを選ぶ場合 (native core baseline は適用しません):
{
"jsPlugins": ["@totto2727/oxlint"],
"rules": {
"rules/require-import-extension": "error",
"rules/consistent-import-extension": ["error", { "mode": "ts" }]
}
}JavaScript 出力の import には mode js、TypeScript ソース実行には mode ts を選びます。欠けた拡張子は自動推測できません。 force-ts-extension を2つの置換ルールと同時に有効にしないでください。
実行と確認
npx oxlint
npx oxlint --fixコミット前に診断と修正を確認します。自動修正を明記したルールのみがコードを変更します。 プリセットのルールはアプリケーションソースとテストファイルに同じように適用します。テスト専用のルール免除はありません。 本当に必要な境界例外だけに、-- と具体的な理由を持つ oxlint-disable-next-line を使います。 TypeScript、Effect、Oxlint の設定ドキュメントも参照してください。