primer / stylelint-config

Sharable stylelint config used by GitHub's CSS

Primer Stylelint Config

A sharable stylelint config object that enforces GitHub's CSS rules

Install

$ npm install --save --dev @primer/stylelint-config

Usage

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": { }
}

Documentation

Primer Stylelint Config extends the stylelint-config-standard configuration supplied by Stylelint, and makes modifications in /index.js.

Plugins

• 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 (&).
• 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 and min-width that is larger than the minimum browser size supported. 320px
• primer/utilities: Errors when someone writes custom CSS for a declaration that has an existing primer/css/utility.

License

MIT © GitHub