Skip to content

docs: readme explain moddle extensions #39

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
DaAnda97 merged 2 commits into from
Aug 25, 2026
Merged

docs: readme explain moddle extensions #39

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9bd2ed9
docs: explain required moddleExtensions for engine rules
DaAnda97 Aug 24, 2026
d8003ca
docs: split engine rules into complete C7 and C8 config examples
DaAnda97 Aug 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 29 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,26 +104,43 @@ npx bpmnlint 'models/**/*.bpmn'
## Camunda engine rules

Deploying to a Camunda engine? Add its deployability layer (bundled — no separate install) to your
`extends`:
`extends`. These rules read engine-specific properties, so bpmnlint must also parse them with the
matching moddle extension — pick the config for your engine below.

| Engine | Add to `extends` |
| ----------------- | --------------------------------------------- |
| Camunda 7 | `plugin:camunda-compat/camunda-platform-7-24` |
| Camunda 8 (Zeebe) | `plugin:camunda-compat/camunda-cloud-8-10` |
**The `moddleExtensions` line is not optional.** Without it the parser doesn't recognize the engine
namespace, so those properties are invisible to the rules — they then report false findings (for
example a service task flagged as missing its task definition even though it has one). A modeler loads
the moddle already; it's the bare `npx bpmnlint` CLI that needs this line. Prefer to skip the wiring?
The programmatic `getDefaultLintConfig({ engine })` below sets up both the layer and its moddle
extension for you.

These rules read engine properties, so point bpmnlint at the matching moddle extension in your
`.bpmnlintrc`:
### Camunda 7

```jsonc
// .bpmnlintrc
{
"extends": ["bpmnlint:recommended", "plugin:camunda-compat/camunda-cloud-8-10"],
"moddleExtensions": { "zeebe": "zeebe-bpmn-moddle/resources/zeebe.json" },
"extends": [
"bpmnlint:recommended",
"plugin:@miragon/rules/recommended-for-automation",
"plugin:camunda-compat/camunda-platform-7-24",
],
"moddleExtensions": { "camunda": "camunda-bpmn-moddle/resources/camunda.json" },
}
```

For Camunda 7, use `"camunda": "camunda-bpmn-moddle/resources/camunda.json"`. Prefer to skip the
wiring? The programmatic `getDefaultLintConfig({ engine })` below sets up both the layer and its
moddle extension for you.
### Camunda 8 (Zeebe)

```jsonc
// .bpmnlintrc
{
"extends": [
"bpmnlint:recommended",
"plugin:@miragon/rules/recommended-for-automation",
"plugin:camunda-compat/camunda-cloud-8-10",
],
"moddleExtensions": { "zeebe": "zeebe-bpmn-moddle/resources/zeebe.json" },
}
```

## Programmatic use

Expand Down