Skip to content

README.md

Latest commit

 

History

History
140 lines (112 loc) · 2.6 KB

README.md

File metadata and controls

140 lines (112 loc) · 2.6 KB

stylelint-disable-reason

Require a reason comment before or after stylelint-disable comments.

a {
  /* stylelint-disable no-browser-hacks */
  /* Need for IE 6 */                      /*←*/
  _display: block;                         /*↑*/
  /* stylelint-enable no-browser-hacks */  /*↑*/
}                                          /*↑*/
/**                                          ↑
*                          This reason comment */

Options

string: "always-before"|"always-after"

"always-before"

There must always be a reason comment before the stylelint-disable comment.

The following patterns are considered warnings:

a {
  /* stylelint-disable no-browser-hacks */
  _display: block;
  /* stylelint-enable no-browser-hacks */
}
a {
  /* stylelint-disable no-browser-hacks */
  /* Need for IE 6 */
  _display: block;
  /* stylelint-enable no-browser-hacks */
}
a {} /* stylelint-disable-line block-no-empty */
a {
  _display: block; /* stylelint-disable-line block-no-empty */
}

The following patterns are not considered warnings:

a {
  /* Reason for disable */
  /* stylelint-disable no-browser-hacks */
  _display: block;
  /* stylelint-enable no-browser-hacks */
}
a {} /* Reason for disable */ /* stylelint-disable-line block-no-empty */
a {
  _display: block; /* Reason for disable */ /* stylelint-disable-line no-browser-hacks */
}
a {
  /* Reason for disable */
  _display: block; /* stylelint-disable-line no-browser-hacks */
}

"always-after"

There must always be a reason comment after the stylelint-disable disable comment.

The following patterns are considered warnings:

a {
  /* stylelint-disable no-browser-hacks */
  _display: block;
  /* stylelint-enable no-browser-hacks */
}
a {
  /* Need for IE 6 */
  /* stylelint-disable no-browser-hacks */
  _display: block;
  /* stylelint-enable no-browser-hacks */
}
a {} /* stylelint-disable-line block-no-empty */
a {
  _display: block; /* stylelint-disable-line no-browser-hacks */
}

The following patterns are not considered warnings:

a {
  /* stylelint-disable no-browser-hacks */
  /* Need for IE 6 */
  _display: block;
  /* stylelint-enable no-browser-hacks */
}
a {} /* stylelint-disable-line block-no-empty */ /* Reason for disable */
a {
  _display: block; /* stylelint-disable-line no-browser-hacks */ /* Reason for disable */
}
a {
  _display: block; /* stylelint-disable-line no-browser-hacks */
  /* Reason for disable */
}