命令列介面
用法
oxlint [-c=<./oxlintrc.json>] [PATH]...
基本組態
-c,--config=<./oxlintrc.json>— Oxlint 組態檔 (實驗性)
- 僅支援
.json副檔名 - 嘗試與 ESLint v8 的格式相容
--tsconfig=<./tsconfig.json>— TypeScripttsconfig.json路徑，用於讀取路徑別名和專案參考，以用於 import 外掛
允許/拒絕多個程式碼檢查
從命令列由左至右累積規則和類別。
例如 -D correctness -A no-debugger 或 -A all -D no-debugger。 類別如下：
correctness- 明顯錯誤或無用的程式碼 (預設)。suspicious- 極有可能錯誤或無用的程式碼。pedantic- 相當嚴格或偶爾出現誤判的程式碼檢查。style- 應該以更慣用的方式編寫的程式碼。nursery- 仍在開發中的新程式碼檢查。restriction- 阻止使用語言和函式庫功能的程式碼檢查。all- 上述除了 nursery 之外的所有類別。不會自動啟用外掛。
引數
-A,--allow=NAME— 允許規則或類別 (抑制程式碼檢查)-W,--warn=NAME— 拒絕規則或類別 (發出警告)-D,--deny=NAME— 拒絕規則或類別 (發出錯誤)
啟用外掛
--disable-react-plugin— 停用預設啟用的 react 外掛--disable-unicorn-plugin— 停用預設啟用的 unicorn 外掛--disable-oxc-plugin— 停用預設啟用的 oxc 獨有規則--disable-typescript-plugin— 停用預設啟用的 TypeScript 外掛--import-plugin— 啟用實驗性的 import 外掛並偵測 ESM 問題。建議與--tsconfig選項一起使用。--jsdoc-plugin— 啟用實驗性的 jsdoc 外掛並偵測 JSDoc 問題--jest-plugin— 啟用 Jest 外掛並偵測測試問題--vitest-plugin— 啟用 Vitest 外掛並偵測測試問題--jsx-a11y-plugin— 啟用 JSX-a11y 外掛並偵測無障礙問題--nextjs-plugin— 啟用 Next.js 外掛並偵測 Next.js 問題--react-perf-plugin— 啟用 React 效能外掛並偵測渲染效能問題--promise-plugin— 啟用 promise 外掛並偵測 promise 使用問題--node-plugin— 啟用 node 外掛並偵測 node 使用問題--security-plugin— 啟用 security 外掛並偵測安全性問題
修正問題
--fix— 盡可能修正問題。輸出中只會報告未修正的問題--fix-suggestions— 套用可自動修正的建議。可能會變更程式行為。--fix-dangerously— 套用危險的修正和建議。
忽略檔案
--ignore-path=PATH— 指定要用作 .eslintignore 的檔案--ignore-pattern=PAT— 指定要忽略的檔案模式 (除了 .eslintignore 中的檔案之外)支援的語法與 .eslintignore 和 .gitignore 檔案的語法相同。您應該將模式用引號括起來，以避免 shell 解釋 glob 模式
--no-ignore— 停用從 .eslintignore 檔案、--ignore-path標記和--ignore-pattern標記中排除檔案--symlinks— 追蹤符號連結。Oxlint 預設會忽略符號連結。
處理警告
--quiet— 停用警告報告，只會報告錯誤--deny-warnings— 確保警告產生非零的結束代碼--max-warnings=INT— 指定警告閾值，如果專案中存在太多警告級別的規則違規，則可以使用該閾值強制以錯誤狀態結束
輸出
-f,--format=ARG— 使用特定的輸出格式 (default, json, unix, checkstyle, github)
其他
--silent— 不顯示任何診斷--threads=INT— 要使用的執行緒數量。 設定為 1 以僅使用 1 個 CPU 核心--print-config— 此選項會輸出要使用的組態。 存在此選項時，不會執行程式碼檢查，只有與組態相關的選項才有效。
可用的位置項目：
PATH— 單一檔案、單一路徑或路徑清單
可用的選項：
--rules— 列出目前已註冊的所有規則-h,--help— 列印說明資訊-V,--version— 列印版本資訊