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