@loadsmart/stylelint-config
v1.2.1
Published
A shareable default Stylelint config for ease of use in projects
Downloads
15
Readme
stylelint-config-loadsmart
A default configuration for Stylelint to be used on all projects that have CSS code in the company (or whoever wants to use it).
Usage
- Install stylelint with (preferably as a dev dependency):
# with yarn
yarn add -D stylelint
# with npm
npm install --save-dev stylelint
- Install this config preset (also preferably as a dev dependency):
# with yarn
yarn add -D @loadsmart/stylelint-config
# with npm
npm install --save-dev @loadsmart/stylelint-config
- Extend it in your
.stylelintrc.*
file like so:
{
"...": "hide other properties for brevity",
"extends": ["...", "@loadsmart/stylelint-config"],
}
Keep in mind that rules that come last in the array will have higher priority and override the others that came before it.
It is recommended to have this ruleset in the first spot, and project specific rule sets after it (which should be kept to a minimum ideally).
About this preset
This preset includes a few of the more important presets for stylelint and should be considered the standard for Loadsmart.
This preset includes/extends:
And uses the following plugins:
Major shout-outs and thanks to the contributors and maintainers of each of these projects! :celebrate:
For more info, take a look at the default export in the index.js
file. The config there is pretty self-explanatory.
Contributing
To contribute, simply open a PR.
For major rule changes that can affect everyone, it is advised to first start an RFC to discuss it.
For issues, report them straight to the github repo's issues page.