bpmnlint-plugin-camunda-compat 2.20.2 → 2.21.0

package/rules/camunda-cloud/no-expression.js

@@ -1,173 +1,173 @@
-const {
-  is
-} = require('bpmnlint-utils');
-
-const { getPath } = require('@bpmn-io/moddle-utils');
-
-const {
-  ERROR_TYPES,
-  getEventDefinition
-} = require('../utils/element');
-
-const { reportErrors } = require('../utils/reporter');
-
-const { skipInNonExecutableProcess } = require('../utils/rule');
-
-const handlersMap = {
-  '1.0': [
-    checkErrorCode
-  ],
-  '1.1': [
-    checkErrorCode
-  ],
-  '1.2': [
-    checkErrorCode
-  ],
-  '1.3': [
-    checkErrorCode
-  ],
-  '8.0': [
-    checkErrorCode
-  ],
-  '8.1': [
-    checkErrorCode
-  ],
-  '8.2': [
-    checkErrorCatchEvent,
-    checkEscalationCatchEvent
-  ],
-  '8.3': [
-    checkErrorCatchEvent,
-    checkEscalationCatchEvent
-  ]
-};
-
-module.exports = skipInNonExecutableProcess(noExpressionRule);
-
-/**
- * Make sure that certain properties do not contain expressions in older versions.
- * @param {{ version: string }} config
- */
-function noExpressionRule({ version }) {
-  function check(node, reporter) {
-    const errors = checkForVersion(node, version);
-
-    if (errors && errors.length) {
-      reportErrors(node, reporter, errors);
-    }
-  }
-
-  return {
-    check
-  };
-}
-
-function checkForVersion(node, version) {
-  const handlers = handlersMap[version];
-
-  if (!handlers) {
-    return [];
-  }
-
-  return handlers.reduce((errors, handler) => {
-    const handlerErrors = handler(node) || [];
-    return errors.concat(handlerErrors);
-  }, []);
-}
-
-function noExpression(node, propertyName, parentNode, allowedVersion) {
-  const path = getPath(node, parentNode),
-        propertyValue = node.get(propertyName);
-
-  if (!isExpression(propertyValue)) {
-    return;
-  }
-
-  let message = `Expression statement <${ truncate(propertyValue) }> not supported`;
-
-  let data = {
-    type: ERROR_TYPES.EXPRESSION_NOT_ALLOWED,
-    node,
-    parentNode: parentNode == node ? null : parentNode,
-    property: propertyName
-  };
-
-  if (allowedVersion) {
-    message = `Expression statement <${ truncate(propertyValue) }> only supported by Camunda ${allowedVersion} or newer`;
-
-    data = {
-      ...data,
-      allowedVersion
-    };
-  }
-
-  return {
-    message,
-    path: path
-      ? [ ...path, propertyName ]
-      : [ propertyName ],
-    data
-  };
-}
-
-function isExpression(value) {
-  return value && value.startsWith('=');
-}
-
-function checkErrorCode(node) {
-  if (!is(node, 'bpmn:Event')) {
-    return;
-  }
-
-  const eventDefinition = getEventDefinition(node);
-
-  if (!eventDefinition || !is(eventDefinition, 'bpmn:ErrorEventDefinition')) {
-    return;
-  }
-
-  const errorRef = eventDefinition.get('errorRef');
-
-  if (!errorRef) {
-    return;
-  }
-
-  if (is(node, 'bpmn:CatchEvent')) {
-    return noExpression(errorRef, 'errorCode', node, null);
-  } else {
-    return noExpression(errorRef, 'errorCode', node, '8.2');
-  }
-}
-
-function checkErrorCatchEvent(node) {
-  if (!is(node, 'bpmn:CatchEvent')) {
-    return;
-  }
-
-  return checkErrorCode(node);
-}
-
-function checkEscalationCatchEvent(node) {
-  if (!is(node, 'bpmn:CatchEvent')) {
-    return;
-  }
-
-  const eventDefinition = getEventDefinition(node);
-
-  if (!eventDefinition || !is(eventDefinition, 'bpmn:EscalationEventDefinition')) {
-    return;
-  }
-
-  const escalationRef = eventDefinition.get('escalationRef');
-
-  if (!escalationRef) {
-    return;
-  }
-
-  return noExpression(escalationRef, 'escalationCode', node, null);
-}
-
-function truncate(string, maxLength = 10) {
-  const stringified = `${ string }`;
-
-  return stringified.length > maxLength ? `${ stringified.slice(0, maxLength) }...` : stringified;
-}
+const {
+  is
+} = require('bpmnlint-utils');
+
+const { getPath } = require('@bpmn-io/moddle-utils');
+
+const {
+  ERROR_TYPES,
+  getEventDefinition
+} = require('../utils/element');
+
+const { reportErrors } = require('../utils/reporter');
+
+const { skipInNonExecutableProcess } = require('../utils/rule');
+
+const handlersMap = {
+  '1.0': [
+    checkErrorCode
+  ],
+  '1.1': [
+    checkErrorCode
+  ],
+  '1.2': [
+    checkErrorCode
+  ],
+  '1.3': [
+    checkErrorCode
+  ],
+  '8.0': [
+    checkErrorCode
+  ],
+  '8.1': [
+    checkErrorCode
+  ],
+  '8.2': [
+    checkErrorCatchEvent,
+    checkEscalationCatchEvent
+  ],
+  '8.3': [
+    checkErrorCatchEvent,
+    checkEscalationCatchEvent
+  ]
+};
+
+module.exports = skipInNonExecutableProcess(noExpressionRule);
+
+/**
+ * Make sure that certain properties do not contain expressions in older versions.
+ * @param {{ version: string }} config
+ */
+function noExpressionRule({ version }) {
+  function check(node, reporter) {
+    const errors = checkForVersion(node, version);
+
+    if (errors && errors.length) {
+      reportErrors(node, reporter, errors);
+    }
+  }
+
+  return {
+    check
+  };
+}
+
+function checkForVersion(node, version) {
+  const handlers = handlersMap[version];
+
+  if (!handlers) {
+    return [];
+  }
+
+  return handlers.reduce((errors, handler) => {
+    const handlerErrors = handler(node) || [];
+    return errors.concat(handlerErrors);
+  }, []);
+}
+
+function noExpression(node, propertyName, parentNode, allowedVersion) {
+  const path = getPath(node, parentNode),
+        propertyValue = node.get(propertyName);
+
+  if (!isExpression(propertyValue)) {
+    return;
+  }
+
+  let message = `Expression statement <${ truncate(propertyValue) }> not supported`;
+
+  let data = {
+    type: ERROR_TYPES.EXPRESSION_NOT_ALLOWED,
+    node,
+    parentNode: parentNode == node ? null : parentNode,
+    property: propertyName
+  };
+
+  if (allowedVersion) {
+    message = `Expression statement <${ truncate(propertyValue) }> only supported by Camunda ${allowedVersion} or newer`;
+
+    data = {
+      ...data,
+      allowedVersion
+    };
+  }
+
+  return {
+    message,
+    path: path
+      ? [ ...path, propertyName ]
+      : [ propertyName ],
+    data
+  };
+}
+
+function isExpression(value) {
+  return value && value.startsWith('=');
+}
+
+function checkErrorCode(node) {
+  if (!is(node, 'bpmn:Event')) {
+    return;
+  }
+
+  const eventDefinition = getEventDefinition(node);
+
+  if (!eventDefinition || !is(eventDefinition, 'bpmn:ErrorEventDefinition')) {
+    return;
+  }
+
+  const errorRef = eventDefinition.get('errorRef');
+
+  if (!errorRef) {
+    return;
+  }
+
+  if (is(node, 'bpmn:CatchEvent')) {
+    return noExpression(errorRef, 'errorCode', node, null);
+  } else {
+    return noExpression(errorRef, 'errorCode', node, '8.2');
+  }
+}
+
+function checkErrorCatchEvent(node) {
+  if (!is(node, 'bpmn:CatchEvent')) {
+    return;
+  }
+
+  return checkErrorCode(node);
+}
+
+function checkEscalationCatchEvent(node) {
+  if (!is(node, 'bpmn:CatchEvent')) {
+    return;
+  }
+
+  const eventDefinition = getEventDefinition(node);
+
+  if (!eventDefinition || !is(eventDefinition, 'bpmn:EscalationEventDefinition')) {
+    return;
+  }
+
+  const escalationRef = eventDefinition.get('escalationRef');
+
+  if (!escalationRef) {
+    return;
+  }
+
+  return noExpression(escalationRef, 'escalationCode', node, null);
+}
+
+function truncate(string, maxLength = 10) {
+  const stringified = `${ string }`;
+
+  return stringified.length > maxLength ? `${ stringified.slice(0, maxLength) }...` : stringified;
+}

