Skip to content
3

Camunda 7 / 8 engines ​

A model can pass every structural check and still fail at deploy, because the engine needs properties plain BPMN does not know. The Camunda 7 and Camunda 8 deployability rules are bundled, so there is nothing extra to install.

What it looks like ​

The first run lints a Camunda 8 service task without a task definition. The second run lints the same model after adding zeebe:taskDefinition. Both outputs come from the bundled rules at build time.

zsh

$ npx bpmnlint order.bpmn

order.bpmn

  • serviceTask_reviewOrdererrorcamunda-compat/implementationElement of type <bpmn:ServiceTask> must have one extension element of type <zeebe:TaskDefinition>

FAILED1 problem (1 error, 0 warnings)

zsh

$ npx bpmnlint order.bpmn

PASSED no findings

Switch it on ​

Deploying to a Camunda engine? Add its deployability layer (bundled — no separate install) to your 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.

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.

Camunda 7 ​

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"
  }
}

Camunda 8 (Zeebe) ​

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

Older engine versions ​

Both examples name the config for the latest engine version. camunda-compat ships one config per version, from camunda-platform-7-19 and camunda-cloud-1-0 on: put your engine's version in the name, for example plugin:camunda-compat/camunda-cloud-8-5. The bpmnlint CLI loads it from the installed bpmnlint-plugin-camunda-compat.

The bundled resolver, createBundledResolver(), carries only the latest config per engine: camunda-platform-7-24 and camunda-cloud-8-11. A host that has only the bundle, such as a browser modeler, lints against these two. In Node, chain bpmnlint's NodeResolver behind the bundle, so the configs and rules the bundle does not carry load from the installed packages:

ts
import NodeResolver from 'bpmnlint/lib/resolver/node-resolver.js';
import { createBundledResolver } from '@miragon/bpmnlint-plugin-rules';

const bundled = createBundledResolver();
// loads packages from the node_modules of the working directory
const installed = new NodeResolver();

// the bundle first, the installed packages for what it does not carry
function chained(method: 'resolveRule' | 'resolveConfig') {
  return (pkg: string, name: string) => {
    try {
      return bundled[method](pkg, name);
    } catch {
      return installed[method](pkg, name);
    }
  };
}

const resolver = {
  resolveRule: chained('resolveRule'),
  resolveConfig: chained('resolveConfig'),
};

Pass this resolver to the Linter in place of createBundledResolver(), with an extends that names the older config.