bpmnlint-plugin-camunda-compat 0.21.0 → 0.23.0

package/index.js

@@ -41,6 +41,10 @@ const camundaCloud82Rules = withConfig({
   'escalation-reference': 'error'
 }, { version: '8.2' });
 
+const camundaPlatform719Rules = withConfig({
+  'history-time-to-live': 'error'
+}, { platform: 'camunda-platform', version: '7.19' });
+
 module.exports = {
   configs: {
     'camunda-cloud-1-0': {
@@ -63,6 +67,9 @@ module.exports = {
     },
     'camunda-cloud-8-2': {
       rules: camundaCloud82Rules
+    },
+    'camunda-platform-7-19': {
+      rules: camundaPlatform719Rules
     }
   }
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bpmnlint-plugin-camunda-compat",
-  "version": "0.21.0",
+  "version": "0.23.0",
   "description": "A bpmnlint plug-in for Camunda Platform compatibility",
   "main": "index.js",
   "scripts": {
@@ -39,6 +39,7 @@
     "@bpmn-io/feel-lint": "^0.1.1",
     "@bpmn-io/moddle-utils": "^0.1.0",
     "bpmnlint-utils": "^1.0.2",
+    "camunda-bpmn-moddle": "^7.0.1",
     "min-dash": "^3.8.1",
     "semver-compare": "^1.0.0"
   },

package/rules/error-reference.js

@@ -12,12 +12,18 @@ const { reportErrors } = require('./utils/reporter');
 
 const { skipInNonExecutableProcess } = require('./utils/rule');
 
-module.exports = skipInNonExecutableProcess(function() {
+const { greaterOrEqual } = require('./utils/version');
+
+module.exports = skipInNonExecutableProcess(function({ version }) {
   function check(node, reporter) {
     if (!isAny(node, [ 'bpmn:CatchEvent', 'bpmn:ThrowEvent' ])) {
       return;
     }
 
+    if (is(node, 'bpmn:CatchEvent') && greaterOrEqual(version, '8.2')) {
+      return;
+    }
+
     const eventDefinition = getEventDefinition(node);
 
     if (!eventDefinition || !is(eventDefinition, 'bpmn:ErrorEventDefinition')) {
@@ -26,7 +32,8 @@ module.exports = skipInNonExecutableProcess(function() {
 
     let errors = hasProperties(eventDefinition, {
       errorRef: {
-        required: true
+        required: true,
+        allowedVersion: '8.2'
       }
     }, node);
 
@@ -40,7 +47,8 @@ module.exports = skipInNonExecutableProcess(function() {
 
     errors = hasProperties(errorRef, {
       errorCode: {
-        required: true
+        required: true,
+        allowedVersion: '8.2'
       }
     }, node);
 

package/rules/history-time-to-live.js

@@ -0,0 +1,31 @@
+const { is } = require('bpmnlint-utils');
+
+const { 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:Process')) {
+      return;
+    }
+
+    let errors = hasProperties(node, {
+      'historyTimeToLive': {
+        required: true
+      }
+    }, node);
+
+    if (errors) {
+      reportErrors(node, reporter, errors);
+    }
+    return;
+  }
+
+  return {
+    check
+  };
+});

package/rules/utils/element.js

@@ -145,16 +145,18 @@ module.exports.hasProperties = function(node, properties, parentNode = null) {
       return [
         ...results,
         {
-          message: `Element of type <${ node.$type }> must have property <${ propertyName }>`,
+          message: allowedVersion
+            ? `Element of type <${ node.$type }> without property <${ propertyName }> only allowed by Camunda Platform ${ allowedVersion } or newer`
+            : `Element of type <${ node.$type }> must have property <${ propertyName }>`,
           path: path
             ? [ ...path, propertyName ]
             : [ propertyName ],
-          data: {
+          data: addAllowedVersion({
             type: ERROR_TYPES.PROPERTY_REQUIRED,
             node,
             parentNode: parentNode == node ? null : parentNode,
             requiredProperty: propertyName
-          }
+          }, allowedVersion)
         }
       ];
     }
@@ -200,14 +202,13 @@ module.exports.hasProperties = function(node, properties, parentNode = null) {
           path: path
             ? [ ...path, propertyName ]
             : [ propertyName ],
-          data: {
+          data: addAllowedVersion({
             type: ERROR_TYPES.PROPERTY_TYPE_NOT_ALLOWED,
             node,
             parentNode: parentNode == node ? null : parentNode,
             property: propertyName,
-            allowedPropertyType: propertyChecks.type,
-            allowedVersion
-          }
+            allowedPropertyType: propertyChecks.type
+          }, allowedVersion)
         }
       ];
     }
@@ -241,13 +242,12 @@ module.exports.hasProperties = function(node, properties, parentNode = null) {
           path: path
             ? [ ...path, propertyName ]
             : [ propertyName ],
-          data: {
+          data: addAllowedVersion({
             type: ERROR_TYPES.PROPERTY_NOT_ALLOWED,
             node,
             parentNode: parentNode == node ? null : parentNode,
-            property: propertyName,
-            allowedVersion
-          }
+            property: propertyName
+          }, allowedVersion)
         }
       ];
     }
@@ -262,13 +262,12 @@ module.exports.hasProperties = function(node, properties, parentNode = null) {
           path: path
             ? [ ...path, propertyName ]
             : [ propertyName ],
-          data: {
+          data: addAllowedVersion({
             type: ERROR_TYPES.PROPERTY_VALUE_NOT_ALLOWED,
             node,
             parentNode: parentNode == node ? null : parentNode,
-            property: propertyName,
-            allowedVersion
-          }
+            property: propertyName
+          }, allowedVersion)
         }
       ];
     }
@@ -344,13 +343,12 @@ module.exports.hasNoExtensionElement = function(node, type, parentNode = null, a
           ? `Extension element of type <${ type }> only allowed by Camunda Platform ${ allowedVersion }`
           : `Extension element of type <${ type }> not allowed`,
         path: getPath(extensionElement, parentNode),
-        data: {
+        data: addAllowedVersion({
           type: ERROR_TYPES.EXTENSION_ELEMENT_NOT_ALLOWED,
           node,
           parentNode: parentNode == node ? null : parentNode,
-          extensionElement,
-          allowedVersion
-        }
+          extensionElement
+        }, allowedVersion)
       }
     ];
   }
@@ -407,13 +405,12 @@ module.exports.hasExpression = function(node, propertyName, check, parentNode =
         path: path
           ? [ ...path, propertyName ]
           : null,
-        data: {
+        data: addAllowedVersion({
           type: ERROR_TYPES.EXPRESSION_VALUE_NOT_ALLOWED,
           node: expression,
           parentNode,
-          property: propertyName,
-          allowedVersion
-        }
+          property: propertyName
+        }, allowedVersion)
       }
     ];
   }
@@ -438,3 +435,14 @@ function truncate(string, maxLength = 10) {
 
   return stringified.length > maxLength ? `${ stringified.slice(0, maxLength) }...` : stringified;
 }
+
+function addAllowedVersion(data, allowedVersion) {
+  if (!allowedVersion) {
+    return data;
+  }
+
+  return {
+    ...data,
+    allowedVersion
+  };
+}

package/rules/utils/rule.js

@@ -6,10 +6,14 @@ function skipInNonExecutableProcess(ruleFactory) {
   return function(config = {}) {
     const rule = ruleFactory(config);
 
-    const { version } = config;
+    const { version, platform = 'camunda-cloud' } = config;
 
     function check(node, reporter) {
-      if (version && greaterOrEqual(version, '8.2') && isNonExecutableProcess(node)) {
+      if (platform === 'camunda-cloud' && version && greaterOrEqual(version, '8.2') && isNonExecutableProcess(node)) {
+        return false;
+      }
+
+      if (platform === 'camunda-platform' && isNonExecutableProcess(node)) {
         return false;
       }