package/rules/camunda-cloud/no-loop.js

@@ -1,146 +1,146 @@
-const { isString } = require('min-dash');
-
-const { is } = require('bpmnlint-utils');
-
-const {
-  findExtensionElement,
-  findParent,
-  isAnyExactly
-} = require('../utils/element');
-
-const { reportErrors } = require('../utils/reporter');
-
-const { ERROR_TYPES } = require('../utils/error-types');
-
-const { skipInNonExecutableProcess } = require('../utils/rule');
-
-const LOOP_REQUIRED_ELEMENT_TYPES = [
-  'bpmn:CallActivity',
-  'bpmn:ManualTask',
-  'bpmn:Task'
-];
-
-const LOOP_ELEMENT_TYPES = [
-  ...LOOP_REQUIRED_ELEMENT_TYPES,
-  'bpmn:StartEvent',
-  'bpmn:EndEvent',
-  'bpmn:ManualTask',
-  'bpmn:ExclusiveGateway',
-  'bpmn:InclusiveGateway',
-  'bpmn:ParallelGateway',
-  'bpmn:SubProcess',
-  'bpmn:Task'
-];
-
-module.exports = skipInNonExecutableProcess(function() {
-  function check(node, reporter) {
-    if (!is(node, 'bpmn:Process')) {
-      return;
-    }
-
-    const error = getFlowElements(node)
-      .filter(flowElement => {
-        return isAnyExactly(flowElement, LOOP_ELEMENT_TYPES);
-      })
-      .reduce((error, flowElement) => {
-        return error || findLoop(flowElement, node);
-      }, null);
-
-    if (error) {
-      reportErrors(node, reporter, error);
-    }
-  }
-
-  return {
-    check
-  };
-});
-
-function findLoop(flowElement, parentElement, visitedFlowElements = []) {
-
-  // (1.1) is not a loop
-  if (!isAnyExactly(flowElement, LOOP_ELEMENT_TYPES)) {
-    return null;
-  }
-
-  const nextFlowElements = getNextFlowElements(flowElement);
-
-  // (1.2) is not a loop
-  if (!nextFlowElements.length) {
-    return null;
-  }
-
-  // (2) may be a loop
-  if (!visitedFlowElements.includes(flowElement)) {
-    return nextFlowElements.reduce((error, nextFlowElement) => {
-      return error || findLoop(nextFlowElement, parentElement, [ ...visitedFlowElements, flowElement ]);
-    }, null);
-  }
-
-  // (3) is a loop but ignored
-  if (isIgnoredLoop(visitedFlowElements)) {
-    return null;
-  }
-
-  const elements = visitedFlowElements.slice(visitedFlowElements.indexOf(flowElement));
-
-  // (4) is a loop
-  return {
-    message: `Loop detected: ${ elements.map(({ id }) => id).join(' -> ') } -> ${ flowElement.id }`,
-    path: null,
-    data: {
-      type: ERROR_TYPES.LOOP_NOT_ALLOWED,
-      node: parentElement,
-      parentNode: null,
-      elements: elements.map(({ id }) => id)
-    }
-  };
-}
-
-function getFlowElements(node) {
-  return node.get('flowElements').reduce((flowElements, flowElement) => {
-    if (is(flowElement, 'bpmn:FlowElementsContainer')) {
-      return [ ...flowElements, ...getFlowElements(flowElement) ];
-    }
-
-    return [ ...flowElements, flowElement ];
-  }, []);
-}
-
-function getNextFlowElements(flowElement) {
-  if (is(flowElement, 'bpmn:CallActivity')) {
-    const calledElement = findExtensionElement(flowElement, 'zeebe:CalledElement');
-
-    if (calledElement) {
-      const processId = calledElement.get('processId');
-
-      if (isString(processId) && !isFeel(processId)) {
-        const process = findParent(flowElement, 'bpmn:Process');
-
-        if (process && process.get('id') === processId) {
-          return process.get('flowElements').filter(flowElement => is(flowElement, 'bpmn:StartEvent'));
-        }
-      }
-    }
-  } else if (is(flowElement, 'bpmn:SubProcess')) {
-    return flowElement
-      .get('flowElements').filter(flowElement => is(flowElement, 'bpmn:StartEvent'));
-  } else if (is(flowElement, 'bpmn:EndEvent')) {
-    const parent = flowElement.$parent;
-
-    if (is(parent, 'bpmn:SubProcess')) {
-      flowElement = parent;
-    }
-  }
-
-  return flowElement
-    .get('outgoing').filter(outgoing => is(outgoing, 'bpmn:SequenceFlow')).map(sequenceFlow => sequenceFlow.get('targetRef'));
-}
-
-function isIgnoredLoop(elements) {
-  return !elements.some(element => isAnyExactly(element, LOOP_REQUIRED_ELEMENT_TYPES));
-}
-
-function isFeel(value) {
-  return isString(value) && value.startsWith('=');
+const { isString } = require('min-dash');
+
+const { is } = require('bpmnlint-utils');
+
+const {
+  findExtensionElement,
+  findParent,
+  isAnyExactly
+} = require('../utils/element');
+
+const { reportErrors } = require('../utils/reporter');
+
+const { ERROR_TYPES } = require('../utils/error-types');
+
+const { skipInNonExecutableProcess } = require('../utils/rule');
+
+const LOOP_REQUIRED_ELEMENT_TYPES = [
+  'bpmn:CallActivity',
+  'bpmn:ManualTask',
+  'bpmn:Task'
+];
+
+const LOOP_ELEMENT_TYPES = [
+  ...LOOP_REQUIRED_ELEMENT_TYPES,
+  'bpmn:StartEvent',
+  'bpmn:EndEvent',
+  'bpmn:ManualTask',
+  'bpmn:ExclusiveGateway',
+  'bpmn:InclusiveGateway',
+  'bpmn:ParallelGateway',
+  'bpmn:SubProcess',
+  'bpmn:Task'
+];
+
+module.exports = skipInNonExecutableProcess(function() {
+  function check(node, reporter) {
+    if (!is(node, 'bpmn:Process')) {
+      return;
+    }
+
+    const error = getFlowElements(node)
+      .filter(flowElement => {
+        return isAnyExactly(flowElement, LOOP_ELEMENT_TYPES);
+      })
+      .reduce((error, flowElement) => {
+        return error || findLoop(flowElement, node);
+      }, null);
+
+    if (error) {
+      reportErrors(node, reporter, error);
+    }
+  }
+
+  return {
+    check
+  };
+});
+
+function findLoop(flowElement, parentElement, visitedFlowElements = []) {
+
+  // (1.1) is not a loop
+  if (!isAnyExactly(flowElement, LOOP_ELEMENT_TYPES)) {
+    return null;
+  }
+
+  const nextFlowElements = getNextFlowElements(flowElement);
+
+  // (1.2) is not a loop
+  if (!nextFlowElements.length) {
+    return null;
+  }
+
+  // (2) may be a loop
+  if (!visitedFlowElements.includes(flowElement)) {
+    return nextFlowElements.reduce((error, nextFlowElement) => {
+      return error || findLoop(nextFlowElement, parentElement, [ ...visitedFlowElements, flowElement ]);
+    }, null);
+  }
+
+  // (3) is a loop but ignored
+  if (isIgnoredLoop(visitedFlowElements)) {
+    return null;
+  }
+
+  const elements = visitedFlowElements.slice(visitedFlowElements.indexOf(flowElement));
+
+  // (4) is a loop
+  return {
+    message: `Loop detected: ${ elements.map(({ id }) => id).join(' -> ') } -> ${ flowElement.id }`,
+    path: null,
+    data: {
+      type: ERROR_TYPES.LOOP_NOT_ALLOWED,
+      node: parentElement,
+      parentNode: null,
+      elements: elements.map(({ id }) => id)
+    }
+  };
+}
+
+function getFlowElements(node) {
+  return node.get('flowElements').reduce((flowElements, flowElement) => {
+    if (is(flowElement, 'bpmn:FlowElementsContainer')) {
+      return [ ...flowElements, ...getFlowElements(flowElement) ];
+    }
+
+    return [ ...flowElements, flowElement ];
+  }, []);
+}
+
+function getNextFlowElements(flowElement) {
+  if (is(flowElement, 'bpmn:CallActivity')) {
+    const calledElement = findExtensionElement(flowElement, 'zeebe:CalledElement');
+
+    if (calledElement) {
+      const processId = calledElement.get('processId');
+
+      if (isString(processId) && !isFeel(processId)) {
+        const process = findParent(flowElement, 'bpmn:Process');
+
+        if (process && process.get('id') === processId) {
+          return process.get('flowElements').filter(flowElement => is(flowElement, 'bpmn:StartEvent'));
+        }
+      }
+    }
+  } else if (is(flowElement, 'bpmn:SubProcess')) {
+    return flowElement
+      .get('flowElements').filter(flowElement => is(flowElement, 'bpmn:StartEvent'));
+  } else if (is(flowElement, 'bpmn:EndEvent')) {
+    const parent = flowElement.$parent;
+
+    if (is(parent, 'bpmn:SubProcess')) {
+      flowElement = parent;
+    }
+  }
+
+  return flowElement
+    .get('outgoing').filter(outgoing => is(outgoing, 'bpmn:SequenceFlow')).map(sequenceFlow => sequenceFlow.get('targetRef'));
+}
+
+function isIgnoredLoop(elements) {
+  return !elements.some(element => isAnyExactly(element, LOOP_REQUIRED_ELEMENT_TYPES));
+}
+
+function isFeel(value) {
+  return isString(value) && value.startsWith('=');
 }