https://github.com/suitcss/stylelint-suitcss
A collection of Stylelint plugins for SUIT CSS
https://github.com/suitcss/stylelint-suitcss
plugin stylelint suit-css
Last synced: about 1 year ago
JSON representation
A collection of Stylelint plugins for SUIT CSS
- Host: GitHub
- URL: https://github.com/suitcss/stylelint-suitcss
- Owner: suitcss
- License: mit
- Created: 2017-03-01T17:22:51.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2023-01-07T04:06:50.000Z (over 3 years ago)
- Last Synced: 2025-04-21T21:18:54.521Z (about 1 year ago)
- Topics: plugin, stylelint, suit-css
- Language: JavaScript
- Homepage:
- Size: 484 KB
- Stars: 21
- Watchers: 6
- Forks: 6
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# stylelint-suitcss
[](https://www.npmjs.com/package/stylelint-suitcss) [](https://github.com/suitcss/stylelint-suitcss/actions/workflows/ci.yml)
A collection of [stylelint](https://stylelint.io/) plugins for SUIT CSS.
## Installation
```
npm install stylelint-suitcss --save-dev
# or
yarn add stylelint-suitcss --dev
```
## Usage
Add `stylelint-suitcss` to your stylelint config plugins array, then add rules
you need to the `rules` object.
```js
// .stylelintrc
{
"plugins": [
"stylelint-suitcss"
],
"rules": {
"suitcss/custom-property-no-outside-root": true,
"suitcss/root-no-standard-properties": true,
"suitcss/selector-root-no-composition": true
}
}
```
## Available rules
* [`custom-property-no-outside-root`](./rules/custom-property-no-outside-root/README.md) - Disallow custom properties outside of `:root` rules.
* [`root-no-standard-properties`](./rules/root-no-standard-properties/README.md) - Disallow standard properties inside `:root` rules.
* [`selector-root-no-composition`](./rules/selector-root-no-composition/README.md) - Disallow the composition of `:root` in selectors.