bpmnlint-plugin-camunda-compat 0.19.0 → 0.21.0

package/index.js

@@ -1,73 +1,45 @@
 const { omit } = require('min-dash');
 
-const camundaCloud10Rules = {
-  'implementation': [ 'error', { version: '1.0' } ],
+const camundaCloud10Rules = withConfig({
+  'implementation': 'error',
   'called-element': 'error',
   'collapsed-subprocess': 'error',
   'duplicate-task-headers': 'error',
-  'element-type': [ 'error', { version: '1.0' } ],
+  'element-type': 'error',
   'error-reference': 'error',
   'executable-process': 'error',
   'loop-characteristics': 'error',
   'message-reference': 'error',
-  'no-expression': [ 'error', { version: '1.0' } ],
+  'no-candidate-users': 'error',
+  'no-expression': 'error',
   'no-template': 'error',
   'no-zeebe-properties': 'error',
   'sequence-flow-condition': 'error',
   'subscription': 'error',
-  'timer': [ 'error', { version: '1.0' } ],
+  'timer': 'error',
   'user-task-form': 'error',
   'feel': 'error'
-};
+}, { version: '1.0' });
 
-const camundaCloud11Rules = {
-  ...camundaCloud10Rules,
-  'implementation': [ 'error', { version: '1.1' } ],
-  'element-type': [ 'error', { version: '1.1' } ],
-  'no-expression': [ 'error', { version: '1.1' } ],
-  'timer': [ 'error', { version: '1.1' } ]
-};
+const camundaCloud11Rules = withConfig(camundaCloud10Rules, { version: '1.1' });
 
-const camundaCloud12Rules = {
-  ...camundaCloud11Rules,
-  'implementation': [ 'error', { version: '1.2' } ],
-  'element-type': [ 'error', { version: '1.2' } ],
-  'no-expression': [ 'error', { version: '1.2' } ],
-  'timer': [ 'error', { version: '1.2' } ]
-};
+const camundaCloud12Rules = withConfig(camundaCloud11Rules, { version: '1.2' });
 
-const camundaCloud13Rules = {
-  ...camundaCloud12Rules,
-  'implementation': [ 'error', { version: '1.3' } ],
-  'element-type': [ 'error', { version: '1.3' } ],
-  'no-expression': [ 'error', { version: '1.3' } ],
-  'timer': [ 'error', { version: '1.3' } ]
-};
+const camundaCloud13Rules = withConfig(camundaCloud12Rules, { version: '1.3' });
 
-const camundaCloud80Rules = {
-  ...omit(camundaCloud13Rules, 'no-template'),
-  'implementation': [ 'error', { version: '8.0' } ],
-  'element-type': [ 'error', { version: '8.0' } ],
-  'no-expression': [ 'error', { version: '8.0' } ],
-  'timer': [ 'error', { version: '8.0' } ]
-};
+const camundaCloud80Rules = withConfig({
+  ...omit(camundaCloud13Rules, 'no-template')
+}, { version: '8.0' });
 
-const camundaCloud81Rules = {
+const camundaCloud81Rules = withConfig({
   ...omit(camundaCloud80Rules, 'no-zeebe-properties'),
-  'implementation': [ 'error', { version: '8.1' } ],
-  'element-type': [ 'error', { version: '8.1' } ],
-  'inclusive-gateway': 'error',
-  'no-expression': [ 'error', { version: '8.1' } ],
-  'timer': [ 'error', { version: '8.1' } ]
-};
+  'inclusive-gateway': 'error'
+}, { version: '8.1' });
 
-const camundaCloud82Rules = {
-  ...camundaCloud81Rules,
-  'implementation': [ 'error', { version: '8.2' } ],
-  'element-type': [ 'error', { version: '8.2' } ],
-  'no-expression': [ 'error', { version: '8.2' } ],
-  'timer': [ 'error', { version: '8.2' } ]
-};
+const camundaCloud82Rules = withConfig({
+  ...omit(camundaCloud81Rules, 'no-candidate-users'),
+  'escalation-reference': 'error'
+}, { version: '8.2' });
 
 module.exports = {
   configs: {
@@ -93,4 +65,14 @@ module.exports = {
       rules: camundaCloud82Rules
     }
   }
-};
+};
+
+function withConfig(rules, config, type = 'error') {
+  let rulesWithConfig = {};
+
+  for (let name in rules) {
+    rulesWithConfig[ name ] = [ type, config ];
+  }
+
+  return rulesWithConfig;
+}

package/package.json

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

package/rules/called-element.js

