bpmnlint-plugin-camunda-compat 2.11.1 → 2.13.0

package/index.js

@@ -20,7 +20,7 @@ const camundaCloud10Rules = withConfig({
   'no-template': 'error',
   'no-zeebe-properties': 'error',
   'sequence-flow-condition': 'error',
-  'start-form': 'error',
+  'start-event-form': 'error',
   'subscription': 'error',
   'timer': 'error',
   'user-task-form': 'error',
@@ -56,15 +56,13 @@ const camundaCloud82Rules = withConfig({
 }, { version: '8.2' });
 
 const camundaCloud83Rules = withConfig({
-  ...omit(camundaCloud82Rules, [
-    'start-form',
-    'no-signal-event-sub-process'
-  ]),
+  ...omit(camundaCloud82Rules, 'no-signal-event-sub-process'),
   'secrets': 'warn',
   'signal-reference': 'error'
 }, { version: '8.3' });
 
-const camundaCloud84Rules = withConfig(camundaCloud83Rules, { version: '8.4' });
+const camundaCloud84Rules = withConfig(
+  omit(camundaCloud83Rules, 'collapsed-subprocess'), { version: '8.4' });
 
 const camundaPlatform719Rules = withConfig({
   'history-time-to-live': 'error'
@@ -112,7 +110,7 @@ const rules = {
   'secrets': './rules/camunda-cloud/secrets',
   'sequence-flow-condition': './rules/camunda-cloud/sequence-flow-condition',
   'signal-reference': './rules/camunda-cloud/signal-reference',
-  'start-form': './rules/camunda-cloud/start-form',
+  'start-event-form': './rules/camunda-cloud/start-event-form',
   'subscription': './rules/camunda-cloud/subscription',
   'task-schedule': './rules/camunda-cloud/task-schedule',
   'timer': './rules/camunda-cloud/timer',

package/package.json

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

package/rules/camunda-cloud/collapsed-subprocess.js

@@ -20,7 +20,8 @@ module.exports = skipInNonExecutableProcess(function() {
       data: {
         type: ERROR_TYPES.ELEMENT_COLLAPSED_NOT_ALLOWED,
         node: node,
-        parentNode: null
+        parentNode: null,
+        allowedVersion: '8.4'
       }
     };
 

package/rules/camunda-cloud/start-event-form.js

@@ -0,0 +1,98 @@
+const { is } = require('bpmnlint-utils');
+
+const {
+  findExtensionElement,
+  findExtensionElements,
+  findParent,
+  hasProperties,
+  hasProperty
+} = require('../utils/element');
+
+const { hasNoExtensionElement } = require('../utils/element');
+
+const { reportErrors } = require('../utils/reporter');
+
+const { skipInNonExecutableProcess } = require('../utils/rule');
+
+const { greaterOrEqual } = require('../utils/version');
+
+const allowedVersion = '8.3';
+
+module.exports = skipInNonExecutableProcess(function({ version }) {
+  function check(node, reporter) {
+    if (!is(node, 'bpmn:StartEvent')) {
+      return;
+    }
+
+    // Camunda 8.2 and older
+    if (!greaterOrEqual(version, allowedVersion)) {
+      let errors = hasNoExtensionElement(node, 'zeebe:FormDefinition', node, allowedVersion);
+
+      if (errors.length) {
+        reportErrors(node, reporter, errors);
+      }
+
+      return;
+    }
+
+    // Camunda 8.3 and newer
+    const formDefinition = findExtensionElement(node, 'zeebe:FormDefinition');
+
+    if (!formDefinition) {
+      return;
+    }
+
+    let errors = hasProperty(formDefinition, [
+      'formKey',
+      'formId'
+    ], 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;
+    });
+  }
+}

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

@@ -14,9 +14,12 @@ const { skipInNonExecutableProcess } = require('../utils/rule');
 
 const { greaterOrEqual } = require('../utils/version');
 
-const formIdAllowedVersion = '8.4';
+const formIdAllowedVersions = {
+  desktop: '8.4',
+  web: '8.0'
+};
 
-module.exports = skipInNonExecutableProcess(function({ version }) {
+module.exports = skipInNonExecutableProcess(function({ modeler = 'desktop', version }) {
   function check(node, reporter) {
     if (!is(node, 'bpmn:UserTask')) {
       return;
@@ -30,16 +33,14 @@ module.exports = skipInNonExecutableProcess(function({ version }) {
 
     let errors = [];
 
-    if (isFormIdAllowed(version)) {
+    const formIdAllowedVersion = formIdAllowedVersions[ modeler ];
 
-      // Camunda 8.3 and newer
+    if (isFormIdAllowed(version, formIdAllowedVersion)) {
       errors = hasProperty(formDefinition, [
         'formKey',
         'formId'
       ], node);
     } else {
-
-      // Camunda 8.2 and older
       errors = hasProperties(formDefinition, {
         formId: {
           allowed: false,
@@ -110,6 +111,6 @@ function findUserTaskForm(node, formKey) {
   }
 }
 
-function isFormIdAllowed(version) {
+function isFormIdAllowed(version, formIdAllowedVersion) {
   return greaterOrEqual(version, formIdAllowedVersion);
 }

package/rules/camunda-cloud/start-form.js

@@ -1,29 +0,0 @@
-const { is } = require('bpmnlint-utils');
-
-const { hasNoExtensionElement } = require('../utils/element');
-
-const { reportErrors } = require('../utils/reporter');
-
-const { skipInNonExecutableProcess } = require('../utils/rule');
-
-const { greaterOrEqual } = require('../utils/version');
-
-const startFormAllowedVersion = '8.3';
-
-module.exports = skipInNonExecutableProcess(function({ version }) {
-  function check(node, reporter) {
-    if (!is(node, 'bpmn:StartEvent') || greaterOrEqual(version, startFormAllowedVersion)) {
-      return;
-    }
-
-    let errors = hasNoExtensionElement(node, 'zeebe:FormDefinition', node, startFormAllowedVersion);
-
-    if (errors.length) {
-      reportErrors(node, reporter, errors);
-    }
-  }
-
-  return {
-    check
-  };
-});