本文へスキップ

comment-empty-line-before

コメントの前に空行を要求または禁止します。

a {}
              /* ← */
/* comment */ /* ↑ */
/**              ↑
*        This line */

このルールは以下を無視します。

  • ソースコードの最初のノードであるコメント
  • 同一行コメント
  • // を用いたシングルラインコメント（カスタム構文でサポートされている場合）
  • セレクタと値リスト内のコメント

このルールによって報告される問題のすべてを自動的に修正するには、fix オプション を使用できます。

オプション​

string: "always"|"never"

"always"​

コメントの前に必ず空行が必要です。

次のパターンは問題とみなされます。

a {}
/* comment */

次のパターンは問題とみなされません。

a {}

/* comment */
a {} /* comment */

"never"​

コメントの前に空行があってはなりません。

次のパターンは問題とみなされます。

a {}

/* comment */

次のパターンは問題とみなされません。

a {}
/* comment */
a {} /* comment */

オプションのセカンダリオプション​

except: ["first-nested"]​

ネストされており、親ノードの最初の子であるコメントについて、主要なオプションを反転します。

例："always"の場合

次のパターンは問題とみなされます。

a {

  /* comment */
  color: pink;
}

次のパターンは問題とみなされません。

a {
  /* comment */
  color: pink;
}

ignore: ["after-comment", "stylelint-commands"]​

"after-comment"​

別のコメントに続くコメントを無視します。

例："always"の場合

次のパターンは問題とみなされません。

a {
  background: pink;

  /* comment */
  /* comment */
  color: #eee;
}
a {
  background: pink;

  /* comment */

  /* comment */
  color: #eee;
}

"stylelint-commands"​

設定コメント（例：/* stylelint-disable color-no-hex */）を無視します。

例："always"の場合

次のパターンは問題とみなされます。

a {
  background: pink;
  /* not a configuration comment */
  color: #eee;
}

次のパターンは問題とみなされません。

a {
  background: pink;
  /* stylelint-disable color-no-hex */
  color: pink;
}

ignoreComments: ["/regex/", /regex/, "string"]​

指定された正規表現または文字列と一致するコメントを無視します。

例："always"と指定した場合

["/^ignore/", "string-ignore"]

次のパターンは問題とみなされません。

:root {
  background: pink;
  /* ignore this comment because of the regex */
  color: pink;
}
:root {
  background: pink;
  /* string-ignore */
  color: pink;
}