@nuxtjs/eslint-module

Nuxt用ESLintモジュール

498.6Kダウンロード•168スター•v4.1.0

ricardogobbosouza

@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

@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オプションを渡すことができます。

提供された設定オプションは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

Lintingに使用されるeslintインスタンスへのパス。

`formatter`

タイプ: String|Function
デフォルト: 'stylish'

1つの引数（eslintメッセージの配列（オブジェクト））を持つ関数を受け入れます。この関数は出力を文字列として返す必要があります。公式の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ライセンス