@cmsgov/stylelint-config-design-system

A sharable stylelint config that enforces the design system's CSS and Sass rules

Usage no npm install needed!

<script type="module">
  import cmsgovStylelintConfigDesignSystem from 'https://cdn.skypack.dev/@cmsgov/stylelint-config-design-system';
</script>

README

A sharable stylelint config object that enforces the design system's CSS and Sass rules

Installation

npm install @cmsgov/stylelint-config-design-system stylelint --save-dev

Usage

Once installed, you can use it by specifying @cmsgov/stylelint-config-design-system in the extends section of your Stylelint configuration.

{
  extends: ["@cmsgov/stylelint-config-design-system"],
  rules: {
    // Additional, per-project rules...
  }
}

Credits

Our stylelint rules are based on those in @18F/stylelint-rules and stylelint-config-primer