bpmnlint-plugin-camunda-compat 2.35.0 → 2.36.0

package/rules/camunda-cloud/user-task-form.js

@@ -1,142 +1,142 @@
-const { is } = require('bpmnlint-utils');
-
-const {
-  findExtensionElement,
-  findExtensionElements,
-  findParent,
-  hasProperties,
-  hasProperty
-} = require('../utils/element');
-
-const { reportErrors } = require('../utils/reporter');
-
-const { skipInNonExecutableProcess } = require('../utils/rule');
-
-const { greaterOrEqual } = require('../utils/version');
-
-const FORM_ID_ALLOWED_VERSIONS = {
-  desktop: '8.4',
-  web: '8.0'
-};
-
-const ZEEBE_USER_TASK_VERSION = '8.5';
-
-module.exports = skipInNonExecutableProcess(function({ modeler = 'desktop', version }) {
-  function check(node, reporter) {
-    if (!is(node, 'bpmn:UserTask')) {
-      return;
-    }
-
-    const formDefinition = findExtensionElement(node, 'zeebe:FormDefinition');
-
-    if (!formDefinition) {
-      return;
-    }
-
-    // handle Zebee User Task
-    if (isZeebeUserTask(node)) {
-
-      // handled by no-zeebe-user-task rule
-      if (!greaterOrEqual(version, ZEEBE_USER_TASK_VERSION)) {
-        return;
-      }
-
-      const errors = hasProperty(formDefinition, [
-        'externalReference',
-        'formId'
-      ], node) || [];
-
-      if (errors.length) {
-        reportErrors(node, reporter, errors);
-      }
-
-      return;
-    }
-
-    let errors;
-
-    const formIdAllowedVersion = FORM_ID_ALLOWED_VERSIONS[ modeler ];
-
-    if (isFormIdAllowed(version, formIdAllowedVersion)) {
-      errors = hasProperty(formDefinition, [
-        'formKey',
-        'formId'
-      ], node);
-    } else {
-      errors = hasProperties(formDefinition, {
-        formId: {
-          allowed: false,
-          allowedVersion: formIdAllowedVersion
-        }
-      }, node);
-
-      if (errors.length) {
-        reportErrors(node, reporter, errors);
-
-        return;
-      }
-
-      errors = hasProperties(formDefinition, {
-        formKey: {
-          required: true
-        }
-      }, node);
-    }
-
-    if (errors.length) {
-      reportErrors(node, reporter, errors);
-
-      return;
-    }
-
-    const formKey = formDefinition.get('formKey');
-
-    const userTaskForm = findUserTaskForm(node, formKey);
-
-    if (!userTaskForm) {
-      return;
-    }
-
-    errors = hasProperties(userTaskForm, {
-      body: {
-        required: true
-      }
-    }, node);
-
-    if (errors.length) {
-      reportErrors(node, reporter, errors);
-    }
-  }
-
-  return {
-    check
-  };
-});
-
-// helpers //////////
-
-function findUserTaskForm(node, formKey) {
-  const process = findParent(node, 'bpmn:Process');
-
-  if (!process) {
-    return;
-  }
-
-  const userTaskForms = findExtensionElements(process, 'zeebe:UserTaskForm');
-
-  if (userTaskForms && userTaskForms.length) {
-    return userTaskForms.find(userTaskForm => {
-      const id = userTaskForm.get('id');
-
-      return `camunda-forms:bpmn:${ id }` === formKey;
-    });
-  }
-}
-
-function isFormIdAllowed(version, formIdAllowedVersion) {
-  return greaterOrEqual(version, formIdAllowedVersion);
-}
-
-function isZeebeUserTask(node) {
-  return !!findExtensionElement(node, 'zeebe:UserTask');
-}
+const { is } = require('bpmnlint-utils');
+
+const {
+  findExtensionElement,
+  findExtensionElements,
+  findParent,
+  hasProperties,
+  hasProperty
+} = require('../utils/element');
+
+const { reportErrors } = require('../utils/reporter');
+
+const { skipInNonExecutableProcess } = require('../utils/rule');
+
+const { greaterOrEqual } = require('../utils/version');
+
+const FORM_ID_ALLOWED_VERSIONS = {
+  desktop: '8.4',
+  web: '8.0'
+};
+
+const ZEEBE_USER_TASK_VERSION = '8.5';
+
+module.exports = skipInNonExecutableProcess(function({ modeler = 'desktop', version }) {
+  function check(node, reporter) {
+    if (!is(node, 'bpmn:UserTask')) {
+      return;
+    }
+
+    const formDefinition = findExtensionElement(node, 'zeebe:FormDefinition');
+
+    if (!formDefinition) {
+      return;
+    }
+
+    // handle Zebee User Task
+    if (isZeebeUserTask(node)) {
+
+      // handled by no-zeebe-user-task rule
+      if (!greaterOrEqual(version, ZEEBE_USER_TASK_VERSION)) {
+        return;
+      }
+
+      const errors = hasProperty(formDefinition, [
+        'externalReference',
+        'formId'
+      ], node) || [];
+
+      if (errors.length) {
+        reportErrors(node, reporter, errors);
+      }
+
+      return;
+    }
+
+    let errors;
+
+    const formIdAllowedVersion = FORM_ID_ALLOWED_VERSIONS[ modeler ];
+
+    if (isFormIdAllowed(version, formIdAllowedVersion)) {
+      errors = hasProperty(formDefinition, [
+        'formKey',
+        'formId'
+      ], node);
+    } else {
+      errors = hasProperties(formDefinition, {
+        formId: {
+          allowed: false,
+          allowedVersion: formIdAllowedVersion
+        }
+      }, node);
+
+      if (errors.length) {
+        reportErrors(node, reporter, errors);
+
+        return;
+      }
+
+      errors = hasProperties(formDefinition, {
+        formKey: {
+          required: true
+        }
+      }, node);
+    }
+
+    if (errors.length) {
+      reportErrors(node, reporter, errors);
+
+      return;
+    }
+
+    const formKey = formDefinition.get('formKey');
+
+    const userTaskForm = findUserTaskForm(node, formKey);
+
+    if (!userTaskForm) {
+      return;
+    }
+
+    errors = hasProperties(userTaskForm, {
+      body: {
+        required: true
+      }
+    }, node);
+
+    if (errors.length) {
+      reportErrors(node, reporter, errors);
+    }
+  }
+
+  return {
+    check
+  };
+});
+
+// helpers //////////
+
+function findUserTaskForm(node, formKey) {
+  const process = findParent(node, 'bpmn:Process');
+
+  if (!process) {
+    return;
+  }
+
+  const userTaskForms = findExtensionElements(process, 'zeebe:UserTaskForm');
+
+  if (userTaskForms && userTaskForms.length) {
+    return userTaskForms.find(userTaskForm => {
+      const id = userTaskForm.get('id');
+
+      return `camunda-forms:bpmn:${ id }` === formKey;
+    });
+  }
+}
+
+function isFormIdAllowed(version, formIdAllowedVersion) {
+  return greaterOrEqual(version, formIdAllowedVersion);
+}
+
+function isZeebeUserTask(node) {
+  return !!findExtensionElement(node, 'zeebe:UserTask');
+}

