stylelint-scss

6.1.0 • Public • Published

stylelint-scss

npm version Build Status Coverage Status contributions welcome Downloads per month

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:

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.

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

@-each

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

@-else

@-extend

@-function

@-if

@-import

@-mixin

@-rule

@-use

$-variable

%-placeholder

//-comment

Block

Comment

Declaration

Dimension

Function

Map

Media feature

Operator

Partial

Property

Selector

Load

General / Sheet

Deprecated

These rules are deprecated — we won't fix bugs nor add options, and we will remove them in the next major release. We recommend you use a pretty printer (like Prettier) alongside Stylelint rather than these rules.

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 Eugeno
kristerkari dryoma rambleraptor XhmikosR ybiquitous Eugeno
joseph118 pamelalozano16 stof niksy kaysonwu srawlins
joseph118 pamelalozano16 stof niksy kaysonwu srawlins
pipopotamasu jhae-de OriR ntwb ricardogobbosouza jeddy3
pipopotamasu jhae-de OriR ntwb ricardogobbosouza jeddy3
kevindew thibaudcolas chimurai vseventer xboy2012 chalkygames123
kevindew thibaudcolas chimurai vseventer xboy2012 chalkygames123
FloEdelmann bjankord AndyOGo qmhc freezy-sk YodaDaCoda
FloEdelmann bjankord AndyOGo qmhc freezy-sk YodaDaCoda
wlewis-formative kersh AM-77 YozhikM sajadtorkamani paulgv
wlewis-formative kersh AM-77 YozhikM sajadtorkamani paulgv
nlydv manovotny keegan-lillo stormwarning jantimon guoyunhe
nlydv manovotny keegan-lillo stormwarning jantimon guoyunhe
G-Rath EvanHahn lithiumlron diego-codes Deimos Calme1709
G-Rath EvanHahn lithiumlron diego-codes Deimos Calme1709
SterlingVix
SterlingVix

Important documents

Package Sidebar

Install

npm i stylelint-scss

Weekly Downloads

2,346,896

Version

6.1.0

License

MIT

Unpacked Size

286 kB

Total Files

117

Last publish

Collaborators

  • kristerkari
  • jeddy3
  • dryoma