A sharable stylelint config object that enforces GitHub's CSS rules
$ npm install --save --dev @primer/stylelint-config
Within your stylelint config object You can extend this configuration. This will serve as a base for your config, then you can make overrides in your own config object:
{
"extends": ["@primer/stylelint-config"],
"rules": { }
}
Primer Stylelint Config extends the stylelint-config-standard configuration supplied by Stylelint, and makes modifications in /index.js
.
- stylelint-order: Order-related linting rules for stylelint. Properties must be sorted according to this list.
- stylelint-scss: A collection of SCSS specific linting rules for stylelint
- scss/selector-no-redundant-nesting-selector: Disallow redundant nesting selectors (
&
).
- scss/selector-no-redundant-nesting-selector: Disallow redundant nesting selectors (
- primer/colors: Enforces the use of certain color variables.
- primer/spacing: Enforces the use of spacing variables for margin and padding.
- primer/typography: Enforces the use of typography variables for certain CSS properties.
- primer/borders: Enforces the use of certain variables for border properties.
- primer/box-shadow: Enforces the use of certain variables for
box-shadow
. - primer/responsive-widths: Errors on
width
andmin-width
that is larger than the minimum browser size supported.320px