A collection of SCSS specific linting rules for stylelint (in a form of a plugin).
stylelint by itself supports SCSS syntax very well (as well as other preprocessors' syntaxes). Moreover, it introduces some specific rules that can be used to lint SCSS, e.g. to limit
nesting, control the way
@-rules are written. Yet stylelint is in general focused on standard CSS.
stylelint-scss introduces rules specific to SCSS syntax. That said, the rules from this plugin can be used with other syntaxes, like Less or some PostCSS syntaxes. That's why the rules' names are not tied to SCSS only (
at-function-pattern instead of
stylelint-scss is a plugin for stylelint, so it's meant to be used with it.
Node.js v4.2.1 or newer is required. That's because stylelint itself doesn't support Node.js versions below 4.
First, install stylelint-scss (and stylelint, if you haven't done so yet) via NPM:
npm install stylelint stylelint-scss
.stylelintrc.json config file (or open the existing one), add
stylelint-scss to the plugins array and the rules you need to the rules list. All rules from stylelint-scss need to be namespaced with
Please refer to stylelint docs for the detailed info on using this linter.
Please also see the example configs for special cases.
at-else-closing-brace-newline-after: Require or disallow a newline after the closing brace of
at-else-closing-brace-space-after: Require a single space or disallow whitespace after the closing brace of
at-else-empty-line-before: Require an empty line or disallow empty lines before
at-extend-no-missing-placeholder: Disallow at-extends (
@extend) with missing placeholders.
at-function-pattern: Specify a pattern for Sass/SCSS-like function names.
at-if-closing-brace-newline-after: Require or disallow a newline after the closing brace of
at-if-closing-brace-space-after: Require a single space or disallow whitespace after the closing brace of
at-import-no-partial-leading-underscore: Disallow leading underscore in partial names in
at-import-partial-extension-blacklist: Specify blacklist of disallowed file extensions for partial names in
at-import-partial-extension-whitelist: Specify whitelist of allowed file extensions for partial names in
at-mixin-argumentless-call-parentheses: Require or disallow parentheses in argumentless
at-mixin-pattern: Specify a pattern for Sass/SCSS-like mixin names.
dollar-variable-colon-newline-after: Require a newline after the colon in
dollar-variable-colon-space-after: Require a single space or disallow whitespace after the colon in
dollar-variable-colon-space-before: Require a single space or disallow whitespace before the colon in
dollar-variable-empty-line-before: Require a single empty line or disallow empty lines before
dollar-variable-no-missing-interpolation: Disallow Sass variables that are used without interpolation with CSS features that use custom identifiers.
dollar-variable-pattern: Specify a pattern for Sass-like variables.
percent-placeholder-pattern: Specify a pattern for
double-slash-comment-empty-line-before: Require or disallow an empty line before
double-slash-comment-inline: Require or disallow
//-comments to be inline comments.
double-slash-comment-whitespace-inside: Require or disallow whitespace after the
declaration-nested-properties: Require or disallow properties with
-in their names to be in a form of a nested group.
declaration-nested-properties-no-divided-groups: Disallow nested properties of the same "namespace" be divided into multiple groups.
media-feature-value-dollar-variable: Require a media feature value be a
$-variable or disallow
$-variables in media feature values.
operator-no-newline-after: Disallow linebreaks after Sass operators.
operator-no-newline-before: Disallow linebreaks before Sass operators.
operator-no-unspaced: Disallow unspaced operators in Sass operations.
partial-no-import: Disallow non-CSS
@imports in partial files.
selector-no-redundant-nesting-selector: Disallow redundant nesting selectors (
There work on the plugin's rules is still in progress, so if you feel like it, you're welcome to help out in any of these (the plugin follows stylelint guidelines so most part of this is based on its docs):
There is also stackoverflow, which would be the preferred QA forum.