功能標誌
ESLint 將實驗性與未來會造成重大變更的功能置於功能標誌之後,讓使用者選擇加入他們想要的功能。在以下情況使用標誌:
- 當功能為實驗性且尚未準備好讓所有人啟用時。
- 當功能為重大變更,將在下一個主要版本中正式合併,但使用者可以在下一個主要版本之前選擇加入該功能時。
標誌前綴
標誌的前綴表示其狀態
unstable_
表示該功能為實驗性,且在該功能穩定之前實作可能會變更。這是一個「使用風險自負」的功能。v##_
表示該功能已穩定,並將在下一個主要版本中提供。例如,v10_some_feature
表示這是一個將在 ESLint v10.0.0 中正式發佈的重大變更。這些標誌會在每個主要版本發佈時移除。
如果功能是非重大變更,則可能會在沒有主要版本發佈的情況下,從不穩定狀態移至穩定狀態。
啟用中的標誌
目前 ESLint 中可以使用以下標誌。
標誌 | 描述 |
---|---|
test_only | 僅用於測試。 |
unstable_config_lookup_from_file | 從正在檢查的檔案查詢 eslint.config.js。 |
unstable_ts_config | 啟用 TypeScript 設定檔。 |
停用中的標誌
以下標誌曾經使用過,但不再啟用。
標誌 | 描述 |
---|---|
test_only_old | 僅用於測試。 |
如何使用功能標誌
由於功能標誌是嚴格的選擇加入機制,因此您需要手動啟用您想要的標誌。
使用 CLI 啟用功能標誌
在命令列上,您可以使用 --flag
選項指定功能標誌。您可以指定任意數量的標誌
npx eslint --flag flag_one --flag flag_two file.js
使用 API 啟用功能標誌
當使用 API 時,您可以將 flags
陣列傳遞給 ESLint
和 Linter
類別
const { ESLint, Linter } = require("eslint");
const eslint = new ESLint({
flags: ["flag_one", "flag_two"]
});
const linter = new Linter({
flags: ["flag_one", "flag_two"]
});
在 VS Code 中啟用功能標誌
若要在編輯器的 VS Code ESLint 擴充功能中啟用標誌,請在您的 settings.json
檔案中的 eslint.options
設定中指定您想要的標誌
{
"eslint.options": { "flags": ["flag_one", "flag_two"] }
}
若要在 lint 工作的 VS Code ESLint 擴充功能中啟用標誌,請指定 eslint.lintTask.options
設定
{
"eslint.lintTask.options": "--flag flag_one --flag flag_two ."
}