@nuxtjs/stylelint-module

Nuxt 用 Stylelint モジュール。エラーを回避し、スタイル規約を強制するのに役立つ、強力でモダンなリンターです。

179K ダウンロード•73 スター•v5.2.1

ricardogobbosouza

@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

セットアップ

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

npx nuxi@latest module add stylelint

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

Lint に使用される stylelint インスタンスへのパス。

`formatter`

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

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

`lintOnStart`

タイプ: Boolean
デフォルト: true

プロジェクト開始時にすべての一致するファイルをチェックします。遅すぎるため、慎重にオンにしてください。

`lintDirtyOnly`

タイプ: Boolean
デフォルト: true

ビルド開始フックを除き、Stylelint の実行時に変更されたファイルのみを Lint します。無効にすると、include オプションで指定されたすべてのファイルが Lint されます。

`emitWarning`

タイプ: Boolean
デフォルト: true

見つかった警告が表示されます。

`emitError`

タイプ: Boolean
デフォルト: true

見つかったエラーが表示されます。

`failOnWarning`

ビルダー: webpack // webpack ビルダーでのみ動作します
タイプ: Boolean
デフォルト: false

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

`failOnError`

ビルダー: webpack // webpack ビルダーでのみ動作します
タイプ: Boolean
デフォルト: true

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

コントリビューション

このモジュールには CodeSandBox でオンラインで貢献できます

またはローカルで

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

ライセンス

MITライセンス