@justeat/stylelint-config-fozzie

Shareable Stylelint config for use with Fozzie – Just Eats UI Component Framework

Stats

StarsIssuesVersionUpdatedCreatedSize
@justeat/stylelint-config-fozzie
402.2.02 years ago4 years agoMinified + gzip package size for @justeat/stylelint-config-fozzie in KB

Readme

stylelint-config-fozzie :bear:

npm version Build Status

Fozzie shareable stylelint config.

A Stylelint config used in Fozzie – Just Eat’s Component Framework

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 @justeat/stylelint-config-fozzie --save-dev

Usage

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

{
  "extends": "@justeat/stylelint-config-fozzie"
}

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

"stylelint": {
  "extends": "@justeat/stylelint-config-fozzie"
}

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

{
  "extends": "/absolute/path/to/@justeat/stylelint-config-fozzie"
}

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, turn off the number-leading-zero rule:

{
  "extends": "@justeat/stylelint-config-fozzie",
  "rules": {
    "indentation": "tab",
    "number-leading-zero": null
  }
}

Documentation

Configured Lints

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

Changelog

License

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.