bpmnlint-plugin-custom-messages

A bpmnlint custom plug-in

Usage no npm install needed!

<script type="module">
  import bpmnlintPluginCustomMessages from 'https://cdn.skypack.dev/bpmnlint-plugin-custom-messages';
</script>

README

bpmnlint-plugin-custom-messages

An custom bpmnlint plug-in to report messages from bpmn-js elements

About

This plugin only has two rules by default: error-message and warning-message which report the correspoing message using bpmn-js-bpmnlint.

In order to show a message set a string in the property node.businessObject.customErrorMessage or node.businessObject.customWarningMessage where node is a bpmn-js element.

Also set the plugin in the .bpmnlintrc file:

{
  "extends": [
    "bpmnlint:recommended",
    "plugin:custom-messages/recommended"
  ],
  "rules": {
    "custom-messages/error-message": "error",
    "custom-messages/warning-message": "warn"
  }
}

License

MIT