bpmnlint-plugin-camunda-compat 0.1.1 → 0.4.0

package/CHANGELOG.md

@@ -1,15 +1,34 @@
 # Changelog
 
-All notable changes to [bpmnlint-plugin-example](https://github.com/camunda/bpmnlint-plugin-camunda-compat) are documented here. We use [semantic versioning](http://semver.org/) for releases.
+All notable changes to [bpmnlint-plugin-camunda-compat](https://github.com/camunda/bpmnlint-plugin-camunda-compat) are documented here. We use [semantic versioning](http://semver.org/) for releases.
 
 ## Unreleased
 
 ___Note:__ Yet to be released changes appear here._
 
-## 0.0.1
+## 0.4.0
+* `CHORE`: rename `Cloud` `1.4` to `8.0` ([#14](https://github.com/camunda/bpmnlint-plugin-camunda-compat/pull/14))
+* `CHORE`: rename `Cloud` to `Platform`/`Zeebe` ([#15](https://github.com/camunda/bpmnlint-plugin-camunda-compat/pull/15))
+
+## 0.3.0
+* `FEAT`: support multiInstance for subprocesses with cloud 1.0 ([#6](https://github.com/camunda/bpmnlint-plugin-camunda-compat/pull/6))
+* `FEAT`: add Camunda Platform rules ([#5](https://github.com/camunda/bpmnlint-plugin-camunda-compat/pull/5))
+* `FEAT`: add Camunda Cloud 1.4 rule ([#5](https://github.com/camunda/bpmnlint-plugin-camunda-compat/pull/5))
+* `TEST`: add Cloud 1.1, 1.2, 1.3 integration tests ([#4](https://github.com/camunda/bpmnlint-plugin-camunda-compat/pull/4))
+* `TEST`: verify exported configs ([#5](https://github.com/camunda/bpmnlint-plugin-camunda-compat/pull/5))
+* `DEPS`: fix security audit warnings ([#6](https://github.com/camunda/bpmnlint-plugin-camunda-compat/pull/6))
+* `DOCS`: update link to documentation
+* `DOCS`: link Camunda Cloud and Platform BPMN coverage
+
+## 0.2.0
+
+* `FEAT`: early return if execution platform does not match
+* `FIX`: correct check for `bpmn:BaseElement`
+
+## 0.1.1
 
 * `FEAT`: initial support for Camunda Cloud 1.0, 1.1, 1.2, and 1.3
 
 ## ...
 
-Check `git log` for earlier history.
+Check `git log` for earlier history.

package/README.md

@@ -23,8 +23,8 @@ To validate a diagram it must be pinned to a particular execution platform via t
 
 ## Resources
 
-* [Documentation](https://github.com/camunda/bpmnlint-plugin-camunda-compat/tree/master/docs/rules)
 * [Issues](https://github.com/camunda/bpmnlint-plugin-camunda-compat/issues)
+* BPMN coverage for [Camunda Cloud](https://docs.camunda.io/docs/reference/bpmn-processes/bpmn-coverage/) and [Camunda Platform](https://docs.camunda.org/manual/latest/reference/bpmn20/)
 
 
 ## License

package/index.js

@@ -1,19 +1,43 @@
 module.exports = {
   configs: {
+    all: {
+      rules: {
+        'camunda-cloud-1-0': 'error',
+        'camunda-cloud-1-1': 'error',
+        'camunda-cloud-1-2': 'error',
+        'camunda-cloud-1-3': 'error',
+        'camunda-cloud-8-0': 'error',
+        'camunda-platform-7-15': 'error',
+        'camunda-platform-7-16': 'error',
+        'camunda-platform-7-17': 'error'
+      }
+    },
     recommended: {
       rules: {
         'camunda-cloud-1-0': 'error',
         'camunda-cloud-1-1': 'error',
         'camunda-cloud-1-2': 'error',
-        'camunda-cloud-1-3': 'error'
+        'camunda-cloud-1-3': 'error',
+        'camunda-cloud-8-0': 'error',
+        'camunda-platform-7-15': 'error',
+        'camunda-platform-7-16': 'error',
+        'camunda-platform-7-17': 'error'
       }
     },
-    all: {
+    cloud: {
+      rules: {
+        'camunda-cloud-1-0': 'error',
+        'camunda-cloud-1-1': 'error',
+        'camunda-cloud-1-2': 'error',
+        'camunda-cloud-1-3': 'error',
+        'camunda-cloud-8-0': 'error'
+      }
+    },
+    platform: {
       rules: {
-        'camunda-cloud-1-0': 'warn',
-        'camunda-cloud-1-1': 'warn',
-        'camunda-cloud-1-2': 'warn',
-        'camunda-cloud-1-3': 'warn'
+        'camunda-platform-7-15': 'error',
+        'camunda-platform-7-16': 'error',
+        'camunda-platform-7-17': 'error'
       }
     }
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bpmnlint-plugin-camunda-compat",
-  "version": "0.1.1",
+  "version": "0.4.0",
   "description": "A bpmnlint plug-in for Camunda Cloud and Platform compatibility",
   "main": "index.js",
   "scripts": {
@@ -23,7 +23,7 @@
   "devDependencies": {
     "bpmn-moddle": "^7.1.2",
     "bpmnlint": "^6.1.0",
-    "chai": "^4.2.0",
+    "chai": "^4.3.5",
     "mocha": "^5.2.0",
     "modeler-moddle": "^0.1.0",
     "zeebe-bpmn-moddle": "^0.10.0"

package/rules/camunda-cloud-1-0-checks.js

@@ -82,7 +82,10 @@ module.exports = [
   },
   {
     type: 'bpmn:SubProcess',
-    check: hasNoLoopCharacteristics
+    check: checkSome(
+      hasNoLoopCharacteristics,
+      hasLoopCharacteristicsOfType('bpmn:MultiInstanceLoopCharacteristics')
+    )
   },
   {
     type: 'bpmn:UserTask',
@@ -91,4 +94,4 @@ module.exports = [
       hasLoopCharacteristicsOfType('bpmn:MultiInstanceLoopCharacteristics')
     )
   }
-];
+];

package/rules/camunda-cloud-1-0.js

@@ -2,4 +2,4 @@ const { createRule } = require('./utils/rule');
 
 const checks = require('./camunda-cloud-1-0-checks');
 
-module.exports = createRule('1.0', checks);
+module.exports = createRule('Camunda Cloud', '1.0', checks, 'Zeebe');

package/rules/camunda-cloud-1-1.js

@@ -2,4 +2,4 @@ const { createRule } = require('./utils/rule');
 
 const checks = require('./camunda-cloud-1-1-checks');
 
-module.exports = createRule('1.1', checks);
+module.exports = createRule('Camunda Cloud', '1.1', checks, 'Zeebe');

package/rules/camunda-cloud-1-2.js

@@ -2,4 +2,4 @@ const { createRule } = require('./utils/rule');
 
 const checks = require('./camunda-cloud-1-2-checks');
 
-module.exports = createRule('1.2', checks);
+module.exports = createRule('Camunda Cloud', '1.2', checks, 'Zeebe');

package/rules/camunda-cloud-1-3.js

@@ -2,4 +2,4 @@ const { createRule } = require('./utils/rule');
 
 const checks = require('./camunda-cloud-1-3-checks');
 
-module.exports = createRule('1.3', checks);
+module.exports = createRule('Camunda Cloud', '1.3', checks, 'Zeebe');

package/rules/camunda-cloud-8-0-checks.js

@@ -0,0 +1,5 @@
+const camundaCloud13Checks = require('./camunda-cloud-1-3-checks');
+
+module.exports = [
+  ...camundaCloud13Checks
+];

package/rules/camunda-cloud-8-0.js

@@ -0,0 +1,5 @@
+const { createRule } = require('./utils/rule');
+
+const checks = require('./camunda-cloud-8-0-checks');
+
+module.exports = createRule('Camunda Cloud', '8.0', checks, 'Camunda Platform');

package/rules/camunda-platform-7-15.js

@@ -0,0 +1,3 @@
+const { createNoopRule } = require('./utils/rule');
+
+module.exports = createNoopRule();

package/rules/camunda-platform-7-16.js

@@ -0,0 +1,3 @@
+const { createNoopRule } = require('./utils/rule');
+
+module.exports = createNoopRule();

package/rules/camunda-platform-7-17.js

@@ -0,0 +1,3 @@
+const { createNoopRule } = require('./utils/rule');
+
+module.exports = createNoopRule();

package/rules/utils/rule.js

@@ -11,78 +11,45 @@ const {
 
 const { toSemverMinor } = require('./engine-profile');
 
-module.exports.createRule = function(version, checks) {
+module.exports.createRule = function(ruleExecutionPlatform, ruleExecutionPlatformVersion, checks, executionPlatformLabel) {
   return () => {
     return {
       check: (node, reporter) => {
-
-        // do not lint properties (yet)
-        if (!isAny(node, [ 'bpmn:FlowElement', 'bpmn:FlowElementsContainer' ])) {
-          return;
-        }
-
-        const engineProfile = getEngineProfile(node);
-
-        if (!engineProfile) {
-          return;
-        }
-
-        const {
-          executionPlatform,
-          executionPlatformVersion
-        } = engineProfile;
-
-        if (!executionPlatformVersion || toSemverMinor(executionPlatformVersion) !== version) {
+        if (is(node, 'bpmn:Definitions')) {
+          executionPlatform = node.get('modeler:executionPlatform');
+          executionPlatformVersion = node.get('modeler:executionPlatformVersion');
+
+          if (!executionPlatform
+            || executionPlatform !== ruleExecutionPlatform
+            || !executionPlatformVersion
+            || toSemverMinor(executionPlatformVersion) !== ruleExecutionPlatformVersion) {
+            return false;
+          }
+        } else if (!isAny(node, [ 'bpmn:FlowElement', 'bpmn:FlowElementsContainer' ])) {
           return;
         }
 
         const result = checkNode(node, checks);
 
         if (result === false) {
-          reporter.report(node.get('id') || '', `Element of type <${ node.$type }> not supported by ${ executionPlatform } ${ toSemverMinor(executionPlatformVersion) }`);
+          reporter.report(node.get('id') || '', `Element of type <${ node.$type }> not supported by ${ executionPlatformLabel || ruleExecutionPlatform } ${ toSemverMinor(ruleExecutionPlatformVersion) }`);
         }
 
         if (isString(result)) {
-          reporter.report(node.get('id') || '', `Element of type <${ result }> not supported by ${ executionPlatform } ${ toSemverMinor(executionPlatformVersion) }`);
+          reporter.report(node.get('id') || '', `Element of type <${ result }> not supported by ${ executionPlatformLabel || ruleExecutionPlatform } ${ toSemverMinor(ruleExecutionPlatformVersion) }`);
         }
       }
     };
   };
-}
-
-function getDefinitions(node) {
-  if (is(node, 'bpmn:Definitions')) {
-    return node;
-  }
-
-  const parent = node.$parent;
-
-  if (!parent) {
-    return null;
-  }
+};
 
-  return getDefinitions(parent);
-}
-
-function getEngineProfile(node) {
-  const definitions = getDefinitions(node);
-
-  if (!definitions) {
-    return null;
-  }
-
-  const executionPlatform = definitions.get('modeler:executionPlatform'),
-        executionPlatformVersion = definitions.get('modeler:executionPlatformVersion');
-
-  if (!executionPlatform) {
-    return null;
-  }
-
-  return {
-    executionPlatform,
-    executionPlatformVersion
+module.exports.createNoopRule = function() {
+  return () => {
+    return {
+      check: () => false
+    };
   };
-}
+};
 
 /**
  * @param {ModdleElement} node
@@ -226,11 +193,5 @@ module.exports.hasLoopCharacteristicsOfType = function(type) {
 }
 
 module.exports.isNotBpmn = function(node) {
-  const { $descriptor: descriptor } = node;
-
-  const { $pkg: package } = descriptor;
-
-  const { uri } = package;
-
-  return uri !== 'http://www.omg.org/spec/BPMN/20100524/MODEL';
+  return !is(node, 'bpmn:BaseElement');
 }