feat: linting

bpmn-io · Dec 10, 2024 · ecd5288 · ecd5288
1 parent 229eee0
commit ecd5288
Show file tree

Hide file tree

Showing 3 changed files with 94 additions and 2 deletions.
diff --git a/src/cloud-element-templates/linting/LinterPlugin.js b/src/cloud-element-templates/linting/LinterPlugin.js
@@ -37,12 +37,28 @@ export const elementTemplateLintRule = ({ templates = [] }) => {
 
   elementTemplates.set(validTemplates);
 
+  function setEngines(engines) {
+    if (engines == {}) {
+      return;
+    }
+    if (Object.keys(elementTemplates.getEngines()).length) {
+      return;
+    }
+
+    elementTemplates.setEngines(engines);
+  }
+
   function check(node, reporter) {
 
     if (!is(node, 'bpmn:FlowElement')) {
       return;
     }
 
+    const { moddleRoot } = reporter;
+
+    const engines = getEnginesConfig(moddleRoot);
+    setEngines(engines);
+
     let template = elementTemplates.get(node);
 
     const templateId = elementTemplates._getTemplateId(node);
@@ -63,6 +79,19 @@ export const elementTemplateLintRule = ({ templates = [] }) => {
       return;
     }
 
+    // Check compatibility
+    if (template.engines) {
+      if (!elementTemplates.isCompatible(template)) {
+        reporter.report(
+          node.id,
+          'This version of element template is not compatible with your execution platform version.',
+          {
+            name: node.name
+          }
+        );
+      }
+    }
+
     template = applyConditions(node, template);
 
     // Check attributes
@@ -123,4 +152,25 @@ function getEntryId(property, template) {
 
   path.push(index);
   return path.join('-');
-}
+}
+
+function getEnginesConfig(definitions) {
+  const {
+    executionPlatform,
+    executionPlatformVersion,
+    exporter,
+    exporterVersion
+  } = definitions;
+
+  const engines = {};
+
+  if (executionPlatform === 'Camunda Cloud' && executionPlatformVersion) {
+    engines.camunda = executionPlatformVersion;
+  }
+
+  if (exporter === 'Camunda Modeler' && exporterVersion) {
+    engines.camundaDesktopModeler = exporterVersion;
+  }
+
+  return engines;
+}
diff --git a/test/spec/cloud-element-templates/linting/LinterPlugin.json b/test/spec/cloud-element-templates/linting/LinterPlugin.json
@@ -216,5 +216,29 @@
         "feel": "optional"
       }
     ]
+  },
+  {
+    "$schema": "https://unpkg.com/@camunda/zeebe-element-templates-json-schema/resources/schema.json",
+    "name": "compatible",
+    "id": "compatible",
+    "appliesTo": [
+      "bpmn:Task"
+    ],
+    "engines": {
+      "camunda": ">1.0"
+    },
+    "properties": []
+  },
+  {
+    "$schema": "https://unpkg.com/@camunda/zeebe-element-templates-json-schema/resources/schema.json",
+    "name": "incompatible",
+    "id": "incompatible",
+    "appliesTo": [
+      "bpmn:Task"
+    ],
+    "engines": {
+      "camunda": "0"
+    },
+    "properties": []
   }
 ]
diff --git a/test/spec/cloud-element-templates/linting/LinterPlugin.spec.js b/test/spec/cloud-element-templates/linting/LinterPlugin.spec.js
@@ -59,7 +59,14 @@ const valid = [
     config: {
       templates
     }
-  }
+  },
+  {
+    name: 'Template Compatible',
+    moddleElement: createModdle(createProcess('<bpmn:task id="Task_1" zeebe:modelerTemplate="compatible" />')),
+    config: {
+      templates
+    }
+  },
 ];
 
 
@@ -75,6 +82,17 @@ const invalid = [
       message: 'Linked element template not found'
     }
   },
+  {
+    name: 'Template Incompatible',
+    moddleElement: createModdle(createProcess('<bpmn:task id="Task_1" zeebe:modelerTemplate="incompatible" />')),
+    config: {
+      templates
+    },
+    report: {
+      id: 'Task_1',
+      message: 'This version of element template is not compatible with your execution platform version.'
+    }
+  },
   {
     name: 'Min Length',
     moddleElement: createModdle(createProcess('<bpmn:task id="Task_1" name="a" zeebe:modelerTemplate="constraints.minLength" />')),