| 1 | # eslint-plugin-bpmn-io
|
| 2 |
|
| 3 | Commont lint rules for [bpmn.io](https://bpmn.io) projects.
|
| 4 |
|
| 5 |
|
| 6 | ## Use
|
| 7 |
|
| 8 | Extend `bpmn-io/*` in your base eslint configuration:
|
| 9 |
|
| 10 | ```json
|
| 11 | {
|
| 12 | "extends": "plugin:bpmn-io/es6"
|
| 13 | }
|
| 14 | ```
|
| 15 |
|
| 16 | If you use [mocha](https://mochajs.org/) for testing, place another `.eslintrc` into your `test` folder and extend from `bpmn-io/mocha`:
|
| 17 |
|
| 18 | ```json
|
| 19 | {
|
| 20 | "extends": "plugin:bpmn-io/mocha"
|
| 21 | }
|
| 22 | ```
|
| 23 |
|
| 24 |
|
| 25 | ## Available Recommended Configurations
|
| 26 |
|
| 27 | We ship with a few blue prints:
|
| 28 |
|
| 29 | * `bpmn-io/es5`: Use for ES5 style projects / node libraries
|
| 30 | * `bpmn-io/es6`: Use for modern, ES2015 based projects
|
| 31 | * `bpmn-io/jsx`: Use `jsx` in conjunction with `es6`
|
| 32 | * `bpmn-io/mocha`: Use for libraries tested with `mocha` + `chai`
|
| 33 |
|
| 34 |
|
| 35 | ## License
|
| 36 |
|
| 37 | MIT
|