Zenn
🤖

stylelintユーザガイドーコードの無視

に公開
CSS
Sass
Scss
tech

内容の目的

本内容は、Stylelintユーザガイドーコードの無視 を翻訳し、個人活用のために整理しています。

<file name=0 path="stylelint-userguide-ignore-code.md"># コードの無視

以下のことができます：

  • ファイルの一部を無視する
  • ファイル全体を無視する

ファイルの一部

CSS内の設定コメントを使って、一時的にルールをオフにできます。

例えば、スコープなしの無効化コメントで全てのルールをオフにすることができます：

/* stylelint-disable */
a {}
/* stylelint-enable */

または、スコープ付きの無効化コメントで個別のルールをオフにすることもできます：

/* stylelint-disable selector-max-id, declaration-no-important */
#id {
  color: pink !important;
}
/* stylelint-enable selector-max-id, declaration-no-important */

個別の行に対して /* stylelint-disable-line */ コメントでルールをオフにすることもでき、その後に明示的に再有効化する必要はありません：

#id { /* stylelint-disable-line */
  color: pink !important; /* stylelint-disable-line declaration-no-important */
}

また、次の行のみ に対して /* stylelint-disable-next-line */ コメントでルールをオフにすることもでき、その後に明示的に再有効化する必要はありません：

#id {
  /* stylelint-disable-next-line declaration-no-important */
  color: pink !important;
}

Stylelintは複雑で重複する無効化と再有効化のパターンをサポートしています：

/* stylelint-disable */
/* stylelint-enable foo */
/* stylelint-disable foo */
/* stylelint-enable */
/* stylelint-disable foo, bar */
/* stylelint-disable baz */
/* stylelint-enable baz, bar */
/* stylelint-enable foo */

[!警告]
標準外の構文コメント（例：// stylelint-disable）内の設定コマンドは最小限にしかサポートされていません。
これらはセレクターや値リストの外で見つかった場合にのみ動作します。

コメントの末尾に説明を付け加えることもできます。ハイフン2つの後に記述します：

/* stylelint-disable -- Stylelintを無効化する理由。 */
/* stylelint-disable foo -- fooルールを無効化する理由。 */
/* stylelint-disable foo, bar -- fooとbarルールを無効化する理由。 */

[!警告]
ハイフンの両側にスペースが必要です。

ファイル全体

特定のファイルを無視するには、.stylelintignore ファイルを使うことができます。例えば：

vendor/**/*.css

.stylelintignore ファイル内のパターンは .gitignore の構文 に準拠している必要があります。（内部的には node-ignore がパターンを解析しています。） .stylelintignore 内のパターンは常に process.cwd() を基準に解析されます。

Stylelintは process.cwd() にある .stylelintignore ファイルを探します。また、CLIの --ignore-path オプションやJSの ignorePath オプションを使って、無視パターンファイルのパス（絶対または process.cwd() からの相対）を指定することもできます。

便利なことに、もし .gitignore ファイルが既に存在する場合は、それを .stylelintignore の代わりに使うこともできます。例えば：

stylelint "*.css" --ignore-path .gitignore

あるいは、設定オブジェクト内に ignoreFiles プロパティ を追加することもできます。
</file>

目次に戻る

Discussion