mirror of https://github.com/thangisme/notes.git
148 lines
9.3 KiB
Markdown
148 lines
9.3 KiB
Markdown
# stylelint-scss
|
|
|
|
[](https://www.npmjs.com/package/stylelint-scss)
|
|
[](https://travis-ci.org/kristerkari/stylelint-scss)
|
|
[](https://ci.appveyor.com/project/kristerkari/stylelint-scss/branch/master)
|
|
[](https://coveralls.io/github/kristerkari/stylelint-scss?branch=master)
|
|
[](https://github.com/kristerkari/stylelint-scss/milestones/1.4.0)
|
|
|
|
A collection of SCSS specific linting rules for [stylelint](https://github.com/stylelint/stylelint) (in a form of a plugin).
|
|
|
|
## Purpose
|
|
|
|
stylelint by itself supports [SCSS syntax](http://stylelint.io/user-guide/css-processors/#parsing-non-standard-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`](http://stylelint.io/user-guide/rules/max-nesting-depth/), control the way [`@-rules`](http://stylelint.io/user-guide/rules/#at-rule) 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](http://stylelint.io/user-guide/about-rules/), testing and [so on](https://github.com/stylelint/stylelint/tree/master/docs/developer-guide)).
|
|
|
|
## Installation and usage
|
|
|
|
stylelint-scss is a plugin for [stylelint](http://stylelint.io/user-guide/), 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](https://github.com/stylelint/stylelint/blob/master/package.json#L32).
|
|
|
|
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`.
|
|
|
|
```json
|
|
{
|
|
"plugins": [
|
|
"stylelint-scss"
|
|
],
|
|
"rules": {
|
|
"scss/dollar-variable-pattern": "^foo",
|
|
"scss/selector-no-redundant-nesting-selector": true,
|
|
...
|
|
}
|
|
}
|
|
```
|
|
|
|
Please refer to [stylelint docs](http://stylelint.io/user-guide/) for the detailed info on using this linter.
|
|
|
|
## List of rules
|
|
|
|
Here are stylelint-scss' rules, grouped by the [*thing*](http://apps.workflower.fi/vocabs/css/en) they apply to (just like in [stylelint](http://stylelint.io/user-guide/about-rules/)).
|
|
|
|
Please also see the [example configs](./docs/examples/) for special cases.
|
|
|
|
### `@`-else
|
|
|
|
- [`at-else-closing-brace-newline-after`](./src/rules/at-else-closing-brace-newline-after/README.md): Require or disallow a newline after the closing brace of `@else` statements.
|
|
- [`at-else-closing-brace-space-after`](./src/rules/at-else-closing-brace-space-after/README.md): Require a single space or disallow whitespace after the closing brace of `@else` statements.
|
|
- [`at-else-empty-line-before`](./src/rules/at-else-empty-line-before/README.md): Require an empty line or disallow empty lines before `@`-else.
|
|
|
|
### `@`-extend
|
|
|
|
- [`at-extend-no-missing-placeholder`](./src/rules/at-extend-no-missing-placeholder/README.md): Disallow at-extends (`@extend`) with missing placeholders.
|
|
|
|
### `@`-function
|
|
|
|
- [`at-function-pattern`](./src/rules/at-function-pattern/README.md): Specify a pattern for Sass/SCSS-like function names.
|
|
|
|
### `@`-if
|
|
|
|
- [`at-if-closing-brace-newline-after`](./src/rules/at-if-closing-brace-newline-after/README.md): Require or disallow a newline after the closing brace of `@if` statements.
|
|
- [`at-if-closing-brace-space-after`](./src/rules/at-if-closing-brace-space-after/README.md): Require a single space or disallow whitespace after the closing brace of `@if` statements.
|
|
|
|
### `@`-import
|
|
|
|
- [`at-import-no-partial-leading-underscore`](./src/rules/at-import-no-partial-leading-underscore/README.md): Disallow leading underscore in partial names in `@import`.
|
|
- [`at-import-partial-extension-blacklist`](./src/rules/at-import-partial-extension-blacklist/README.md): Specify blacklist of disallowed file extensions for partial names in `@import` commands.
|
|
- [`at-import-partial-extension-whitelist`](./src/rules/at-import-partial-extension-whitelist/README.md): Specify whitelist of allowed file extensions for partial names in `@import` commands.
|
|
|
|
### `@`-mixin
|
|
|
|
- [`at-mixin-argumentless-call-parentheses`](./src/rules/at-mixin-argumentless-call-parentheses/README.md): Require or disallow parentheses in argumentless `@mixin` calls.
|
|
- [`at-mixin-pattern`](./src/rules/at-mixin-pattern/README.md): Specify a pattern for Sass/SCSS-like mixin names.
|
|
|
|
### `$`-variable
|
|
|
|
- [`dollar-variable-colon-newline-after`](./src/rules/dollar-variable-colon-newline-after/README.md): Require a newline after the colon in `$`-variable declarations.
|
|
- [`dollar-variable-colon-space-after`](./src/rules/dollar-variable-colon-space-after/README.md): Require a single space or disallow whitespace after the colon in `$`-variable declarations.
|
|
- [`dollar-variable-colon-space-before`](./src/rules/dollar-variable-colon-space-before/README.md): Require a single space or disallow whitespace before the colon in `$`-variable declarations.
|
|
- [`dollar-variable-empty-line-before`](./src/rules/dollar-variable-empty-line-before/README.md): Require a single empty line or disallow empty lines before `$`-variable declarations.
|
|
- [`dollar-variable-no-missing-interpolation`](./src/rules/dollar-variable-no-missing-interpolation/README.md): Disallow Sass variables that are used without interpolation with CSS features that use custom identifiers.
|
|
- [`dollar-variable-pattern`](./src/rules/dollar-variable-pattern/README.md): Specify a pattern for Sass-like variables.
|
|
|
|
### `%`-placeholder
|
|
|
|
- [`percent-placeholder-pattern`](./src/rules/percent-placeholder-pattern/README.md): Specify a pattern for `%`-placeholders.
|
|
|
|
### `//`-comment
|
|
|
|
- [`double-slash-comment-empty-line-before`](./src/rules/double-slash-comment-empty-line-before/README.md): Require or disallow an empty line before `//`-comments.
|
|
- [`double-slash-comment-inline`](./src/rules/double-slash-comment-inline/README.md): Require or disallow `//`-comments to be inline comments.
|
|
- [`double-slash-comment-whitespace-inside`](./src/rules/double-slash-comment-whitespace-inside/README.md): Require or disallow whitespace after the `//` in `//`-comments
|
|
|
|
### Declaration
|
|
|
|
- [`declaration-nested-properties`](./src/rules/declaration-nested-properties/README.md): Require or disallow properties with `-` in their names to be in a form of a nested group.
|
|
- [`declaration-nested-properties-no-divided-groups`](./src/rules/declaration-nested-properties-no-divided-groups/README.md): Disallow nested properties of the same "namespace" be divided into multiple groups.
|
|
|
|
### Media feature
|
|
|
|
- [`media-feature-value-dollar-variable`](./src/rules/media-feature-value-dollar-variable/README.md): Require a media feature value be a `$`-variable or disallow `$`-variables in media feature values.
|
|
|
|
### Operator
|
|
|
|
- [`operator-no-newline-after`](./src/rules/operator-no-newline-after/README.md): Disallow linebreaks after Sass operators.
|
|
- [`operator-no-newline-before`](./src/rules/operator-no-newline-before/README.md): Disallow linebreaks before Sass operators.
|
|
- [`operator-no-unspaced`](./src/rules/operator-no-unspaced/README.md): Disallow unspaced operators in Sass operations.
|
|
|
|
### Partial
|
|
|
|
- [`partial-no-import`](./src/rules/partial-no-import/README.md): Disallow non-CSS `@import`s in partial files.
|
|
|
|
### Selector
|
|
|
|
- [`selector-no-redundant-nesting-selector`](./src/rules/selector-no-redundant-nesting-selector/README.md): Disallow redundant nesting selectors (`&`).
|
|
|
|
## 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](https://github.com/stylelint/stylelint/blob/master/docs/developer-guide/rules.md)").
|
|
* 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](https://github.com/stylelint/stylelint)
|
|
* Spread the word.
|
|
|
|
We communicate via [issues](https://github.com/kristerkari/stylelint-scss/issues) and [pull requests](https://github.com/kristerkari/stylelint-scss/pulls).
|
|
|
|
There is also [stackoverflow](http://stackoverflow.com/questions/tagged/stylelint), which would be the preferred QA forum.
|
|
|
|
## Important documents
|
|
|
|
- [Changelog](./CHANGELOG.md)
|
|
- [Contributing](./CONTRIBUTING.md)
|
|
- [License](./LICENSE)
|