bpmnlint-plugin-aware

A bpmlint plug-in based on the bpmnlint plug-in example. Slightly modified and advanced / customized for the aware-platform. Packaged with the bpmnlint-pack-config utility.

About

This plugin contributes rules and configuration under the aware prefix to bpmnlint. Furthermore, it provides the active ruleset and the bpmn-moddle-extension.

Adding Rules

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

{
  "rules": {
    "aware/aware-task-type": "warn"
  }
}

Each rule should provide at least one valid and one invalid test in the ./tests folder. The filenames must end with *.test.js. To allow checking for aware-specifc moddle-extensions, make sure to use the createModdle and readModdle from the ./helper directory.

Ruleset

The .bpmnlintrc file defines which rules are active and on which level they log linting issues: error|warn|off. Besides our customized linting rules the recommended bpmnlint rules are also included:

"extends": [
    "bpmnlint:recommended",
    "plugin:aware/recommended"
    ]

AWAre Moddle

Our customized moddle descriptor defines which kinds of extensions of the bpmn meta model are allowed and how they must be structured. Their definition is located in the file ./moddle/aware-moddle.json.