bpmnlint-plugin-camunda-compat 2.44.0 → 2.45.0

package/index.js

@@ -32,6 +32,7 @@ const camundaCloud10Rules = withConfig({
   'timer': 'error',
   'user-task-definition': 'warn',
   'user-task-form': 'error',
+  'variable-name': 'error',
   'feel': 'error',
   'bpmnlint/start-event-required': 'error',
 }, { version: '1.0' });
@@ -196,6 +197,7 @@ const rules = {
   'timer': './rules/camunda-cloud/timer',
   'user-task-definition': './rules/camunda-cloud/user-task-definition',
   'user-task-form': './rules/camunda-cloud/user-task-form',
+  'variable-name': './rules/camunda-cloud/variable-name',
   'version-tag': './rules/camunda-cloud/version-tag',
   'wait-for-completion': './rules/camunda-cloud/wait-for-completion',
   ...bpmnlintRules.reduce((rules, rule) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bpmnlint-plugin-camunda-compat",
-  "version": "2.44.0",
+  "version": "2.45.0",
   "description": "A bpmnlint plug-in for Camunda compatibility",
   "main": "index.js",
   "scripts": {

package/rules/camunda-cloud/variable-name.js

@@ -0,0 +1,108 @@
+const { is } = require('bpmnlint-utils');
+
+const {
+  findExtensionElement,
+  hasProperties
+} = require('../utils/element');
+
+const { reportErrors } = require('../utils/reporter');
+
+const { skipInNonExecutableProcess } = require('../utils/rule');
+
+const VARIABLE_NAME_PATTERN = /^[a-zA-Z_][a-zA-Z0-9_]*(?:\.[a-zA-Z_][a-zA-Z0-9_]*)*$/;
+
+function isValidVariableName(value) {
+  return VARIABLE_NAME_PATTERN.test(value);
+}
+
+module.exports = skipInNonExecutableProcess(function() {
+  function check(node, reporter) {
+    const errors = [];
+
+    // zeebe:IoMapping#inputParameters/outputParameters
+    const ioMapping = findExtensionElement(node, 'zeebe:IoMapping');
+    if (ioMapping) {
+      const inputParameters = ioMapping.get('inputParameters') || [];
+      const outputParameters = ioMapping.get('outputParameters') || [];
+
+      inputParameters.forEach((input) => {
+        errors.push(...hasProperties(input, {
+          target: {
+            allowed: isValidVariableName
+          }
+        }, node));
+      });
+
+      outputParameters.forEach((output) => {
+        errors.push(...hasProperties(output, {
+          target: {
+            allowed: isValidVariableName
+          }
+        }, node));
+      });
+    }
+
+    const loopCharacteristics = node.get('loopCharacteristics');
+    if (loopCharacteristics && is(loopCharacteristics, 'bpmn:MultiInstanceLoopCharacteristics')) {
+      const zeebeLoopCharacteristics = findExtensionElement(loopCharacteristics, 'zeebe:LoopCharacteristics');
+
+      if (zeebeLoopCharacteristics) {
+        errors.push(...hasProperties(zeebeLoopCharacteristics, {
+          inputElement: {
+            allowed: isValidVariableName
+          },
+          outputCollection: {
+            allowed: isValidVariableName
+          }
+        }, node));
+      }
+    }
+
+    // zeebe:Script#resultVariable
+    if (is(node, 'bpmn:ScriptTask')) {
+      const script = findExtensionElement(node, 'zeebe:Script');
+
+      if (script) {
+        errors.push(...hasProperties(script, {
+          resultVariable: {
+            allowed: isValidVariableName
+          }
+        }, node));
+      }
+    }
+
+    // zeebe:CalledDecision#resultVariable)
+    if (is(node, 'bpmn:BusinessRuleTask')) {
+      const calledDecision = findExtensionElement(node, 'zeebe:CalledDecision');
+
+      if (calledDecision) {
+        errors.push(...hasProperties(calledDecision, {
+          resultVariable: {
+            allowed: isValidVariableName
+          }
+        }, node));
+      }
+    }
+
+    // zeebe:AdHoc#outputCollection
+    if (is(node, 'bpmn:AdHocSubProcess')) {
+      const adHoc = findExtensionElement(node, 'zeebe:AdHoc');
+
+      if (adHoc) {
+        errors.push(...hasProperties(adHoc, {
+          outputCollection: {
+            allowed: isValidVariableName
+          }
+        }, node));
+      }
+    }
+
+    if (errors.length) {
+      reportErrors(node, reporter, errors);
+    }
+  }
+
+  return {
+    check
+  };
+});