Skip to content
3

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.

Rulerecommended-for-modelinglayout hints onlyrecommended-for-automationeverything, non-blockingstrictfails the build
Naming
no-generated-idsIDs generated rather than chosen (Activity_0049ryx, StartEvent_1)offwarnerror
element-id-namingIDs that don't follow the type-prefix + case conventionoffwarnerror
worker-topic-namingA worker topic (C7 external task topic, C8 job type) off the configured schemeoffofferror
message-name-namingA message name off the configured schemeoffofferror
Layout
flow-through-elementA sequence flow routed through an unrelated shape's bodywarnwarnerror
flow-connection-sideA sequence flow docked onto the wrong side of a shapewarnwarnerror
flow-target-alignmentA flow's target drawn off the row, sloping the main pathwarnwarnerror
flow-crossingTwo sequence flows whose drawn paths cross each otherwarnwarnerror
flow-orthogonalA sequence flow that runs diagonally instead of horizontal and verticalwarnwarnerror
boundary-event-marker-overlapA boundary event drawn over a marker or icon of its host activitywarnwarnerror
exclusive-gateway-marker-visibleAn exclusive gateway drawn without its X markererrorwarnerror
Automation
async-continuationsCamunda 7 save points missing where Camunda recommends them, or redundantoffofferror
Bundled from bpmnlint
bpmnlint/standard-sizeElements resized away from the BPMN standard sizewarnwarnoff

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:

LayerComes fromSwitch on with
Structuralbpmnlint:recommended"bpmnlint:recommended"
Enginebpmnlint-plugin-camunda-compat"plugin:camunda-compat/...", see Engines
Miragonthis plugin"plugin:@miragon/rules/...", see Presets