Home

Awesome

bpmnlint-plugin-example

CI

An example bpmnlint plug-in.

About

This plugin shows how to contribute rules and configuration to bpmnlint.

Add Rules

The ./rules folder contains rules that are made available via this plug-in. Configure them with the example prefix in your .bpmnlintrc:

{
  "rules": {
    "example/no-manual-task": "warn"
  }
}

Checkout ./test.js to learn how to test your rules.

Add Configuration

As part of the ./index.js the plug-in exposes configurations to extend from using extends in the bpmnlint configuration:

{
  "extends": [
    "bpmnlint:recommended",
    "plugin:example/recommended"
  ]
}

Visual Debugging

Use the bpmnlint-playground to visually debug your rules.

License

MIT