bpmnlint-plugin-camunda-compat 0.8.0 → 0.9.2

package/CHANGELOG.md

@@ -6,6 +6,18 @@ All notable changes to [bpmnlint-plugin-camunda-compat](https://github.com/camun
 
 ___Note:__ Yet to be released changes appear here._
 
+## 0.9.2
+
+* `FIX`: ignore null properties ([#39](https://github.com/camunda/bpmnlint-plugin-camunda-compat/pull/39))
+
+## 0.9.1
+
+* `FIX`: add name to reports ([#38](https://github.com/camunda/bpmnlint-plugin-camunda-compat/pull/38))
+
+## 0.9.0
+
+* `FEAT`: add user task forms rule ([#32](https://github.com/camunda/bpmnlint-plugin-camunda-compat/pull/32))
+
 ## 0.8.0
 
 * `FEAT`: add templates rule ([#31](https://github.com/camunda/bpmnlint-plugin-camunda-compat/pull/31))

package/index.js

@@ -12,7 +12,8 @@ module.exports = {
         'loop-characteristics': 'error',
         'message-reference': 'error',
         'no-template': 'error',
-        'subscription': 'error'
+        'subscription': 'error',
+        'user-task-form': 'error'
       }
     },
     'camunda-cloud-1-1': {
@@ -24,7 +25,8 @@ module.exports = {
         'loop-characteristics': 'error',
         'message-reference': 'error',
         'no-template': 'error',
-        'subscription': 'error'
+        'subscription': 'error',
+        'user-task-form': 'error'
       }
     },
     'camunda-cloud-1-2': {
@@ -36,7 +38,8 @@ module.exports = {
         'loop-characteristics': 'error',
         'message-reference': 'error',
         'no-template': 'error',
-        'subscription': 'error'
+        'subscription': 'error',
+        'user-task-form': 'error'
       }
     },
     'camunda-cloud-1-3': {
@@ -48,7 +51,8 @@ module.exports = {
         'loop-characteristics': 'error',
         'message-reference': 'error',
         'no-template': 'error',
-        'subscription': 'error'
+        'subscription': 'error',
+        'user-task-form': 'error'
       }
     },
     'camunda-cloud-8-0': {
@@ -59,7 +63,8 @@ module.exports = {
         'error-reference': 'error',
         'loop-characteristics': 'error',
         'message-reference': 'error',
-        'subscription': 'error'
+        'subscription': 'error',
+        'user-task-form': 'error'
       }
     }
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bpmnlint-plugin-camunda-compat",
-  "version": "0.8.0",
+  "version": "0.9.2",
   "description": "A bpmnlint plug-in for Camunda Platform compatibility",
   "main": "index.js",
   "scripts": {
@@ -35,7 +35,7 @@
     "zeebe-bpmn-moddle": "^0.12.1"
   },
   "dependencies": {
-    "@philippfromme/moddle-helpers": "^0.1.0",
+    "@bpmn-io/moddle-utils": "^0.1.0",
     "bpmnlint-utils": "^1.0.2",
     "min-dash": "^3.8.0"
   },

package/rules/called-decision-or-task-definition/index.js

@@ -3,7 +3,7 @@ const {
   isAny
 } = require('bpmnlint-utils');
 
-const { getPath } = require('@philippfromme/moddle-helpers');
+const { getPath } = require('@bpmn-io/moddle-utils');
 
 const {
   findExtensionElement,

package/rules/user-task-form.js

@@ -0,0 +1,93 @@
+const { is } = require('bpmnlint-utils');
+
+const {
+  findExtensionElement,
+  findExtensionElements,
+  hasProperties
+} = require('./utils/element');
+
+const { reportErrors } = require('./utils/reporter');
+
+module.exports = function() {
+  function check(node, reporter) {
+    if (!is(node, 'bpmn:UserTask')) {
+      return;
+    }
+
+    const formDefinition = findExtensionElement(node, 'zeebe:FormDefinition');
+
+    if (!formDefinition) {
+      return;
+    }
+
+    let errors = hasProperties(formDefinition, {
+      formKey: {
+        required: true
+      }
+    }, node);
+
+    if (errors && 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 && errors.length) {
+      reportErrors(node, reporter, errors);
+    }
+  }
+
+  return {
+    check
+  };
+};
+
+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 findParent(node, type) {
+  if (!node) {
+    return null;
+  }
+
+  const parent = node.$parent;
+
+  if (!parent) {
+    return node;
+  }
+
+  if (is(parent, type)) {
+    return parent;
+  }
+
+  return findParent(parent, type);
+}

package/rules/utils/element.js

@@ -1,12 +1,13 @@
 const {
   isArray,
   isDefined,
+  isNil,
   some
 } = require('min-dash');
 
 const { isAny } = require('bpmnlint-utils');
 
-const { getPath } = require('@philippfromme/moddle-helpers');
+const { getPath } = require('@bpmn-io/moddle-utils');
 
 const { ERROR_TYPES } = require('./error-types');
 
@@ -40,6 +41,8 @@ function findExtensionElements(node, types) {
   return values.filter(value => isAny(value, types));
 }
 
+module.exports.findExtensionElements = findExtensionElements;
+
 function findExtensionElement(node, types) {
   const extensionElements = findExtensionElements(node, types);
 
@@ -145,7 +148,7 @@ module.exports.hasProperties = function(node, properties, parentNode = null) {
       ];
     }
 
-    if (propertyChecks.allowed === false && isDefined(propertyValue)) {
+    if (propertyChecks.allowed === false && isDefined(propertyValue) && !isNil(propertyValue)) {
       return [
         ...results,
         {

package/rules/utils/reporter.js

@@ -1,3 +1,5 @@
+const { is } = require('bpmnlint-utils');
+
 const { isArray } = require('min-dash');
 
 module.exports.reportErrors = function(node, reporter, errors) {
@@ -6,6 +8,31 @@ module.exports.reportErrors = function(node, reporter, errors) {
   }
 
   errors.forEach(({ message, ...options }) => {
+    const name = getName(node);
+
+    if (name) {
+      options = {
+        ...options,
+        name
+      };
+    }
+
     reporter.report(node.get('id'), message, options);
   });
-};
+};
+
+function getName(node) {
+  if (is(node, 'bpmn:TextAnnotation')) {
+    return node.get('text');
+  }
+
+  if (is(node, 'bpmn:Group')) {
+    const categoryValueRef = node.get('categoryValueRef');
+
+    return categoryValueRef && categoryValueRef.get('value');
+  }
+
+  return node.get('name');
+}
+
+module.exports.getName = getName;