stylelint-scss


A collection of SCSS-specific linting rules for Stylelint (in a form of a plugin).

Purpose

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 scss-function-pattern).

The plugin follows Stylelint's guidelines (about rule names, testing and so on).

Installation and usage

This plugin is used in the stylelint-config-standard-scss shared config. We recommend using that shared config, rather than installing this plugin directly.

However, the plugin can still be used in you're crafting a config from the ground up. First, install stylelint-scss (and stylelint, if you haven't done so yet) via npm:

``sh
npm install stylelint stylelint-scss
`

Create the .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 scss.

`jsonc
{
"plugins": ["stylelint-scss"],
"rules": {
// recommended rules
"at-rule-no-unknown": null,
"scss/at-rule-no-unknown": true,
// ...
// any other rules you'd want to change e.g.
"scss/dollar-variable-pattern": "^foo",
"scss/selector-no-redundant-nesting-selector": true
}
}
`

Please refer to Stylelint docs for detailed info on using this linter.

List of rules

Here are stylelint-scss' rules, grouped by the _thing_ they apply to (just like in Stylelint).

Please also see the example configs for special cases.

$3

- at-each-key-value-single-line: This is a rule that checks for situations where users have done a loop using map-keys or map.keys and grabbed the value for that key inside of the loop.

$3

- at-else-closing-brace-newline-after: Require or disallow a newline after the closing brace of @else statements (Autofixable).
- at-else-closing-brace-space-after: Require a single space or disallow whitespace after the closing brace of @else statements (Autofixable).
- at-else-empty-line-before: Require an empty line or disallow empty lines before @-else (Autofixable).
- at-else-if-parentheses-space-before: Require or disallow a space before @else if parentheses (Autofixable).

$3

- at-extend-no-missing-placeholder: Disallow at-extends (@extend) with missing placeholders.

$3

- at-function-named-arguments: Require named parameters in SCSS function call rule.
- at-function-parentheses-space-before: Require or disallow a space before @function parentheses (Autofixable).
- at-function-pattern: Specify a pattern for Sass/SCSS-like function names.

$3

- at-if-closing-brace-newline-after: Require or disallow a newline after the closing brace of @if statements (Autofixable).
- at-if-closing-brace-space-after: Require a single space or disallow whitespace after the closing brace of @if statements (Autofixable).
- at-if-no-null: Disallow null in @if statements.

$3

- at-import-partial-extension-allowed-list: Specify a list of allowed file extensions for partial names in @import commands.
- at-import-partial-extension-disallowed-list: Specify a list of disallowed file extensions for partial names in @import commands.

$3

- at-mixin-argumentless-call-parentheses: Require or disallow parentheses in argumentless @mixin calls (Autofixable).
- at-mixin-named-arguments: Require named parameters in at-mixin call rule.
- at-mixin-no-risky-nesting-selector: Disallow risky nesting selectors within a mixin.
- at-mixin-parentheses-space-before: Require or disallow a space before @mixin parentheses (Autofixable).
- at-mixin-pattern: Specify a pattern for Sass/SCSS-like mixin names.

$3

- at-rule-conditional-no-parentheses: Disallow parentheses in conditional @ rules (if, elsif, while) (Autofixable).
- at-rule-no-unknown: Disallow unknown at-rules. Should be used instead of Stylelint's at-rule-no-unknown.

$3

- at-use-no-unnamespaced: Disallow @use without a namespace (i.e. @use "..." as *).
- at-use-no-redundant-alias: Disallow redundant namespace aliases (i.e. @use "foo" as foo).

$3

- dollar-variable-colon-newline-after: Require a newline after the colon in $-variable declarations (Autofixable).
- dollar-variable-colon-space-after: Require or disallow whitespace after the colon in $-variable declarations (Autofixable).
- dollar-variable-colon-space-before: Require a single space or disallow whitespace before the colon in $-variable declarations (Autofixable).
- dollar-variable-default: Require !default flag for $-variable declarations.
- dollar-variable-empty-line-after: Require a single empty line or disallow empty lines after $-variable declarations (Autofixable).
- dollar-variable-empty-line-before: Require a single empty line or disallow empty lines before $-variable declarations (Autofixable).
- dollar-variable-first-in-block: Require for variables to be put first in a block (a rule or in root).
- dollar-variable-no-missing-interpolation: Disallow Sass variables that are used without interpolation with CSS features that require interpolation (Autofixable).
- dollar-variable-no-namespaced-assignment: Disallow assignment to namespaced Sass variables.
- dollar-variable-pattern: Specify a pattern for Sass-like variables.

$3

- percent-placeholder-pattern: Specify a pattern for %-placeholders.

$3

- double-slash-comment-empty-line-before: Require or disallow an empty line before //-comments (Autofixable).
- double-slash-comment-inline: Require or disallow //-comments to be inline comments.
- double-slash-comment-whitespace-inside: Require or disallow whitespace after the // in //-comments (Autofixable).

$3

- block-no-redundant-nesting: Disallow nesting a single block if it could be merged with its parent block.

$3

- comment-no-empty: Disallow empty comments.
- comment-no-loud: Disallow /*-comments.

$3

- 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" to be divided into multiple groups.
- declaration-property-value-no-unknown: Disallow unknown values for properties within declarations.

$3

- dimension-no-non-numeric-values: Disallow non-numeric values when interpolating a value with a unit.

$3

- function-calculation-no-interpolation: Disallow interpolation in calc(), clamp(), min(), and max() functions.
- function-color-channel: Encourage the use of the color.channel function over related deprecated color functions.
- function-color-relative: Encourage the use of the scale-color function over regular color functions.
- function-disallowed-list: Specify a list of disallowed functions. Should be used instead of Stylelint's function-disallowed-list.
- function-no-unknown: Disallow unknown functions. Should be used instead of Stylelint's function-no-unknown.
- function-quote-no-quoted-strings-inside: Disallow quoted strings inside the quote function (Autofixable).
- function-unquote-no-unquoted-strings-inside: Disallow unquoted strings inside the unquote function (Autofixable).

$3

- map-keys-quotes: Require quoted keys in Sass maps.

$3

- media-feature-value-dollar-variable: Require a media feature value be a $-variable or disallow $-variables in media feature values.

$3

- 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.

$3

- partial-no-import: Disallow non-CSS @imports in partial files.

$3

- property-no-unknown: Disallow unknown properties, including nested properties. Should be used instead of Stylelint's property-no-unknown.

$3

- selector-class-pattern: Specify a pattern for class selectors. Should be used instead of Stylelint's selector-class-pattern.
- selector-nest-combinators: Require or disallow nesting of combinators in selectors.
- selector-no-redundant-nesting-selector: Disallow redundant nesting selectors (&).
- selector-no-union-class-name: Disallow union class names with the parent selector (&).

$3

- load-no-partial-leading-underscore: Disallow leading underscore in partial names in @import, @use, @forward, and meta.load-css $url parameter.
- load-partial-extension: Require or disallow extension in @import, @use, @forward, and [meta.load-css] commands (Autofixable).

$3

- no-dollar-variables: Disallow dollar variables within a stylesheet.
- no-duplicate-dollar-variables: Disallow duplicate dollar variables within a stylesheet.
- no-duplicate-load-rules: Disallow duplicate @import, @use and @forward rules.
- no-duplicate-mixins: Disallow duplicate mixins within a stylesheet.
- no-global-function-names: Disallows the use of global function names, as these global functions are now located inside built-in Sass modules.
- no-unused-private-members`: Disallow unused private members such as functions, mixins, variables or placeholder selectors.

