bpmnlint-plugin-camunda-compat 0.7.1 → 0.9.1

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.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))
+
 ## 0.7.1
 
 * `FIX`: lint subscription only if start event child of sub process ([#34](https://github.com/camunda/bpmnlint-plugin-camunda-compat/pull/34))
@@ -17,7 +29,7 @@ ___Note:__ Yet to be released changes appear here._
 
 ### Breaking Changes
 
-* configuration not selected based on execution platform and version anymore
+* configuration not selected based on execution platform and version anymore, either configure manually or use [`@camunda/linting`](https://github.com/camunda/linting)
 * error message not adjusted to be shown in Camunda Modeler anymore
 * error type ELEMENT_TYPE changed to ELEMENT_TYPE_NOT_ALLOWED
 * error type PROPERTY_TYPE changed to PROPERTY_TYPE_NOT_ALLOWED

package/README.md

@@ -2,25 +2,24 @@
 
 [![CI](https://github.com/camunda/bpmnlint-plugin-camunda-compat/workflows/CI/badge.svg)](https://github.com/camunda/bpmnlint-plugin-camunda-compat/actions?query=workflow%3ACI)
 
-Camunda BPMN compatibility, packed as a [bpmnlint](https://github.com/bpmn-io/bpmnlint) plug-in.
+Camunda BPMN compatibility provided as a [bpmnlint](https://github.com/bpmn-io/bpmnlint) plug-in.
 
 
 ## Usage
 
-Add the plug-in via your `.bpmnlintrc` file:
+To configure the linter dynamically based on the [execution platform and version](https://github.com/camunda/modeler-moddle), use [`@camunda/linting`](https://github.com/camunda/linting).
+
+To configure the linter statically, add the configuration corresponding to your execution platform and version to your `.bpmnlintrc` file:
 
 ```
 {
   "extends": [
     "bpmnlint:recommended",
-    "plugin:camunda-compat/recommended"
+    "plugin:camunda-compat/camunda-cloud-8-0"
   ]
 }
 ```
 
-To validate a diagram it must be pinned to a particular execution platform via the [`modeler`](https://github.com/camunda/modeler-moddle) BPMN 2.0 extension.
-
-
 ## Resources
 
 * [Issues](https://github.com/camunda/bpmnlint-plugin-camunda-compat/issues)

package/index.js

@@ -1,61 +1,70 @@
-const hasCalledDecisionOrTaskDefinitionConfig = require('./rules/has-called-decision-or-task-definition/config'),
-      isElementConfig = require('./rules/is-element/config');
+const calledDecisionOrTaskDefinitionConfig = require('./rules/called-decision-or-task-definition/config'),
+      elementTypeConfig = require('./rules/element-type/config');
 
 module.exports = {
   configs: {
     'camunda-cloud-1-0': {
       rules: {
-        'has-called-decision-or-task-definition': [ 'error', hasCalledDecisionOrTaskDefinitionConfig.camundaCloud10 ],
-        'has-called-element': 'error',
-        'has-error-reference': 'error',
-        'has-loop-characteristics': 'error',
-        'has-message-reference': 'error',
-        'has-subscription': 'error',
-        'is-element': [ 'error', isElementConfig.camundaCloud10 ]
+        'called-decision-or-task-definition': [ 'error', calledDecisionOrTaskDefinitionConfig.camundaCloud10 ],
+        'called-element': 'error',
+        'element-type': [ 'error', elementTypeConfig.camundaCloud10 ],
+        'error-reference': 'error',
+        'loop-characteristics': 'error',
+        'message-reference': 'error',
+        'no-template': 'error',
+        'subscription': 'error',
+        'user-task-form': 'error'
       }
     },
     'camunda-cloud-1-1': {
       rules: {
-        'has-called-decision-or-task-definition': [ 'error', hasCalledDecisionOrTaskDefinitionConfig.camundaCloud11 ],
-        'has-called-element': 'error',
-        'has-error-reference': 'error',
-        'has-loop-characteristics': 'error',
-        'has-message-reference': 'error',
-        'has-subscription': 'error',
-        'is-element': [ 'error', isElementConfig.camundaCloud11 ]
+        'called-decision-or-task-definition': [ 'error', calledDecisionOrTaskDefinitionConfig.camundaCloud11 ],
+        'called-element': 'error',
+        'element-type': [ 'error', elementTypeConfig.camundaCloud11 ],
+        'error-reference': 'error',
+        'loop-characteristics': 'error',
+        'message-reference': 'error',
+        'no-template': 'error',
+        'subscription': 'error',
+        'user-task-form': 'error'
       }
     },
     'camunda-cloud-1-2': {
       rules: {
-        'has-called-decision-or-task-definition': [ 'error', hasCalledDecisionOrTaskDefinitionConfig.camundaCloud12 ],
-        'has-called-element': 'error',
-        'has-error-reference': 'error',
-        'has-loop-characteristics': 'error',
-        'has-message-reference': 'error',
-        'has-subscription': 'error',
-        'is-element': [ 'error', isElementConfig.camundaCloud12 ]
+        'called-decision-or-task-definition': [ 'error', calledDecisionOrTaskDefinitionConfig.camundaCloud12 ],
+        'called-element': 'error',
+        'element-type': [ 'error', elementTypeConfig.camundaCloud12 ],
+        'error-reference': 'error',
+        'loop-characteristics': 'error',
+        'message-reference': 'error',
+        'no-template': 'error',
+        'subscription': 'error',
+        'user-task-form': 'error'
       }
     },
     'camunda-cloud-1-3': {
       rules: {
-        'has-called-decision-or-task-definition': [ 'error', hasCalledDecisionOrTaskDefinitionConfig.camundaCloud13 ],
-        'has-called-element': 'error',
-        'has-error-reference': 'error',
-        'has-loop-characteristics': 'error',
-        'has-message-reference': 'error',
-        'has-subscription': 'error',
-        'is-element': [ 'error', isElementConfig.camundaCloud12 ]
+        'called-decision-or-task-definition': [ 'error', calledDecisionOrTaskDefinitionConfig.camundaCloud13 ],
+        'called-element': 'error',
+        'element-type': [ 'error', elementTypeConfig.camundaCloud12 ],
+        'error-reference': 'error',
+        'loop-characteristics': 'error',
+        'message-reference': 'error',
+        'no-template': 'error',
+        'subscription': 'error',
+        'user-task-form': 'error'
       }
     },
     'camunda-cloud-8-0': {
       rules: {
-        'has-called-decision-or-task-definition': [ 'error', hasCalledDecisionOrTaskDefinitionConfig.camundaCloud13 ],
-        'has-called-element': 'error',
-        'has-error-reference': 'error',
-        'has-loop-characteristics': 'error',
-        'has-message-reference': 'error',
-        'has-subscription': 'error',
-        'is-element': [ 'error', isElementConfig.camundaCloud12 ]
+        'called-decision-or-task-definition': [ 'error', calledDecisionOrTaskDefinitionConfig.camundaCloud13 ],
+        'called-element': 'error',
+        'element-type': [ 'error', elementTypeConfig.camundaCloud12 ],
+        'error-reference': 'error',
+        'loop-characteristics': 'error',
+        'message-reference': 'error',
+        'subscription': 'error',
+        'user-task-form': 'error'
       }
     }
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bpmnlint-plugin-camunda-compat",
-  "version": "0.7.1",
+  "version": "0.9.1",
   "description": "A bpmnlint plug-in for Camunda Platform compatibility",
   "main": "index.js",
   "scripts": {
@@ -25,7 +25,6 @@
   "devDependencies": {
     "bpmn-moddle": "^7.1.2",
     "bpmnlint": "^7.8.0",
-    "camunda-bpmn-moddle": "^6.1.1",
     "chai": "^4.3.5",
     "eslint": "^7.32.0",
     "eslint-plugin-bpmn-io": "^0.13.0",
@@ -33,10 +32,10 @@
     "modeler-moddle": "^0.1.0",
     "sinon": "^13.0.1",
     "sinon-chai": "^3.7.0",
-    "zeebe-bpmn-moddle": "^0.10.0"
+    "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/{has-called-decision-or-task-definition → 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/no-template.js

@@ -0,0 +1,21 @@
+const { hasProperties } = require('./utils/element');
+
+const { reportErrors } = require('./utils/reporter');
+
+module.exports = function() {
+  function check(node, reporter) {
+    const errors = hasProperties(node, {
+      modelerTemplate: {
+        allowed: false
+      }
+    }, node);
+
+    if (errors && errors.length) {
+      reportErrors(node, reporter, errors);
+    }
+  }
+
+  return {
+    check
+  };
+};

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,11 +1,12 @@
 const {
   isArray,
+  isDefined,
   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');
 
@@ -39,6 +40,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);
 
@@ -144,6 +147,24 @@ module.exports.hasProperties = function(node, properties, parentNode = null) {
       ];
     }
 
+    if (propertyChecks.allowed === false && isDefined(propertyValue)) {
+      return [
+        ...results,
+        {
+          message: `Property <${ propertyName }> not allowed`,
+          path: path
+            ? [ ...path, propertyName ]
+            : [ propertyName ],
+          error: {
+            type: ERROR_TYPES.PROPERTY_NOT_ALLOWED,
+            node,
+            parentNode: parentNode == node ? null : parentNode,
+            property: propertyName
+          }
+        }
+      ];
+    }
+
     return results;
   }, []);
 };

package/rules/utils/error-types.js

@@ -3,6 +3,7 @@ module.exports.ERROR_TYPES = Object.freeze({
   EXTENSION_ELEMENT_NOT_ALLOWED: 'extensionElementNotAllowed',
   EXTENSION_ELEMENT_REQUIRED: 'extensionElementRequired',
   PROPERTY_DEPENDEND_REQUIRED: 'propertyDependendRequired',
+  PROPERTY_NOT_ALLOWED: 'propertyNotAllowed',
   PROPERTY_REQUIRED: 'propertyRequired',
   PROPERTY_TYPE_NOT_ALLOWED: 'propertyTypeNotAllowed'
 });

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;