Skip to content

Latest commit

 

History

History
147 lines (100 loc) · 2.1 KB

File metadata and controls

147 lines (100 loc) · 2.1 KB

comment-empty-line-before

Require or disallow an empty line before comments.

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

If the comment is the very first node in a stylesheet then it is ignored. Inline comments are also ignored.

If you're using a custom syntax which support single-line comments with //, those are ignored as well.

Options

string: "always"|"never"

"always"

There must always be an empty line before comments.

The following patterns are considered warnings:

a {}
/* comment */

The following patterns are not considered warnings:

a {}

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

"never"

There must never be an empty before comments.

The following patterns are considered warnings:

a {}

/* comment */

The following patterns are not considered warnings:

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

Optional options

except: ["first-nested"]

Reverse the primary option for comments that are nested and the first child of their parent node.

For example, with "always":

The following patterns are considered warnings:

a {

  /* comment */
  color: pink;
}

The following patterns are not considered warnings:

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

ignore: ["stylelint-commands"]

Ignore comments that deliver commands to stylelint, e.g. /* stylelint-disable color-no-hex */.

For example, with "always":

The following patterns are considered warnings:

a {
  background: pink;
  /* not a stylelint command */
  color: #eee;
}

The following patterns are not considered warnings:

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

ignore: ["between-comments"]

Don't require an empty line between comments.

For example, with "always":

The following patterns are not considered warnings:

a {
  background: pink;

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

  /* comment */

  /* comment */
  color: #eee;
}