package/rules/camunda-cloud/wait-for-completion.js

@@ -1,46 +1,46 @@
-const {
-  is
-} = require('bpmnlint-utils');
-
-const {
-  getEventDefinition,
-  hasProperties
-} = require('../utils/element');
-
-const { reportErrors } = require('../utils/reporter');
-
-const { skipInNonExecutableProcess } = require('../utils/rule');
-
-module.exports = skipInNonExecutableProcess(waitForCompletion);
-
-/**
- * Make sure that wait for completion is NOT set to false.
- */
-function waitForCompletion() {
-  function check(node, reporter) {
-    if (!is(node, 'bpmn:ThrowEvent')) {
-      return;
-    }
-
-    const eventDefinition = getEventDefinition(node);
-
-    if (!eventDefinition || !is(eventDefinition, 'bpmn:CompensateEventDefinition')) {
-      return;
-    }
-
-    const errors = hasProperties(eventDefinition, {
-      waitForCompletion: {
-        value: true
-      }
-    }, node);
-
-    if (errors && errors.length) {
-      reportErrors(node, reporter, errors);
-    }
-  }
-
-
-  return {
-    check
-  };
-}
+const {
+  is
+} = require('bpmnlint-utils');
+
+const {
+  getEventDefinition,
+  hasProperties
+} = require('../utils/element');
+
+const { reportErrors } = require('../utils/reporter');
+
+const { skipInNonExecutableProcess } = require('../utils/rule');
+
+module.exports = skipInNonExecutableProcess(waitForCompletion);
+
+/**
+ * Make sure that wait for completion is NOT set to false.
+ */
+function waitForCompletion() {
+  function check(node, reporter) {
+    if (!is(node, 'bpmn:ThrowEvent')) {
+      return;
+    }
+
+    const eventDefinition = getEventDefinition(node);
+
+    if (!eventDefinition || !is(eventDefinition, 'bpmn:CompensateEventDefinition')) {
+      return;
+    }
+
+    const errors = hasProperties(eventDefinition, {
+      waitForCompletion: {
+        value: true
+      }
+    }, node);
+
+    if (errors && errors.length) {
+      reportErrors(node, reporter, errors);
+    }
+  }
+
+
+  return {
+    check
+  };
+}

package/rules/camunda-cloud/zeebe-user-task.js

