arui-cssvars/README.md

Helper for arui-feather css variables

arui-cssvars
============

Humble utility to suggest CSS variables from 'alfa-laboratory/arui-feather' for Project's CSS
files, if Project uses one.

Installation
------------

```
npm install -D arui-cssvars
```
or
```
yarn add --dev arui-cssvars
```

How to use it?
--------------

*arui-feather should be in project dependencies!*

`node node_modules/arui-cssvars/index.js [dir]`

or add script to package.json and run as npm script:

```
  // Add to package.json
  "scripts": {
    "cssvars": "cssvars"
  }

  // Run script
  $ npm run cssvars
```

This command scans './src/' (or provided by `dir` argument) directory for .css files and try to suggest variables
from installed version of `arui-feather` to use instead of according hard-coded numbers.

PlugIn for Stylelint
--------------------

Now we have own Stylelint rule (`stylelint` is required as project dependency)!

Just add to your `.stylelintrc` or `stylelint.config.js`

```
    rules: {
        'arui-cssvars/use-variables': true
    },
    plugins: [
        './node_modules/arui-cssvars/lint/stylelint.js'
    ]

```
And your IDE will suggest you appropriate variables instead of plain values!