Rules
The Miragon conventions this plugin adds. Every rule has its own page with a reported and a clean example, the reasoning and its options.
| Rule | recommended-for-modelinglayout hints only | recommended-for-automationeverything, non-blocking | strictfails the build |
|---|---|---|---|
| Naming | |||
no-generated-idsIDs generated rather than chosen (Activity_0049ryx, StartEvent_1) | off | warn | error |
element-id-namingIDs that don't follow the type-prefix + case convention | off | warn | error |
worker-topic-namingA worker topic (C7 external task topic, C8 job type) off the configured scheme | off | off | error |
message-name-namingA message name off the configured scheme | off | off | error |
| Layout | |||
flow-through-elementA sequence flow routed through an unrelated shape's body | warn | warn | error |
flow-connection-sideA sequence flow docked onto the wrong side of a shape | warn | warn | error |
flow-target-alignmentA flow's target drawn off the row, sloping the main path | warn | warn | error |
flow-crossingTwo sequence flows whose drawn paths cross each other | warn | warn | error |
flow-orthogonalA sequence flow that runs diagonally instead of horizontal and vertical | warn | warn | error |
boundary-event-marker-overlapA boundary event drawn over a marker or icon of its host activity | warn | warn | error |
exclusive-gateway-marker-visibleAn exclusive gateway drawn without its X marker | error | warn | error |
| Automation | |||
async-continuationsCamunda 7 save points missing where Camunda recommends them, or redundant | off | off | error |
| Bundled from bpmnlint | |||
bpmnlint/standard-sizeElements resized away from the BPMN standard size | warn | warn | off |
Start with the group pages for the reasoning and side-by-side examples: Naming and Layout. Rules for one engine only, such as async-continuations, are grouped under Automation in the sidebar.
Bundled layers
The plugin also carries two third-party rule sets, so one install covers all three layers:
| Layer | Comes from | Switch on with |
|---|---|---|
| Structural | bpmnlint:recommended | "bpmnlint:recommended" |
| Engine | bpmnlint-plugin-camunda-compat | "plugin:camunda-compat/...", see Engines |
| Miragon | this plugin | "plugin:@miragon/rules/...", see Presets |