Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 400,000 packages pre-installed, including stylelint-scss with all npm packages installed. Try it out:

require("stylelint/package.json"); // stylelint is a peer dependency. var stylelintScss = require("stylelint-scss")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

stylelint-scss v3.11.1

A collection of SCSS specific rules for stylelint

stylelint-scss

NPM version Build Status Build status Coverage Status contributions welcome Downloads per month Greenkeeper badge

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

stylelint-scss is a plugin for stylelint, so it's meant to be used with it.

Node.js v6 or newer is required. That's because stylelint itself doesn't support Node.js versions below 6.

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": {
    "scss/dollar-variable-pattern": "^foo",
    "scss/selector-no-redundant-nesting-selector": true,
    ...
  }
}

Please refer to stylelint docs for the 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 and grabbed the value for that key inside of the loop.

@-else

@-extend

@-function

@-if

@-import

@-mixin

@-rule

$-variable

%-placeholder

//-comment

Comment

Declaration

Dimension

Function

Map

Media feature

Operator

Partial

Selector

General / Sheet

Help out

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):

  • 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 pipopotamasu evilebottnawi OriR
kristerkari dryoma rambleraptor pipopotamasu evilebottnawi OriR
ntwb ricardogobbosouza thibaudcolas AndyOGo niksy lxsymington
ntwb ricardogobbosouza thibaudcolas AndyOGo niksy lxsymington
keegan-lillo Deimos lithiumlron jantimon stormwarning diego-codes
keegan-lillo Deimos lithiumlron jantimon stormwarning diego-codes
manovotny YozhikM YodaDaCoda freezy-sk jeddy3
manovotny YozhikM YodaDaCoda freezy-sk jeddy3

Important documents

RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free