@borealisgroup/stylelint-config

Stylelint config for CSS linting.

Usage no npm install needed!

<script type="module">
  import borealisgroupStylelintConfig from 'https://cdn.skypack.dev/@borealisgroup/stylelint-config';
</script>

README

@borealisgroup/stylelint-config

Stylelint config for CSS linting.

Prerequisites

  • react
  • styled-components

Install

Using npm:

yarn -D @borealisgroup/stylelint-config

Usage

Create a file stylelint.config.js at the root of your project:

module.exports = require('@borealisgroup/stylelint-config');

Stylelint

Plugins

  • stylelint-config-standard - rules

  • stylelint-config-styled-components - to disable stylelint rules that clash with styled-components

  • stylelint-config-styled-components-processor - to extract styles from styled-components

Rules

  • 'block-no-empty': null - accept styled components with no style, i.e. when we just want to use named components for readability.

Why

Why do we need a shared coding style accross the company?

TL;DR - For consistency, productivity and happiness.

Contributing

If you want to modify plugins or rules in your project, please submit a pull request instead of overwriting your local config.

For each addition, add a justification in this README.