bpmnlint-plugin-camunda-compat 2.17.0 → 2.19.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 formIdAllowedVersions = {
-  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 = formIdAllowedVersions[ 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 formIdAllowedVersions = {
+  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 = formIdAllowedVersions[ 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

@@ -0,0 +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
+  };
+}

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

@@ -1,20 +1,20 @@
-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 {
-    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 {
+    check
+  };
 });

package/rules/utils/cron.js

@@ -1,95 +1,95 @@
-const MACROS = [
-  '@yearly',
-  '@annually',
-  '@monthly',
-  '@weekly',
-  '@daily',
-  '@midnight',
-  '@hourly'
-];
-const MACRO_REGEX = new RegExp(`^(${ MACROS.join('|') })$`);
-
-function validateMacro(text) {
-  return MACRO_REGEX.test(text);
-}
-
-const ASTERISK = '\\*';
-const QUESTION_MARK = '\\?';
-const COMMA = ',';
-
-const SECOND = '([0-5]?[0-9])';
-const MINUTE = '([0-5]?[0-9])';
-const HOUR = '([01]?[0-9]|2[0-3])';
-const DAY_OF_MONTH = or(`L(-${ or('[0-2]?[0-9]', '3[0-1]') })?`, '[0-2]?[0-9]', '3[0-1]', dayOfMonthSuffix(or('L', '[0-2]?[0-9]', '3[0-1]')));
-
-const MONTHS = [
-  'JAN',
-  'FEB',
-  'MAR',
-  'APR',
-  'MAY',
-  'JUN',
-  'JUL',
-  'AUG',
-  'SEP',
-  'OCT',
-  'NOV',
-  'DEC'
-];
-const MONTH = or('[0]?[1-9]', '1[0-2]', ...MONTHS);
-
-const WEEK_DAYS = [
-  'MON',
-  'TUE',
-  'WED',
-  'THU',
-  'FRI',
-  'SAT',
-  'SUN'
-];
-const DAY_OF_WEEK = or('[0-7]', ...WEEK_DAYS);
-
-const SECOND_REGEX = or(ASTERISK, interval(ASTERISK), commaSeparated(or(interval(SECOND), optionalRange(SECOND))));
-const MINUTE_REGEX = or(ASTERISK, interval(ASTERISK), commaSeparated(or(interval(MINUTE), optionalRange(MINUTE))));
-const HOUR_REGEX = or(ASTERISK, interval(ASTERISK), commaSeparated(or(interval(HOUR), optionalRange(HOUR))));
-const DAY_OF_MONTH_REGEX = or(ASTERISK, QUESTION_MARK, commaSeparated(optionalRange(DAY_OF_MONTH)));
-const MONTH_REGEX = or(ASTERISK, commaSeparated(optionalRange(MONTH)));
-const DAY_OF_WEEK_REGEX = or(ASTERISK, QUESTION_MARK, commaSeparated(or(optionalRange(DAY_OF_WEEK), dayOfWeekSuffix(DAY_OF_WEEK))));
-
-const CRON_REGEX = new RegExp(`^${ SECOND_REGEX } ${ MINUTE_REGEX } ${ HOUR_REGEX } ${ DAY_OF_MONTH_REGEX } ${ MONTH_REGEX } ${ DAY_OF_WEEK_REGEX }$`, 'i');
-
-function validateCron(value) {
-  return CRON_REGEX.test(value);
-}
-
-module.exports.validateCronExpression = function(value) {
-  return validateMacro(value) || validateCron(value);
-};
-
-
-
-// helper //////////////
-
-function or(...patterns) {
-  return `(${patterns.join('|')})`;
-}
-
-function optionalRange(pattern) {
-  return `${pattern}(-${pattern})?`;
-}
-
-function commaSeparated(pattern) {
-  return `${pattern}(${COMMA}${pattern})*`;
-}
-
-function interval(pattern) {
-  return `${pattern}/\\d+`;
-}
-
-function dayOfMonthSuffix(pattern) {
-  return `${pattern}W`;
-}
-
-function dayOfWeekSuffix(pattern) {
-  return `${pattern}(#[1-5]|L)`;
-}
+const MACROS = [
+  '@yearly',
+  '@annually',
+  '@monthly',
+  '@weekly',
+  '@daily',
+  '@midnight',
+  '@hourly'
+];
+const MACRO_REGEX = new RegExp(`^(${ MACROS.join('|') })$`);
+
+function validateMacro(text) {
+  return MACRO_REGEX.test(text);
+}
+
+const ASTERISK = '\\*';
+const QUESTION_MARK = '\\?';
+const COMMA = ',';
+
+const SECOND = '([0-5]?[0-9])';
+const MINUTE = '([0-5]?[0-9])';
+const HOUR = '([01]?[0-9]|2[0-3])';
+const DAY_OF_MONTH = or(`L(-${ or('[0-2]?[0-9]', '3[0-1]') })?`, '[0-2]?[0-9]', '3[0-1]', dayOfMonthSuffix(or('L', '[0-2]?[0-9]', '3[0-1]')));
+
+const MONTHS = [
+  'JAN',
+  'FEB',
+  'MAR',
+  'APR',
+  'MAY',
+  'JUN',
+  'JUL',
+  'AUG',
+  'SEP',
+  'OCT',
+  'NOV',
+  'DEC'
+];
+const MONTH = or('[0]?[1-9]', '1[0-2]', ...MONTHS);
+
+const WEEK_DAYS = [
+  'MON',
+  'TUE',
+  'WED',
+  'THU',
+  'FRI',
+  'SAT',
+  'SUN'
+];
+const DAY_OF_WEEK = or('[0-7]', ...WEEK_DAYS);
+
+const SECOND_REGEX = or(ASTERISK, interval(ASTERISK), commaSeparated(or(interval(SECOND), optionalRange(SECOND))));
+const MINUTE_REGEX = or(ASTERISK, interval(ASTERISK), commaSeparated(or(interval(MINUTE), optionalRange(MINUTE))));
+const HOUR_REGEX = or(ASTERISK, interval(ASTERISK), commaSeparated(or(interval(HOUR), optionalRange(HOUR))));
+const DAY_OF_MONTH_REGEX = or(ASTERISK, QUESTION_MARK, commaSeparated(optionalRange(DAY_OF_MONTH)));
+const MONTH_REGEX = or(ASTERISK, commaSeparated(optionalRange(MONTH)));
+const DAY_OF_WEEK_REGEX = or(ASTERISK, QUESTION_MARK, commaSeparated(or(optionalRange(DAY_OF_WEEK), dayOfWeekSuffix(DAY_OF_WEEK))));
+
+const CRON_REGEX = new RegExp(`^${ SECOND_REGEX } ${ MINUTE_REGEX } ${ HOUR_REGEX } ${ DAY_OF_MONTH_REGEX } ${ MONTH_REGEX } ${ DAY_OF_WEEK_REGEX }$`, 'i');
+
+function validateCron(value) {
+  return CRON_REGEX.test(value);
+}
+
+module.exports.validateCronExpression = function(value) {
+  return validateMacro(value) || validateCron(value);
+};
+
+
+
+// helper //////////////
+
+function or(...patterns) {
+  return `(${patterns.join('|')})`;
+}
+
+function optionalRange(pattern) {
+  return `${pattern}(-${pattern})?`;
+}
+
+function commaSeparated(pattern) {
+  return `${pattern}(${COMMA}${pattern})*`;
+}
+
+function interval(pattern) {
+  return `${pattern}/\\d+`;
+}
+
+function dayOfMonthSuffix(pattern) {
+  return `${pattern}W`;
+}
+
+function dayOfWeekSuffix(pattern) {
+  return `${pattern}(#[1-5]|L)`;
+}