Skip to content

Latest commit

 

History

History

stylelint-plugin-circuit-ui

@sumup-oss/stylelint-plugin-circuit-ui

Stylelint rules to help users follow best practices when using Circuit UI.

Stars Version Coverage License Contributor Covenant

Installation

Depending on your preference, run one of the following in your terminal:

# With npm
npm install --save-dev @sumup-oss/stylelint-plugin-circuit-ui

# With yarn v1
yarn add --dev @sumup-oss/stylelint-plugin-circuit-ui

Usage

Add the plugin to your Stylelint configuration file:

{
  "plugins": ["@sumup-oss/stylelint-plugin-circuit-ui"]
}

Rules are configured under the rules section:

{
  "rules": {
    "circuit-ui/<rule-name>": true
  }
}

Supported Rules