node package manager

stylelint-config-primer

Sharable stylelint config used by GitHub's CSS

Primer Stylelint Config

NPM version Build Status

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

Install

$ npm install --save stylelint-config-primer

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": "stylelint-config-primer"
}

Documentation

Plugins

Configured lints

This is a list of the lints turned on in this configuration, and what they do.

At-rule

Block

Color

Comment

  • comment-empty-line-before: There must always be an empty line before comments. Except: Comments that are nested and the first child of their parent node. Ignore: stylelint commands
  • comment-whitespace-inside: There must always be whitespace inside the markers.

Declaration

Declaration block

Declaration Property

  • declaration-property-value-blacklist: Specify a blacklist of disallowed property and value pairs within declarations.
    • ^transition: Disallow the use of all within transitions.
    • ^background: Disallow the use of http: protocols within background image urls.
    • ^border: Disallow the use of the word none for borders, use 0 instead.
    • .+: For everything ban the use of the word initial.

Font Family

Function

General

Media Feature

Media Query

Media Query List

Number

Length

Property

Rule

  • rule-nested-empty-line-before: There must always be an empty line before multi-line rules. Except: Nested rules that are the first of their parent rule. Ignore: Rules that come after a comment.
  • rule-non-nested-empty-line-before: There must always be an empty line before multi-line rules. Ignore: Rules that come after a comment.

Selector

Selector List

String

Unit

Value

Value list

License

MIT © GitHub