メインコンテンツへスキップ

コマンドラインインターフェース (CLI)

Stylelint はコマンドラインで使用できます。例:

npx stylelint "**/*.css"

ファイル glob は引用符で囲む必要があります。

npm scripts を使用している場合は、引用符をエスケープする必要があります。

{
  "scripts": {
    "lint": "stylelint \"**/*.css\""
  }
}

CLI ドキュメントを印刷するには、npx stylelint --help を使用します。

オプション​

CLI は以下を受け入れます。

--allow-empty-input, --aei​

glob パターンがどのファイルにも一致しない場合、プロセスはエラーをスローせずに終了します。詳細情報。

--cache-location​

キャッシュの場所へのファイルまたはディレクトリのパス。詳細情報。

--cache-strategy​

変更されたファイルを検出するためにキャッシュが使用する戦略。「metadata」または「content」のいずれかを選択できます。詳細情報。

--cache​

処理済みファイルの結果を保存して、Stylelint が変更されたファイルのみを操作するようにします。デフォルトでは、キャッシュは process.cwd() の ./.stylelintcache に保存されます。詳細情報。

--color, --no-color​

カラーの有効/無効を強制します。

--config-basedir​

"extends"、"plugins"、および "customSyntax" を定義する相対パスが *相対的になる* ディレクトリへの絶対パス。これらの値が相対パスの場合にのみ必要です。詳細情報。

--config, -c​

設定オブジェクトを含む JSON、YAML、または JS ファイルへのパス。詳細情報。

--custom-syntax​

コードで使用するカスタム構文を指定します。詳細情報。

--disable-default-ignores, --di​

デフォルトの無視を無効にします。Stylelint は node_modules の内容を自動的に無視しません。詳細情報。

--fix​

可能な場合は、ルールによって報告された問題を自動的に修正します。詳細情報。

--formatter, -f | --custom-formatter​

結果をフォーマットするフォーマッタを指定します。詳細情報。

--globbyOptions, --go​

globby に渡される JSON 形式のオプション。詳細情報。

--ignore-disables, --id​

stylelint-disable (例: /* stylelint-disable block-no-empty */) コメントを無視します。詳細情報。

--ignore-path, -i​

無視するファイルを記述するパターンを含むファイルへのパス。パスは絶対パスまたは process.cwd() に対する相対パスにすることができます。複数のパスを指定するためにオプションを繰り返すことができます。デフォルトでは、Stylelint は process.cwd() で .stylelintignore を検索します。詳細情報。

--ignore-pattern, --ip​

無視するファイルのパターン (.stylelintignore のパターンに加えて)。

--max-warnings, --mw​

受け入れられる警告の数に制限を設定します。詳細情報。

--output-file, -o​

レポートを書き込むファイルへのパス。Stylelint は、標準出力に加えて、指定された filename にレポートを出力します。

--print-config​

指定された入力パスの設定を出力します。glob はサポートされていません。

--quiet, -q​

"error" レベルの重大度を持つルールの問題のみを登録します ("warning" レベルは無視します)。詳細情報。

--quiet-deprecation-warnings​

非推奨の警告を無視します。詳細情報。

--report-descriptionless-disables, --rdd​

説明のない stylelint-disable コメントのレポートを作成します。詳細情報。

--report-invalid-scope-disables, --risd​

設定オブジェクト内に存在しないルールに使用された stylelint-disable コメントのレポートを作成します。詳細情報。

--report-needless-disables, --rd​

コードベースをクリーンアップして、目的にかなう stylelint-disable コメントのみを保持するレポートを作成します。詳細情報。

--stdin-filename​

入力に割り当てるファイル名。詳細情報。

--stdin​

空の場合でも、stdin 入力を受け入れます。

--version, -v​

現在インストールされている Stylelint のバージョンを表示します。

使用例​

CLI は、ファイル glob または process.stdin のいずれかを入力として予期します。整形された結果を process.stdout に出力します。

ファイル glob は引用符で囲む必要があります。

例 A - 再帰的​

foo ディレクトリ内のすべての .css ファイルを再帰的にリントします。

stylelint "foo/**/*.css"

例 B - 複数のファイル拡張子​

すべての .css、.scss、および .sass ファイルをリントします。

stylelint "**/*.{css,scss,sass}"

例 C - stdin​

stdin をリントします。

echo "a { color: pink; }" | stylelint

例 D - 否定​

入力 glob で否定を使用して、docker サブフォルダー内を除くすべての .css ファイルをリントします。

stylelint "**/*.css" "!**/docker/**"

例 E - キャッシュ​

処理された .scss ファイル foo ディレクトリをキャッシュします。

stylelint "foo/**/*.scss" --cache --cache-location "/Users/user/.stylelintcache/"

例 F - レポートの書き込み​

foo ディレクトリ内のすべての .css ファイルをリントし、出力を myTestReport.txt に書き込みます。

stylelint "foo/*.css" --output-file myTestReport.txt

例 G - 設定の指定​

bar/mySpecialConfig.json を設定として使用して、foo ディレクトリおよびそのサブディレクトリ内のすべての .css ファイルをリントします。

stylelint "foo/**/*.css" --config bar/mySpecialConfig.json

例 H - カスタム構文の使用​

カスタム構文を使用して foo ディレクトリ内のすべての .css ファイルを再帰的にリントします。

stylelint "foo/**/*.css" --custom-syntax path/to/my-custom-syntax.js

例 I - 成功時に出力​

実行が成功した場合の出力を確認します。

stylelint -f verbose "foo/**/*.css"

例 J - 設定の出力​

指定された入力ファイルに使用される設定を出力します。

stylelint test.css --print-config

例 K - レポートを別のコマンドにパイプ処理する​

パイプ処理を使用してレポートを別のコマンドの入力として使用します。

stylelint -f json "*.css" 2>&1 | jq '[.[] | .warnings | length] | add'

終了コード​

CLIは以下の終了コードでプロセスを終了できます。

  • 1 - 致命的なエラー
  • 2 - リンターの問題
  • 64 - CLIの無効な使用
  • 78 - 無効な設定ファイル