@@ -1,30 +1,30 @@
-const { is } = require('bpmnlint-utils');
-
-const { reportErrors } = require('../utils/reporter');
-
-const { skipInNonExecutableProcess } = require('../utils/rule');
-
-const { hasExtensionElement } = require('../utils/element');
-
-module.exports = skipInNonExecutableProcess(function() {
-  function check(node, reporter) {
-    if (!is(node, 'bpmn:UserTask')) {
-      return;
-    }
-
-    const errors = hasExtensionElement(node, 'zeebe:UserTask', node);
-
-    if (errors && errors.length) {
-      reportErrors(node, reporter, errors);
-    }
-  }
-
-  return {
-    meta: {
-      documentation: {
-        url: 'https://docs.camunda.io/docs/next/apis-tools/migration-manuals/migrate-to-camunda-user-tasks'
-      }
-    },
-    check
-  };
-});
+const { is } = require('bpmnlint-utils');
+
+const { reportErrors } = require('../utils/reporter');
+
+const { skipInNonExecutableProcess } = require('../utils/rule');
+
+const { hasExtensionElement } = require('../utils/element');
+
+module.exports = skipInNonExecutableProcess(function() {
+  function check(node, reporter) {
+    if (!is(node, 'bpmn:UserTask')) {
+      return;
+    }
+
+    const errors = hasExtensionElement(node, 'zeebe:UserTask', node);
+
+    if (errors && errors.length) {
+      reportErrors(node, reporter, errors);
+    }
+  }
+
+  return {
+    meta: {
+      documentation: {
+        url: 'https://docs.camunda.io/docs/next/apis-tools/migration-manuals/migrate-to-camunda-user-tasks'
+      }
+    },
+    check
+  };
+});

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

@@ -1,22 +1,25 @@
-const { is } = require('bpmnlint-utils');
-
-const { annotateRule } = require('../helper');
-
-const { skipInNonExecutableProcess } = require('../utils/rule');
-
-module.exports = skipInNonExecutableProcess(function() {
-  function check(node, reporter) {
-
-    if (!is(node, 'bpmn:Process')) {
-      return;
-    }
-
-    if (!node.get('camunda:historyTimeToLive')) {
-      reporter.report(node.id, 'Property <historyTimeToLive> should be configured on <bpmn:Process> or engine level.', [ 'historyTimeToLive' ]);
-    }
-  }
-
-  return annotateRule('history-time-to-live', {
-    check
-  });
+const { is } = require('bpmnlint-utils');
+
+const { skipInNonExecutableProcess } = require('../utils/rule');
+
+module.exports = skipInNonExecutableProcess(function() {
+  function check(node, reporter) {
+
+    if (!is(node, 'bpmn:Process')) {
+      return;
+    }
+
+    if (!node.get('camunda:historyTimeToLive')) {
+      reporter.report(node.id, 'Property <historyTimeToLive> should be configured on <bpmn:Process> or engine level.', [ 'historyTimeToLive' ]);
+    }
+  }
+
+  return {
+    meta: {
+      documentation: {
+        url: 'https://docs.camunda.org/manual/latest/modeler/history-time-to-live/'
+      }
+    },
+    check
+  };
 });

package/rules/helper.js

@@ -1,39 +1,39 @@
-const modelingGuidanceBaseUrl = 'https://docs.camunda.io/docs/next/components/modeler/reference/modeling-guidance/rules';
-
-/**
- * @typedef { any } RuleDefinition
- */
-
-/**
- * Annotate a rule with core information, such as the documentation url.
- *
- * @param { string } ruleName
- * @param { RuleDefinition } options
- *
- * @return { RuleDefinition }
- */
-function annotateRule(ruleName, options) {
-
-  const {
-    meta: {
-      documentation = {},
-      ...restMeta
-    } = {},
-    ...restOptions
-  } = options;
-
-  const documentationUrl = `${modelingGuidanceBaseUrl}/${ruleName}/`;
-
-  return {
-    meta: {
-      documentation: {
-        url: documentationUrl,
-        ...documentation
-      },
-      ...restMeta
-    },
-    ...restOptions
-  };
-}
-
+const modelingGuidanceBaseUrl = 'https://docs.camunda.io/docs/next/components/modeler/reference/modeling-guidance/rules';
+
+/**
+ * @typedef { any } RuleDefinition
+ */
+
+/**
+ * Annotate a rule with core information, such as the documentation url.
+ *
+ * @param { string } ruleName
+ * @param { RuleDefinition } options
+ *
+ * @return { RuleDefinition }
+ */
+function annotateRule(ruleName, options) {
+
+  const {
+    meta: {
+      documentation = {},
+      ...restMeta
+    } = {},
+    ...restOptions
+  } = options;
+
+  const documentationUrl = `${modelingGuidanceBaseUrl}/${ruleName}/`;
+
+  return {
+    meta: {
+      documentation: {
+        url: documentationUrl,
+        ...documentation
+      },
+      ...restMeta
+    },
+    ...restOptions
+  };
+}
+
 module.exports.annotateRule = annotateRule;