bpmnlint-plugin-camunda-compat 2.23.0 → 2.24.0

package/rules/camunda-cloud/escalation-boundary-event-attached-to-ref.js

@@ -1,48 +1,48 @@
-const {
-  is,
-  isAny
-} = require('bpmnlint-utils');
-
-const {
-  getEventDefinition,
-  isAnyExactly
-} = require('../utils/element');
-
-const { ERROR_TYPES } = require('../utils/error-types');
-
-const { reportErrors } = require('../utils/reporter');
-
-const { skipInNonExecutableProcess } = require('../utils/rule');
-
-module.exports = skipInNonExecutableProcess(function() {
-  function check(node, reporter) {
-    if (!isAny(node, [ 'bpmn:CatchEvent', 'bpmn:ThrowEvent' ])) {
-      return;
-    }
-
-    const eventDefinition = getEventDefinition(node);
-
-    if (!eventDefinition || !is(eventDefinition, 'bpmn:EscalationEventDefinition')) {
-      return;
-    }
-
-    const attachedToRef = node.get('attachedToRef');
-
-    if (attachedToRef && !isAnyExactly(attachedToRef, [ 'bpmn:CallActivity', 'bpmn:SubProcess' ])) {
-      reportErrors(node, reporter, {
-        message: `Element of type <bpmn:BoundaryEvent> with event definition of type <bpmn:EscalationEventDefinition> is not allowed to be attached to element of type <${ attachedToRef.$type }>`,
-        path: null,
-        data: {
-          type: ERROR_TYPES.ATTACHED_TO_REF_ELEMENT_TYPE_NOT_ALLOWED,
-          node,
-          parentNode: null,
-          attachedToRef
-        }
-      });
-    }
-  }
-
-  return {
-    check
-  };
-});
+const {
+  is,
+  isAny
+} = require('bpmnlint-utils');
+
+const {
+  getEventDefinition,
+  isAnyExactly
+} = require('../utils/element');
+
+const { ERROR_TYPES } = require('../utils/error-types');
+
+const { reportErrors } = require('../utils/reporter');
+
+const { skipInNonExecutableProcess } = require('../utils/rule');
+
+module.exports = skipInNonExecutableProcess(function() {
+  function check(node, reporter) {
+    if (!isAny(node, [ 'bpmn:CatchEvent', 'bpmn:ThrowEvent' ])) {
+      return;
+    }
+
+    const eventDefinition = getEventDefinition(node);
+
+    if (!eventDefinition || !is(eventDefinition, 'bpmn:EscalationEventDefinition')) {
+      return;
+    }
+
+    const attachedToRef = node.get('attachedToRef');
+
+    if (attachedToRef && !isAnyExactly(attachedToRef, [ 'bpmn:CallActivity', 'bpmn:SubProcess' ])) {
+      reportErrors(node, reporter, {
+        message: `Element of type <bpmn:BoundaryEvent> with event definition of type <bpmn:EscalationEventDefinition> is not allowed to be attached to element of type <${ attachedToRef.$type }>`,
+        path: null,
+        data: {
+          type: ERROR_TYPES.ATTACHED_TO_REF_ELEMENT_TYPE_NOT_ALLOWED,
+          node,
+          parentNode: null,
+          attachedToRef
+        }
+      });
+    }
+  }
+
+  return {
+    check
+  };
+});

package/rules/camunda-cloud/escalation-reference.js

