@skyscanner/stylelint-plugin-backpack/README.md

Stylelint configuration for Backpack development

# stylelint-plugin-backpack

[![Build Status](https://github.com/Skyscanner/stylelint-plugin-backpack/workflows/CI/badge.svg?branch=main)](https://github.com/Skyscanner/stylelint-plugin-backpack/actions?query=workflow%3ACI)
[![npm version](https://img.shields.io/npm/v/@skyscanner/stylelint-plugin-backpack.svg)](https://www.npmjs.com/package/@skyscanner/stylelint-plugin-backpack)

Stylelint plugin to prevent magic arbitrary values and promote the use of Backpack tokens.

## Installation

```
npm install @skyscanner/stylelint-plugin-backpack --save-dev
```

## Usage

Add `@skyscanner/stylelint-plugin-backpack` to your stylelint config plugins array,

```
{
  "plugins": ["@skyscanner/stylelint-plugin-backpack"]
}
```

Once you have added the plugin, you will need to add the rules you wish to use to your `rules` config. All rules from `@skyscanner/stylelint-plugin-backpack` need to be namespaced with `backpack`.

Like so:

```js
// .stylelintrc
{
  "rules": {
    "backpack/use-typography-styles": true,
  }
}
```