Help out

The work on the plugin's rules is still in progress, so if you feel like it, you're welcome to help out with any of these (the plugin follows Stylelint guidelines so most of this is based on its docs):

- Create, enhance, and debug rules (see Stylelint's guide to "Working on rules").
- Improve documentation.
- Chime in on any open issue or pull request.
- Open new issues about your ideas on new rules, or for how to improve the existing ones, and pull requests to show us how your idea works.
- Add new tests to absolutely anything.
- Work on improving performance of rules.
- Contribute to Stylelint
- Spread the word.

We communicate via issues and pull requests.

There is also StackOverflow, which would be the preferred QA forum.

Contributors

Thanks goes to these wonderful people:

kristerkari	dryoma	rambleraptor	XhmikosR	ybiquitous	pamelalozano16

Eugeno	joseph118	jhae-de	stof	niksy	kaysonwu

FloEdelmann	srawlins	pipopotamasu	jeddy3	ricardogobbosouza	thibaudcolas

ntwb	OriR	evilebottnawi	kevindew	chimurai	vseventer

xboy2012	chalkygames123	bjankord	AndyOGo	MorevM	manovotny

nlydv	01taylop	paulgv	sajadtorkamani	YozhikM	AM-77

kersh	wlewis-formative	YodaDaCoda	Yizack	freezy-sk	qmhc

QDyanbing	keegan-lillo	stormwarning	cvx	jantimon	guoyunhe

G-Rath	EvanHahn	lithiumlron	diego-codes	davidwarrington	Deimos

Calme1709	AsfalothDE	alexander-turner	SterlingVix

Important documents

- Changelog
- Contributing
- License