bpmnlint 11.8.0 → 11.10.0

package/config/all.js

@@ -1,5 +1,6 @@
 const allRules = [
   'ad-hoc-sub-process',
+  'conditional-event',
   'conditional-flows',
   'end-event-required',
   'event-based-gateway',

package/config/correctness.js

@@ -1,6 +1,7 @@
 module.exports = {
   rules: {
     'ad-hoc-sub-process': 'error',
+    'conditional-event': 'error',
     'event-based-gateway': 'error',
     'event-sub-process-typed-start-event': 'error',
     'link-event': 'error',

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "bpmnlint",
   "description": "Validate your BPMN diagrams based on configurable lint rules",
-  "version": "11.8.0",
+  "version": "11.10.0",
   "main": "lib/index.js",
   "keywords": [
     "bpmnlint",
@@ -39,7 +39,7 @@
     "bpmnlint": "./bin/bpmnlint.js"
   },
   "dependencies": {
-    "@bpmn-io/moddle-utils": "^0.2.1",
+    "@bpmn-io/moddle-utils": "^0.3.0",
     "ansi-colors": "^4.1.3",
     "bpmn-moddle": "^10.0.0",
     "bpmnlint-utils": "^1.1.1",

package/rules/conditional-event.js

@@ -0,0 +1,52 @@
+const {
+  is
+} = require('bpmnlint-utils');
+
+const {
+  annotateRule,
+  isInExecutableProcess
+} = require('./helper');
+
+
+/**
+ * Ensures that a conditional event has a condition specified.
+ *
+ * @type { import('../lib/types.js').RuleFactory }
+ */
+module.exports = function() {
+
+  function check(node, reporter) {
+
+    if (!isInExecutableProcess(node)) {
+      return;
+    }
+
+    const eventDefinition = getConditionalEventDefinition(node);
+
+    if (!eventDefinition) {
+      return;
+    }
+
+    if (!hasCondition(eventDefinition)) {
+      reporter.report(node.id, 'Conditional event is missing a condition', [ 'condition' ]);
+    }
+  }
+
+  return annotateRule('conditional-event', {
+    check
+  });
+
+};
+
+function getConditionalEventDefinition(node) {
+  if (!is(node, 'bpmn:Event')) {
+    return;
+  }
+
+  const eventDefinitions = node.eventDefinitions || [];
+  return eventDefinitions.find(def => is(def, 'bpmn:ConditionalEventDefinition'));
+}
+
+function hasCondition(eventDefinition) {
+  return !!eventDefinition.condition?.body;
+}

package/rules/helper.js

@@ -71,6 +71,22 @@ function findParent(node, type) {
 module.exports.findParent = findParent;
 
 
+/**
+ * Check if the node is inside of an executable process.
+ *
+ * @param { ModdleElement } node
+ *
+ * @return { boolean }
+ */
+function isInExecutableProcess(node) {
+  const process = findParent(node, 'bpmn:Process');
+
+  return process && process.isExecutable;
+}
+
+module.exports.isInExecutableProcess = isInExecutableProcess;
+
+
 const documentationBaseUrl = 'https://github.com/bpmn-io/bpmnlint/blob/main/docs/rules';
 
 /**