@@ -8,7 +8,9 @@ const {
 
 const { reportErrors } = require('./utils/reporter');
 
-module.exports = function() {
+const { skipInNonExecutableProcess } = require('./utils/rule');
+
+module.exports = skipInNonExecutableProcess(function() {
   function check(node, reporter) {
     if (!is(node, 'bpmn:CallActivity')) {
       return;
@@ -38,4 +40,4 @@ module.exports = function() {
   return {
     check
   };
-};
+});

package/rules/collapsed-subprocess.js

@@ -4,7 +4,9 @@ const { ERROR_TYPES } = require('./utils/element');
 
 const { reportErrors } = require('./utils/reporter');
 
-module.exports = function() {
+const { skipInNonExecutableProcess } = require('./utils/rule');
+
+module.exports = skipInNonExecutableProcess(function() {
   function check(di, reporter) {
 
     if (!isCollapsedSubProcess(di)) {
@@ -28,11 +30,10 @@ module.exports = function() {
   return {
     check
   };
-};
-
+});
 
 function isCollapsedSubProcess(di) {
   return is(di, 'bpmndi:BPMNShape') &&
-         is(di.bpmnElement, 'bpmn:SubProcess') &&
+         is(di.get('bpmnElement'), 'bpmn:SubProcess') &&
          di.get('isExpanded') !== true;
 }

package/rules/duplicate-task-headers.js

@@ -11,7 +11,9 @@ const {
 
 const { reportErrors } = require('./utils/reporter');
 
-module.exports = function() {
+const { skipInNonExecutableProcess } = require('./utils/rule');
+
+module.exports = skipInNonExecutableProcess(function() {
   function check(node, reporter) {
     if (!is(node, 'bpmn:UserTask') && !isZeebeServiceTask(node)) {
       return;
@@ -33,7 +35,7 @@ module.exports = function() {
   return {
     check
   };
-};
+});
 
 // helpers //////////
 

package/rules/element-type/index.js

@@ -12,7 +12,9 @@ const { ERROR_TYPES } = require('../utils/error-types');
 
 const { reportErrors } = require('../utils/reporter');
 
-module.exports = function({ version }) {
+const { skipInNonExecutableProcess } = require('../utils/rule');
+
+module.exports = skipInNonExecutableProcess(function({ version }) {
   function check(node, reporter) {
     if (!isAny(node, [ 'bpmn:FlowElement', 'bpmn:FlowElementsContainer' ])) {
       return;
@@ -99,4 +101,4 @@ module.exports = function({ version }) {
   return {
     check
   };
-};
+});

package/rules/error-reference.js

@@ -10,7 +10,9 @@ const {
 
 const { reportErrors } = require('./utils/reporter');
 
-module.exports = function() {
+const { skipInNonExecutableProcess } = require('./utils/rule');
+
+module.exports = skipInNonExecutableProcess(function() {
   function check(node, reporter) {
     if (!isAny(node, [ 'bpmn:CatchEvent', 'bpmn:ThrowEvent' ])) {
       return;
@@ -50,4 +52,4 @@ module.exports = function() {
   return {
     check
   };
-};
+});

package/rules/escalation-reference.js

@@ -0,0 +1,55 @@
+const {
+  is,
+  isAny
+} = require('bpmnlint-utils');
+
+const {
+  getEventDefinition,
+  hasProperties
+} = require('./utils/element');
+
+const { reportErrors } = require('./utils/reporter');
+
+const { skipInNonExecutableProcess } = require('./utils/rule');
+
+module.exports = skipInNonExecutableProcess(function() {
+  function check(node, reporter) {
+    if (!isAny(node, [ 'bpmn:CatchEvent', 'bpmn:ThrowEvent' ])) {
+      return;
+    }
+
+    const eventDefinition = getEventDefinition(node);
+
+    if (!eventDefinition || !is(eventDefinition, 'bpmn:EscalationEventDefinition')) {
+      return;
+    }
+
+    let errors = hasProperties(eventDefinition, {
+      escalationRef: {
+        required: true
+      }
+    }, node);
+
+    if (errors && errors.length) {
+      reportErrors(node, reporter, errors);
+
+      return;
+    }
+
+    const escalationRef = eventDefinition.get('escalationRef');
+
+    errors = hasProperties(escalationRef, {
+      escalationCode: {
+        required: true
+      }
+    }, node);
+
+    if (errors && errors.length) {
+      reportErrors(node, reporter, errors);
+    }
+  }
+
+  return {
+    check
+  };
+});

package/rules/feel.js

@@ -10,7 +10,9 @@ const { reportErrors } = require('./utils/reporter');
 
 const { ERROR_TYPES } = require('./utils/error-types');
 
-module.exports = function() {
+const { skipInNonExecutableProcess } = require('./utils/rule');
+
+module.exports = skipInNonExecutableProcess(function() {
   function check(node, reporter) {
     if (is(node, 'bpmn:Expression')) {
       return;
@@ -62,7 +64,7 @@ module.exports = function() {
   return {
     check
   };
-};
+});
 
 const isFeelProperty = ([ propertyName, value ]) => {
   return !isIgnoredProperty(propertyName) && isString(value) && value.startsWith('=');

package/rules/implementation/index.js

@@ -19,7 +19,9 @@ const { reportErrors } = require('../utils/reporter');
 
 const { ERROR_TYPES } = require('../utils/error-types');
 
-module.exports = function({ version }) {
+const { skipInNonExecutableProcess } = require('../utils/rule');
+
+module.exports = skipInNonExecutableProcess(function({ version }) {
   function check(node, reporter) {
     const calledDecisionConfig = config.calledDecision[ node.$type ];
     const scriptConfig = config.script[ node.$type ];
@@ -175,7 +177,7 @@ module.exports = function({ version }) {
   return {
     check
   };
-};
+});
 
 function isCalledDecisionAllowed(node, version) {
   const { calledDecision } = config;

package/rules/inclusive-gateway.js

@@ -4,7 +4,9 @@ const { ERROR_TYPES } = require('./utils/element');
 
 const { reportErrors } = require('./utils/reporter');
 
-module.exports = function() {
+const { skipInNonExecutableProcess } = require('./utils/rule');
+
+module.exports = skipInNonExecutableProcess(function() {
   function check(node, reporter) {
     if (!is(node, 'bpmn:InclusiveGateway')) {
       return;
@@ -31,4 +33,4 @@ module.exports = function() {
   return {
     check
   };
-};
+});

package/rules/loop-characteristics.js

@@ -8,7 +8,9 @@ const {
 
 const { reportErrors } = require('./utils/reporter');
 
-module.exports = function() {
+const { skipInNonExecutableProcess } = require('./utils/rule');
+
+module.exports = skipInNonExecutableProcess(function() {
   function check(node, reporter) {
     if (!is(node, 'bpmn:Activity')) {
       return;
@@ -62,4 +64,4 @@ module.exports = function() {
   return {
     check
   };
-};
+});

package/rules/message-reference.js

@@ -10,7 +10,9 @@ const {
 
 const { reportErrors } = require('./utils/reporter');
 
-module.exports = function() {
+const { skipInNonExecutableProcess } = require('./utils/rule');
+
+module.exports = skipInNonExecutableProcess(function() {
   function check(node, reporter) {
     if (!isAny(node, [ 'bpmn:CatchEvent', 'bpmn:ReceiveTask' ])) {
       return;
@@ -56,4 +58,4 @@ module.exports = function() {
   return {
     check
   };
-};
+});

package/rules/no-candidate-users.js

@@ -0,0 +1,39 @@
+const { is } = require('bpmnlint-utils');
+
+const {
+  findExtensionElement,
+  hasProperties
+} = require('./utils/element');
+
+const { reportErrors } = require('./utils/reporter');
+
+const { skipInNonExecutableProcess } = require('./utils/rule');
+
+module.exports = skipInNonExecutableProcess(function() {
+  function check(node, reporter) {
+    if (!is(node, 'bpmn:UserTask')) {
+      return;
+    }
+
+    const assignmentDefinition = findExtensionElement(node, 'zeebe:AssignmentDefinition');
+
+    if (!assignmentDefinition) {
+      return;
+    }
+
+    const errors = hasProperties(assignmentDefinition, {
+      candidateUsers: {
+        allowed: false,
+        allowedVersion: '8.2'
+      }
+    }, node);
+
+    if (errors && errors.length) {
+      reportErrors(node, reporter, errors);
+    }
+  }
+
+  return {
+    check
+  };
+});

package/rules/no-expression.js

@@ -11,6 +11,8 @@ const {
 
 const { reportErrors } = require('./utils/reporter');
 
+const { skipInNonExecutableProcess } = require('./utils/rule');
+
 const handlersMap = {
   '1.0': [
     checkErrorCode
@@ -36,7 +38,7 @@ const handlersMap = {
   ]
 };
 
-module.exports = noExpressionRule;
+module.exports = skipInNonExecutableProcess(noExpressionRule);
 
 /**
  * Make sure that certain properties do not contain expressions in older versions.

package/rules/no-template.js

@@ -2,7 +2,9 @@ const { hasProperties } = require('./utils/element');
 
 const { reportErrors } = require('./utils/reporter');
 
-module.exports = function() {
+const { skipInNonExecutableProcess } = require('./utils/rule');
+
+module.exports = skipInNonExecutableProcess(function() {
   function check(node, reporter) {
     const errors = hasProperties(node, {
       modelerTemplate: {
@@ -19,4 +21,4 @@ module.exports = function() {
   return {
     check
   };
-};
+});

package/rules/no-zeebe-properties.js

@@ -4,7 +4,9 @@ const { hasNoExtensionElement } = require('./utils/element');
 
 const { reportErrors } = require('./utils/reporter');
 
-module.exports = function() {
+const { skipInNonExecutableProcess } = require('./utils/rule');
+
+module.exports = skipInNonExecutableProcess(function() {
   function check(node, reporter) {
     if (!is(node, 'zeebe:PropertiesHolder')) {
       return;
@@ -20,4 +22,4 @@ module.exports = function() {
   return {
     check
   };
-};
+});

package/rules/sequence-flow-condition.js

@@ -4,7 +4,9 @@ const { hasProperties } = require('./utils/element');
 
 const { reportErrors } = require('./utils/reporter');
 
-module.exports = function() {
+const { skipInNonExecutableProcess } = require('./utils/rule');
+
+module.exports = skipInNonExecutableProcess(function() {
   function check(node, reporter) {
     if (!isAny(node, [ 'bpmn:ExclusiveGateway', 'bpmn:InclusiveGateway' ])) {
       return;
@@ -32,4 +34,4 @@ module.exports = function() {
   return {
     check
   };
-};
+});

package/rules/subscription.js

@@ -12,7 +12,9 @@ const {
 
 const { reportErrors } = require('./utils/reporter');
 
-module.exports = function() {
+const { skipInNonExecutableProcess } = require('./utils/rule');
+
+module.exports = skipInNonExecutableProcess(function() {
   function check(node, reporter) {
     if (!isAny(node, [ 'bpmn:CatchEvent', 'bpmn:ThrowEvent', 'bpmn:ReceiveTask' ])
       || (is(node, 'bpmn:StartEvent') && !is(node.$parent, 'bpmn:SubProcess'))) {
@@ -61,4 +63,4 @@ module.exports = function() {
   return {
     check
   };
-};
+});

package/rules/timer/index.js

@@ -23,7 +23,9 @@ const {
 
 const { reportErrors } = require('../utils/reporter');
 
-module.exports = function({ version }) {
+const { skipInNonExecutableProcess } = require('../utils/rule');
+
+module.exports = skipInNonExecutableProcess(function({ version }) {
   function check(node, reporter) {
     if (!is(node, 'bpmn:Event')) {
       return;
@@ -53,7 +55,7 @@ module.exports = function({ version }) {
   return {
     check
   };
-};
+});
 
 function checkTimePropertyExists(eventDefinition, event) {
   if (is(event, 'bpmn:StartEvent')) {

package/rules/user-task-form.js

@@ -8,7 +8,9 @@ const {
 
 const { reportErrors } = require('./utils/reporter');
 
-module.exports = function() {
+const { skipInNonExecutableProcess } = require('./utils/rule');
+
+module.exports = skipInNonExecutableProcess(function() {
   function check(node, reporter) {
     if (!is(node, 'bpmn:UserTask')) {
       return;
@@ -54,7 +56,7 @@ module.exports = function() {
   return {
     check
   };
-};
+});
 
 // helpers //////////
 

package/rules/utils/rule.js

@@ -0,0 +1,43 @@
+const { is } = require('bpmnlint-utils');
+
+const { greaterOrEqual } = require('./version');
+
+function skipInNonExecutableProcess(ruleFactory) {
+  return function(config = {}) {
+    const rule = ruleFactory(config);
+
+    const { version } = config;
+
+    function check(node, reporter) {
+      if (version && greaterOrEqual(version, '8.2') && isNonExecutableProcess(node)) {
+        return false;
+      }
+
+      return rule.check(node, reporter);
+    }
+
+    return {
+      ...rule,
+      check
+    };
+  };
+}
+
+module.exports = {
+  skipInNonExecutableProcess
+};
+
+function isNonExecutableProcess(node) {
+  let process;
+
+  if (is(node, 'bpmn:Process')) {
+    process = node;
+  }
+
+  if (is(node, 'bpmndi:BPMNPlane')
+    && is(node.get('bpmnElement'), 'bpmn:Process')) {
+    process = node.get('bpmnElement');
+  }
+
+  return process && !process.get('isExecutable');
+}