@nuxtjs/stylelint-module

Nuxt.js用Stylelintモジュール

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

要件

stylelintがインストールされていることを確認する必要があります。

pnpmを使用する場合

pnpm add -D stylelint

または、yarnを使用する場合

yarn add -D stylelint

または、npmを使用する場合

npm install -D stylelint

注: 現在、このモジュールはviteを使用している場合にのみstylelintの最新バージョン16と互換性があり、webpackのサポートはまだ実装されていません（https://github.com/webpack-contrib/stylelint-webpack-plugin/issues/342を参照）。

セットアップ

プロジェクトに@nuxtjs/stylelint-moduleの依存関係を追加します

pnpmを使用する場合

pnpm add -D @nuxtjs/stylelint-module

または、yarnを使用する場合

yarn add -D @nuxtjs/stylelint-module

または、npmを使用する場合

npm install -D @nuxtjs/stylelint-module

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

export default {
  modules: [
    // Simple usage
    '@nuxtjs/stylelint-module',

    // With options
    ['@nuxtjs/stylelint-module', { /* module options */ }]
  ]
}

トップレベルオプションの使用

export default {
  modules: [
    '@nuxtjs/stylelint-module'
  ],
  stylelint: {
    /* module options */
  }
}

オプション

利用可能なオプションの完全なリストについては、stylelintのオプションを参照してください。これらのオプションは、stylelintに直接渡されます。

`cache`

型: Boolean
デフォルト: true

注: 実行時間を短縮するために、キャッシュはデフォルトで有効になっています。

`include`

型: String|Array[String]
デフォルト: [nuxt.options.srcDir.'/**/*.{css,scss,sass,less,styl,vue}']

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

`exclude`

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

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

`stylelintPath`

型: String
デフォルト: stylelint

リンティングに使用されるstylelintインスタンスへのパス。

`formatter`

型: Function
デフォルト: 'string'

結果をフォーマットするために使用するフォーマッタを指定します。

`lintOnStart`

型: Boolean
デフォルト: true

プロジェクトの起動時に一致するすべてのファイルもチェックします。遅すぎるため、慎重に有効にしてください。

`lintDirtyOnly`

型: Boolean
デフォルト: true

Stylelintの実行時に変更されたファイルのみをリンティングします。buildStartフックを除く。無効になっている場合は、includeオプションで指定されたすべてのファイルがリンティングされます。

`emitWarning`

型: Boolean
デフォルト: true

見つかった警告が出力されます。

`emitError`

型: Boolean
デフォルト: true

見つかったエラーが出力されます。

`failOnWarning`

型: Boolean
デフォルト: false

emitWarningに基づいて、警告がある場合にモジュールビルドを失敗させます。

`failOnError`

型: Boolean
デフォルト: true

emitErrorに基づいて、エラーがある場合にモジュールビルドを失敗させます。

貢献

CodeSandBoxを使用して、オンラインでこのモジュールに貢献できます。

またはローカルで

このリポジトリをクローンします
pnpm installを使用して依存関係をインストールします
pnpm dev:prepareを使用して開発サーバーを準備します
pnpm buildを使用してモジュールをビルドします
pnpm devを使用してプレイグラウンドを起動します

ライセンス

MITライセンス