@nuxtjs/eslint-module

Nuxt 用 ESLint モジュール

**注記:** このブランチは **Nuxt 3** または **Nuxt Bridge** と互換性のあるモジュールです。**Nuxt 2** のサポートについては、nuxt2 ブランチを参照してください。

要件

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

nuxt.config.ts の modules セクションに @nuxtjs/eslint-module を追加します。

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}']

ディレクトリ、ファイル、またはグロブを指定します。

`exclude`

型: Array[String]
デフォルト: ['**/node_modules/**', nuxt.options.buildDir]

除外するファイルとディレクトリを指定します。

`eslintPath`

型: String
デフォルト: eslint

Lint に使用する eslint インスタンスへのパス。

`formatter`

型: String|Function
デフォルト: 'stylish'

ESLint メッセージ（オブジェクト）の配列を1つの引数として持つ関数を受け入れます。関数は、文字列として出力を返す必要があります。公式のESLint フォーマッタを使用できます。

`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 を使用してプレイグラウンドを起動します。

ライセンス

MIT ライセンス