@justeattakeaway/pie-stylelint-config NPM

pie-stylelint-config

PIE shareable stylelint config.

A Stylelint config used in PIE – Just Eat Takeaway’s design system.

Use it as is or as a foundation for your own config.

To see the rules that this config uses, please read the config itself.

Installation

npm install @justeattakeaway/pie-stylelint-config --save-dev

Usage

Rules

Currently there are 3 different sets of rules:

base - the base rules that we'd advise all projects use and extend as needed.
strict - a smaller collection of optional opinionated rules.
ordering - an even smaller collection of optional rules that specify the ordering of CSS properties.

In your projects

If you've installed pie-stylelint-config locally within your project, just set your stylelint config to:

{
  "extends": "@justeattakeaway/pie-stylelint-config/base"
}

The easiest way to do this is by adding the following section to your package.json:

"stylelint": {
  "extends": "@justeattakeaway/pie-stylelint-config/base"
}

You may only want to use a specific ruleset such as base, strict or ordering. If so, simply point to the ones you'd like to use:

"stylelint": {
  "extends": [
    "@justeattakeaway/pie-stylelint-config/base",
    "@justeattakeaway/pie-stylelint-config/strict",
    "@justeattakeaway/pie-stylelint-config/ordering" 
  ]
}

Note: @justeattakeaway/pie-stylelint-config includes all rules. We would strongly recommend using @justeattakeaway/pie-stylelint-config/base and going from there.

If you've globally installed pie-stylelint-config using the -g flag, then you'll need to use the absolute path to pie-stylelint-config in your config e.g.

{
  "extends": "/absolute/path/to/@justeattakeaway/pie-stylelint-config/base"
}

Extending the config

Simply add a "rules" key to your config, then add your overrides and additions there.

For example, to change the indentation to tabs, and turn off the number-leading-zero rule:

{
  "extends": "@justeattakeaway/pie-stylelint-config/base",
  "rules": {
    "indentation": "tab",
    "number-leading-zero": null
  }
}

Documentation

Configured Lints

pie-stylelint-config is a great foundation for your own config. Here is a list of the rules turned on in this config, and what they do:

Base

Strict

Ordering

Changelog

PIE stylelint stylelint-config standard

@infinitebrahmanuniverse/nolb-_jus @everything-registry/sub-chunk-505

0.1.1

1 year ago

0.1.0

1 year ago