bpmnlint-plugin-camunda-compat 2.35.0 → 2.37.0

package/README.md

@@ -4,6 +4,13 @@
 
 A [bpmnlint](https://github.com/bpmn-io/bpmnlint) plug-in that checks whether a given BPMN process can be executed with [Camunda](https://camunda.com/).
 
+## Installation
+
+To use the plug-in, ensure it is installed is installed in your project, alongside [bpmnlint](https://github.com/bpmn-io/bpmnlint):
+
+```sh
+npm install -D bpmnlint bpmnlint-plugin-camunda-compat
+```
 
 ## Usage
 
@@ -21,8 +28,50 @@ Add configuration corresponding to your execution platform and version to your [
 }
 ```
 
+> [!WARNING]
+> BPMN diagrams validated must be parsed with the respective [Camunda 7](https://github.com/camunda/camunda-bpmn-moddle) or [Camunda 8](https://github.com/camunda/zeebe-bpmn-moddle) moddle extension. 
+>
+> See also [command line use](#command-line-use).
+
+## Dynamic Linter Configuration
+
 Use [`@camunda/linting`](https://github.com/camunda/linting) to configure the linter dynamically based on the [execution platform and version](https://github.com/camunda/modeler-moddle).
 
+## Command Line Use
+
+When using `bpmnlint` via the command line, ensure it picks up the respective [Camunda 7](https://github.com/camunda/camunda-bpmn-moddle) or [Camunda 8](https://github.com/camunda/zeebe-bpmn-moddle) moddle extension.
+
+For Camunda 8, install the [zeebe-bpmn-moddle extension](https://github.com/camunda/zeebe-bpmn-moddle):
+
+```
+npm install bpmnlint zeebe-bpmn-moddle bpmnlint-plugin-camunda-compat
+```
+
+Extend your configuration so bpmnlint picks-up the extension when parsing a BPMN diagram:
+
+```diff
+--- .bpmnlintrc
++++ .bpmnlintrc
+@@ -1,9 +1,12 @@
+ {
+   "extends": [
+     "bpmnlint:recommended",
+     "plugin:camunda-compat/camunda-cloud-8-7"
+   ],
+   "rules": {
+     "camunda-compat/timer": "off"
++  },
++  "moddleExtensions": {
++    "zeebe": "zeebe-bpmn-moddle/resources/zeebe.json"
+   }
+ }
+```
+
+Invoke `bpmnlint` from your command line in the usual ways:
+
+```
+npx bpmnlint my-diagram.bpmn
+```
 
 ## Resources
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bpmnlint-plugin-camunda-compat",
-  "version": "2.35.0",
+  "version": "2.37.0",
   "description": "A bpmnlint plug-in for Camunda compatibility",
   "main": "index.js",
   "scripts": {
@@ -25,7 +25,7 @@
   "license": "MIT",
   "devDependencies": {
     "bpmn-moddle": "^9.0.1",
-    "bpmnlint": "^11.2.0",
+    "bpmnlint": "^11.6.0",
     "camunda-bpmn-moddle": "^7.0.1",
     "chai": "^4.4.1",
     "eslint": "^9.20.1",

package/rules/camunda-cloud/feel.js

@@ -36,7 +36,9 @@ module.exports = skipInNonExecutableProcess(function() {
       }
 
       if (isFeelProperty([ propertyName, propertyValue ])) {
-        const lintErrors = lintExpression(propertyValue.substring(1));
+        const lintErrors = lintExpression(propertyValue.substring(1), {
+          parserDialect: 'camunda'
+        });
 
         // syntax error
         if (lintErrors.find(({ type }) => type === 'Syntax Error')) {

package/rules/camunda-platform/history-time-to-live.js

@@ -1,7 +1,5 @@
 const { is } = require('bpmnlint-utils');
 
-const { annotateRule } = require('../helper');
-
 const { skipInNonExecutableProcess } = require('../utils/rule');
 
 module.exports = skipInNonExecutableProcess(function() {
@@ -16,7 +14,12 @@ module.exports = skipInNonExecutableProcess(function() {
     }
   }
 
-  return annotateRule('history-time-to-live', {
+  return {
+    meta: {
+      documentation: {
+        url: 'https://docs.camunda.org/manual/latest/modeler/history-time-to-live/'
+      }
+    },
     check
-  });
+  };
 });