@nuxtjs/eslint-module
Nuxt 的 ESLint 模組
注意： 此分支適用於Nuxt 3 或 Nuxt Bridge 相容模組。請查看 nuxt2 分支 以取得 Nuxt 2 支援。
需求條件
您需要確保已安裝 eslint >= 7
使用 pnpm
pnpm add -D eslint
或使用 yarn
yarn add -D eslint
或使用 npm
npm install -D eslint
設定
- 將
@nuxtjs/eslint-module依賴項新增至您的專案
使用 pnpm
pnpm add -D @nuxtjs/eslint-module
或使用 yarn
yarn add -D @nuxtjs/eslint-module
或使用 npm
npm install -D @nuxtjs/eslint-module
- 將
@nuxtjs/eslint-module新增至nuxt.config.ts的modules區段
export default defineNuxtConfig({
modules: [
// Simple usage
'@nuxtjs/eslint-module',
// With options
['@nuxtjs/eslint-module', { /* module options */ }]
]
})
使用頂層選項
export default defineNuxtConfig({
modules: [
'@nuxtjs/eslint-module'
],
eslint: {
/* module options */
}
})
選項
您可以傳遞 eslint 選項。
請注意，您提供的 config 選項將會傳遞至 ESLint 類別。這與您在 package.json 或 .eslintrc 中指定的選項組不同。請參閱 eslint 文件 以了解更多詳細資訊。
cache
- 類型：
Boolean - 預設值：
true
注意：快取預設為啟用，以減少執行時間。
include
- 類型：
String|Array[String] - 預設值：
[nuxt.options.srcDir.'/**/*.{js,jsx,ts,tsx,vue}']
指定目錄、檔案或 glob 模式。
exclude
- 類型：
Array[String] - 預設值：
['**/node_modules/**', nuxt.options.buildDir]
指定要排除的檔案和/或目錄。
eslintPath
- 類型：
String - 預設值：
eslint
將用於 linting 的 eslint 實例路徑。
formatter
- 類型：
String|Function - 預設值：
'stylish'
接受一個函數，該函數將有一個參數：eslint 訊息（物件）的陣列。該函數必須將輸出作為字串傳回。您可以使用官方的 eslint formatters。
lintOnStart
- 類型：
Boolean - 預設值：
true
在專案啟動時檢查所有匹配的檔案，速度較慢，請謹慎開啟。
emitWarning
- 類型：
Boolean - 預設值：
true
找到的警告將會印出。
emitError
- 類型：
Boolean - 預設值：
true
找到的錯誤將會印出。
failOnWarning
- 類型：
Boolean - 預設值：
false
如果根據 emitWarning 存在任何警告，將導致模組建置失敗。
failOnError
- 類型：
Boolean - 預設值：
false
如果根據 emitError 存在任何錯誤，將導致模組建置失敗。
貢獻
您可以使用 CodeSandBox 在線上為此模組貢獻
或在本機端
- 複製此儲存庫
- 使用
pnpm install安裝依賴項 - 使用
pnpm dev:prepare準備開發伺服器 - 使用
pnpm build建置模組 - 使用
pnpm dev啟動 Playground
授權條款
版權所有 (c) Nuxt Community