39 lines
831 B
Markdown
39 lines
831 B
Markdown
|
# bpmnlint-plugin-local
|
||
|
|
|
||
|
|
A bpmlint plug-in based on the [bpmnlint plug-in example](https://github.com/bpmn-io/bpmnlint-plugin-example).
|
||
|
|
|
||
|
|
|
||
|
|
## About
|
||
|
|
|
||
|
|
This plugin contributes [rules](#add-rules) and [configuration](#add-configuration) under the `local` prefix to bpmnlint.
|
||
|
|
|
||
|
|
|
||
|
|
## Add Rules
|
||
|
|
|
||
|
|
The [`./rules`](./rules) folder contains rules that are made available via
|
||
|
|
this plug-in. Configure them with the `local` prefix in your `.bpmnlintrc`:
|
||
|
|
|
||
|
|
```json
|
||
|
|
{
|
||
|
|
"rules": {
|
||
|
|
"local/no-manual-task": "warn"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
Checkout [`./test.js`](./test.js) to learn how to test your rules.
|
||
|
|
|
||
|
|
|
||
|
|
## Add Configuration
|
||
|
|
|
||
|
|
As part of the [`./index.js`](./index.js) the plug-in exposes configurations
|
||
|
|
to extend from using `extends` in the bpmnlint configuration:
|
||
|
|
|
||
|
|
```json
|
||
|
|
{
|
||
|
|
"extends": [
|
||
|
|
"bpmnlint:recommended",
|
||
|
|
"plugin:local/recommended"
|
||
|
|
]
|
||
|
|
}
|
||
|
|
```
|