@@ -1,67 +1,67 @@
-const {
-  is,
-  isAny
-} = require('bpmnlint-utils');
-
-const {
-  getEventDefinition,
-  hasProperties
-} = require('../utils/element');
-
-const { reportErrors } = require('../utils/reporter');
-
-const { skipInNonExecutableProcess } = require('../utils/rule');
-
-module.exports = skipInNonExecutableProcess(function() {
-  function check(node, reporter) {
-    if (!isAny(node, [ 'bpmn:CatchEvent', 'bpmn:ThrowEvent' ])) {
-      return;
-    }
-
-    const eventDefinition = getEventDefinition(node);
-
-    if (!eventDefinition || !is(eventDefinition, 'bpmn:EscalationEventDefinition')) {
-      return;
-    }
-
-    let errors = [];
-
-    if (!isNoEscalationRefAllowed(node)) {
-      errors = hasProperties(eventDefinition, {
-        escalationRef: {
-          required: true
-        }
-      }, node);
-
-      if (errors.length) {
-        reportErrors(node, reporter, errors);
-
-        return;
-      }
-    }
-
-    const escalationRef = eventDefinition.get('escalationRef');
-
-    if (!escalationRef) {
-      return;
-    }
-
-    errors = hasProperties(escalationRef, {
-      escalationCode: {
-        required: true
-      }
-    }, node);
-
-    if (errors.length) {
-      reportErrors(node, reporter, errors);
-    }
-  }
-
-  return {
-    check
-  };
-});
-
-function isNoEscalationRefAllowed(node) {
-  return isAny(node, [ 'bpmn:CatchEvent', 'bpmn:BoundaryEvent' ]);
+const {
+  is,
+  isAny
+} = require('bpmnlint-utils');
+
+const {
+  getEventDefinition,
+  hasProperties
+} = require('../utils/element');
+
+const { reportErrors } = require('../utils/reporter');
+
+const { skipInNonExecutableProcess } = require('../utils/rule');
+
+module.exports = skipInNonExecutableProcess(function() {
+  function check(node, reporter) {
+    if (!isAny(node, [ 'bpmn:CatchEvent', 'bpmn:ThrowEvent' ])) {
+      return;
+    }
+
+    const eventDefinition = getEventDefinition(node);
+
+    if (!eventDefinition || !is(eventDefinition, 'bpmn:EscalationEventDefinition')) {
+      return;
+    }
+
+    let errors = [];
+
+    if (!isNoEscalationRefAllowed(node)) {
+      errors = hasProperties(eventDefinition, {
+        escalationRef: {
+          required: true
+        }
+      }, node);
+
+      if (errors.length) {
+        reportErrors(node, reporter, errors);
+
+        return;
+      }
+    }
+
+    const escalationRef = eventDefinition.get('escalationRef');
+
+    if (!escalationRef) {
+      return;
+    }
+
+    errors = hasProperties(escalationRef, {
+      escalationCode: {
+        required: true
+      }
+    }, node);
+
+    if (errors.length) {
+      reportErrors(node, reporter, errors);
+    }
+  }
+
+  return {
+    check
+  };
+});
+
+function isNoEscalationRefAllowed(node) {
+  return isAny(node, [ 'bpmn:CatchEvent', 'bpmn:BoundaryEvent' ]);
 }

package/rules/camunda-cloud/event-based-gateway-target.js

@@ -1,39 +1,39 @@
-const { is } = require('bpmnlint-utils');
-
-const { ERROR_TYPES } = require('../utils/element');
-
-const { reportErrors } = require('../utils/reporter');
-
-const { skipInNonExecutableProcess } = require('../utils/rule');
-
-module.exports = skipInNonExecutableProcess(function() {
-  function check(node, reporter) {
-    if (!is(node, 'bpmn:ReceiveTask')) {
-      return;
-    }
-
-    // receive task as event-based gateway target is allowed by BPMN 2.0 but not
-    // supported by Zeebe
-    const error = node.get('incoming').some((sequenceFlow) => {
-      const source = sequenceFlow.get('sourceRef');
-
-      return is(source, 'bpmn:EventBasedGateway');
-    });
-
-    if (error) {
-      reportErrors(node, reporter, {
-        message: 'Element of type <bpmn:ReceiveTask> not allowed as event-based gateway target',
-        path: null,
-        data: {
-          type: ERROR_TYPES.EVENT_BASED_GATEWAY_TARGET_NOT_ALLOWED,
-          node,
-          parentNode: null
-        }
-      });
-    }
-  }
-
-  return {
-    check
-  };
+const { is } = require('bpmnlint-utils');
+
+const { ERROR_TYPES } = require('../utils/element');
+
+const { reportErrors } = require('../utils/reporter');
+
+const { skipInNonExecutableProcess } = require('../utils/rule');
+
+module.exports = skipInNonExecutableProcess(function() {
+  function check(node, reporter) {
+    if (!is(node, 'bpmn:ReceiveTask')) {
+      return;
+    }
+
+    // receive task as event-based gateway target is allowed by BPMN 2.0 but not
+    // supported by Zeebe
+    const error = node.get('incoming').some((sequenceFlow) => {
+      const source = sequenceFlow.get('sourceRef');
+
+      return is(source, 'bpmn:EventBasedGateway');
+    });
+
+    if (error) {
+      reportErrors(node, reporter, {
+        message: 'Element of type <bpmn:ReceiveTask> not allowed as event-based gateway target',
+        path: null,
+        data: {
+          type: ERROR_TYPES.EVENT_BASED_GATEWAY_TARGET_NOT_ALLOWED,
+          node,
+          parentNode: null
+        }
+      });
+    }
+  }
+
+  return {
+    check
+  };
 });

package/rules/camunda-cloud/executable-process.js

@@ -1,62 +1,62 @@
-const { is } = require('bpmnlint-utils');
-
-const { hasProperties } = require('../utils/element');
-
-const { reportErrors } = require('../utils/reporter');
-
-module.exports = function() {
-  function check(node, reporter) {
-    if (!is(node, 'bpmn:Definitions')) {
-      return;
-    }
-
-    const rootElements = node.get('rootElements'),
-          collaboration = rootElements.find(rootElement => is(rootElement, 'bpmn:Collaboration')),
-          processes = rootElements.filter(rootElement => is(rootElement, 'bpmn:Process'));
-
-    let errors = [];
-
-    for (const process of processes) {
-      const parentNode = getParentNode(process, collaboration);
-
-      errors = [
-        ...errors,
-        ...hasProperties(process, {
-          isExecutable: {
-            value: true
-          }
-        }, parentNode)
-      ];
-    }
-
-    if (errors.length > processes.length - 1) {
-      errors.forEach(error => {
-        const { data } = error;
-
-        const { node: process } = data;
-
-        reportErrors(getParentNode(process, collaboration), reporter, error);
-      });
-    }
-  }
-
-  return {
-    check
-  };
-};
-
-function getParentNode(process, collaboration) {
-  if (!collaboration) {
-    return process;
-  }
-
-  const participants = collaboration.get('participants');
-
-  const participant = participants.find(participant => participant.get('processRef') === process);
-
-  if (participant) {
-    return participant;
-  }
-
-  return process;
+const { is } = require('bpmnlint-utils');
+
+const { hasProperties } = require('../utils/element');
+
+const { reportErrors } = require('../utils/reporter');
+
+module.exports = function() {
+  function check(node, reporter) {
+    if (!is(node, 'bpmn:Definitions')) {
+      return;
+    }
+
+    const rootElements = node.get('rootElements'),
+          collaboration = rootElements.find(rootElement => is(rootElement, 'bpmn:Collaboration')),
+          processes = rootElements.filter(rootElement => is(rootElement, 'bpmn:Process'));
+
+    let errors = [];
+
+    for (const process of processes) {
+      const parentNode = getParentNode(process, collaboration);
+
+      errors = [
+        ...errors,
+        ...hasProperties(process, {
+          isExecutable: {
+            value: true
+          }
+        }, parentNode)
+      ];
+    }
+
+    if (errors.length > processes.length - 1) {
+      errors.forEach(error => {
+        const { data } = error;
+
+        const { node: process } = data;
+
+        reportErrors(getParentNode(process, collaboration), reporter, error);
+      });
+    }
+  }
+
+  return {
+    check
+  };
+};
+
+function getParentNode(process, collaboration) {
+  if (!collaboration) {
+    return process;
+  }
+
+  const participants = collaboration.get('participants');
+
+  const participant = participants.find(participant => participant.get('processRef') === process);
+
+  if (participant) {
+    return participant;
+  }
+
+  return process;
 }

package/rules/camunda-cloud/execution-listener.js

@@ -1,34 +1,34 @@
-const {
-  findExtensionElement,
-  hasProperties
-} = require('../utils/element');
-
-const { reportErrors } = require('../utils/reporter');
-
-const { skipInNonExecutableProcess } = require('../utils/rule');
-
-
-module.exports = skipInNonExecutableProcess(function() {
-  function check(node, reporter) {
-    const executionListeners = findExtensionElement(node, 'zeebe:ExecutionListeners');
-
-    if (!executionListeners) {
-      return;
-    }
-
-    const listeners = executionListeners.get('listeners');
-    const errors = listeners.flatMap(listener => hasProperties(listener, {
-      type: {
-        required: true
-      }
-    }, node));
-
-    if (errors.length) {
-      reportErrors(node, reporter, errors);
-    }
-  }
-
-  return {
-    check
-  };
-});
+const {
+  findExtensionElement,
+  hasProperties
+} = require('../utils/element');
+
+const { reportErrors } = require('../utils/reporter');
+
+const { skipInNonExecutableProcess } = require('../utils/rule');
+
+
+module.exports = skipInNonExecutableProcess(function() {
+  function check(node, reporter) {
+    const executionListeners = findExtensionElement(node, 'zeebe:ExecutionListeners');
+
+    if (!executionListeners) {
+      return;
+    }
+
+    const listeners = executionListeners.get('listeners');
+    const errors = listeners.flatMap(listener => hasProperties(listener, {
+      type: {
+        required: true
+      }
+    }, node));
+
+    if (errors.length) {
+      reportErrors(node, reporter, errors);
+    }
+  }
+
+  return {
+    check
+  };
+});

package/rules/camunda-cloud/feel.js

@@ -1,83 +1,83 @@
-const { isString } = require('min-dash');
-
-const { is } = require('bpmnlint-utils');
-
-const { lintExpression } = require('@bpmn-io/feel-lint');
-
-const { getPath } = require('@bpmn-io/moddle-utils');
-
-const { reportErrors } = require('../utils/reporter');
-
-const { ERROR_TYPES } = require('../utils/error-types');
-
-const { skipInNonExecutableProcess } = require('../utils/rule');
-
-module.exports = skipInNonExecutableProcess(function() {
-  function check(node, reporter) {
-    if (is(node, 'bpmn:Expression')) {
-      return;
-    }
-
-    const parentNode = findFlowElement(node);
-
-    if (!parentNode) {
-      return;
-    }
-
-    const errors = [];
-
-    Object.entries(node).forEach(([ propertyName, propertyValue ]) => {
-      if (propertyValue && is(propertyValue, 'bpmn:Expression')) {
-        propertyValue = propertyValue.get('body');
-      }
-
-      if (isFeelProperty([ propertyName, propertyValue ])) {
-        const lintErrors = lintExpression(propertyValue.substring(1));
-
-        // syntax error
-        if (lintErrors.find(({ type }) => type === 'Syntax Error')) {
-          const path = getPath(node, parentNode);
-
-          errors.push(
-            {
-              message: `Property <${ propertyName }> is not a valid FEEL expression`,
-              path: path
-                ? [ ...path, propertyName ]
-                : [ propertyName ],
-              data: {
-                type: ERROR_TYPES.FEEL_EXPRESSION_INVALID,
-                node,
-                parentNode,
-                property: propertyName
-              }
-            }
-          );
-        }
-      }
-    });
-
-    if (errors && errors.length) {
-      reportErrors(parentNode, reporter, errors);
-    }
-  }
-
-  return {
-    check
-  };
-});
-
-const isFeelProperty = ([ propertyName, value ]) => {
-  return !isIgnoredProperty(propertyName) && isString(value) && value.startsWith('=');
-};
-
-const isIgnoredProperty = propertyName => {
-  return propertyName.startsWith('$');
-};
-
-const findFlowElement = node => {
-  while (node && !is(node, 'bpmn:FlowElement')) {
-    node = node.$parent;
-  }
-
-  return node;
+const { isString } = require('min-dash');
+
+const { is } = require('bpmnlint-utils');
+
+const { lintExpression } = require('@bpmn-io/feel-lint');
+
+const { getPath } = require('@bpmn-io/moddle-utils');
+
+const { reportErrors } = require('../utils/reporter');
+
+const { ERROR_TYPES } = require('../utils/error-types');
+
+const { skipInNonExecutableProcess } = require('../utils/rule');
+
+module.exports = skipInNonExecutableProcess(function() {
+  function check(node, reporter) {
+    if (is(node, 'bpmn:Expression')) {
+      return;
+    }
+
+    const parentNode = findFlowElement(node);
+
+    if (!parentNode) {
+      return;
+    }
+
+    const errors = [];
+
+    Object.entries(node).forEach(([ propertyName, propertyValue ]) => {
+      if (propertyValue && is(propertyValue, 'bpmn:Expression')) {
+        propertyValue = propertyValue.get('body');
+      }
+
+      if (isFeelProperty([ propertyName, propertyValue ])) {
+        const lintErrors = lintExpression(propertyValue.substring(1));
+
+        // syntax error
+        if (lintErrors.find(({ type }) => type === 'Syntax Error')) {
+          const path = getPath(node, parentNode);
+
+          errors.push(
+            {
+              message: `Property <${ propertyName }> is not a valid FEEL expression`,
+              path: path
+                ? [ ...path, propertyName ]
+                : [ propertyName ],
+              data: {
+                type: ERROR_TYPES.FEEL_EXPRESSION_INVALID,
+                node,
+                parentNode,
+                property: propertyName
+              }
+            }
+          );
+        }
+      }
+    });
+
+    if (errors && errors.length) {
+      reportErrors(parentNode, reporter, errors);
+    }
+  }
+
+  return {
+    check
+  };
+});
+
+const isFeelProperty = ([ propertyName, value ]) => {
+  return !isIgnoredProperty(propertyName) && isString(value) && value.startsWith('=');
+};
+
+const isIgnoredProperty = propertyName => {
+  return propertyName.startsWith('$');
+};
+
+const findFlowElement = node => {
+  while (node && !is(node, 'bpmn:FlowElement')) {
+    node = node.$parent;
+  }
+
+  return node;
 };