Skip to content

Commit

Permalink
docs(readme): added cliOptions description
Browse files Browse the repository at this point in the history
  • Loading branch information
Egor Avakumov committed Feb 8, 2020
1 parent 71f5d5f commit f5dea8b
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -175,3 +175,37 @@ After this run Jest in watch mode and you will see the following line in your wa
```
› Press F to override Stylelint --fix.
```

## Options

This project uses [cosmiconfig](https://github.com/davidtheclark/cosmiconfig), so you can provide config via:

- a `jest-runner-stylelint` property in your `package.json`
- a `jest-runner-stylelint.config.js` JS file
- a `.jest-runner-stylelintrc` JSON file

In `package.json`

```json
{
"jest-runner-stylelint": {
"cliOptions": {
// Options here
}
}
}
```

or in `jest-runner-stylelint.config.js`

```js
module.exports = {
cliOptions: {
// Options here
}
};
```

### cliOptions

Follow the [stylelint documentation on configuration](https://stylelint.io/user-guide/cli#options) to create your cli options.

0 comments on commit f5dea8b

Please sign in to comment.