Package Exports

@primer/stylelint-config
@primer/stylelint-config/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@primer/stylelint-config) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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/no-override: Prohibits custom styles that target Primer CSS selectors.
primer/no-unused-vars: Warns about SCSS variables that are declared by not used in your local files.
primer/no-undefined-vars: Prohibits usage of undefined CSS variables.
primer/no-scale-colors: Prohibits the use of non-functional scale CSS variables
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.