偵錯您的設定
ESLint 會根據您的設定檔和命令列選項,為每個要檢查的檔案建立設定。設定檔越大,就越難確定為什麼檔案沒有按照預期的方式進行檢查。為了幫助您偵錯設定,ESLint 提供了幾個工具。
在偵錯模式下執行 CLI
使用時機: 您不確定是否正在讀取正確的設定檔。如果您的同一個專案中有多個設定檔,就可能會發生這種情況。
處理方法: 使用 --debug
命令列標誌執行 ESLint,並傳遞要檢查的檔案,如下所示:
npx eslint --debug file.js
這會將 ESLint 的所有偵錯資訊輸出到主控台。您應該將此輸出複製到檔案中,然後搜尋 eslint.config.js
以查看載入了哪個檔案。以下是一些範例輸出:
eslint:eslint Using file patterns: bin/eslint.js +0ms
eslint:eslint Searching for eslint.config.js +0ms
eslint:eslint Loading config from C:\Users\nzakas\projects\eslint\eslint\eslint.config.js +5ms
eslint:eslint Config file URL is file:///C:/Users/nzakas/projects/eslint/eslint/eslint.config.js +0ms
列印檔案的已計算設定
使用時機: 您不確定為什麼程式碼檢查沒有產生預期的結果,可能是因為您的規則設定看起來沒有被遵守,或者使用了錯誤的語言選項。
處理方法: 使用 --print-config
命令列標誌執行 ESLint,並傳遞要檢查的檔案,如下所示:
npx eslint --print-config file.js
這會輸出檔案的已計算設定的 JSON 表示法,例如:
{
"linterOptions": {
"reportUnusedDisableDirectives": 1
},
"language": "@/js",
"languageOptions": {
"sourceType": "module",
"ecmaVersion": "latest"
},
"plugins": [
"@"
],
"rules": {
"prefer-const": 2
}
}
使用設定檢閱器
使用時機: 您不確定設定檔中的某些設定物件是否與給定的檔案名稱匹配。
處理方法: 使用 --inspect-config
命令列標誌執行 ESLint,並傳遞要檢查的檔案,如下所示:
npx eslint --inspect-config
這會透過安裝並啟動 @eslint/config-inspector
來啟動設定檢閱器。然後,您可以輸入有問題的檔案名稱,以查看將會套用哪些設定物件。
設定檢閱器還會顯示規則何時被棄用、您正在使用的可用規則數量等等。