Skip to content
3

Presets ​

  • plugin:@miragon/rules/recommended-for-modeling — for purely business/technical models, and for modeler applications that surface linting to their users. Layout hints only: bpmnlint's standard-size and the layout rules at warn, the naming/id rules off — a modeler is never blocked on execution-only conventions. The one error is a gateway drawn without its marker, because that diagram is misdrawn.
  • plugin:@miragon/rules/recommended-for-automation — for developers automating processes, locally and in CI, on models wired up to a Camunda engine. The naming and layout rules on but as a non-blocking warn (standard-size too), so ids and layout get flagged without failing the build. The scheme and engine-specific rules stay off.
  • plugin:@miragon/rules/strict — every Miragon rule at error, engine-agnostic. The gate to opt into when you want findings to fail the build. Not covered by semver: a minor release may add rules or widen what they report. See the semantic versioning policy.

Severity per rule ​

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

Only strict reports at error, so only strict can fail a build on a Miragon finding. strict is not covered by semver: a minor release may add rules or widen what they report. Pin the exact version, or build your own config from a recommended-for-* preset if your build must stay green across minors. Override any single rule in your own .bpmnlintrc. This one extends the structural rules and the modeling preset, raises no-generated-ids to error and silences flow-crossing:

json
{
  "extends": [
    "bpmnlint:recommended",
    "plugin:@miragon/rules/recommended-for-modeling"
  ],
  "rules": {
    "@miragon/rules/no-generated-ids": "error",
    "@miragon/rules/flow-crossing": "off"
  }
}