bpmnlint 11.13.0 → 11.14.0

package/config/all.js

@@ -25,6 +25,7 @@ const allRules = [
   'start-event-required',
   'sub-process-blank-start-event',
   'superfluous-gateway',
+  'superfluous-label',
   'superfluous-termination'
 ];
 

package/config/recommended.js

@@ -24,6 +24,7 @@ module.exports = {
     'start-event-required': 'error',
     'sub-process-blank-start-event': 'error',
     'superfluous-gateway': 'warn',
+    'superfluous-label': 'warn',
     'superfluous-termination': 'warn'
   }
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "bpmnlint",
   "description": "Validate your BPMN diagrams based on configurable lint rules",
-  "version": "11.13.0",
+  "version": "11.14.0",
   "main": "lib/index.js",
   "keywords": [
     "bpmnlint",

package/rules/superfluous-label.js

@@ -0,0 +1,74 @@
+const {
+  is
+} = require('bpmnlint-utils');
+
+const {
+  annotateRule
+} = require('./helper');
+
+
+/**
+ * A rule that checks that unconditional sequence flows do not
+ * have a label.
+ *
+ * Labels are only meaningful on sequence flows forking out of
+ * XOR/OR gateways, on conditional flows, and on default flows.
+ * Anywhere else they duplicate information already conveyed by
+ * the diagram.
+ *
+ * @type { import('../lib/types.js').RuleFactory }
+ */
+module.exports = function() {
+
+  function check(node, reporter) {
+
+    if (!is(node, 'bpmn:SequenceFlow')) {
+      return;
+    }
+
+    const name = (node.name || '').trim();
+
+    if (!name) {
+      return;
+    }
+
+    if (hasCondition(node) || isDefaultFlow(node) || isGatewayFork(node)) {
+      return;
+    }
+
+    reporter.report(node.id, 'Sequence flow has superfluous label', [ 'name' ]);
+  }
+
+  return annotateRule('superfluous-label', {
+    check
+  });
+
+};
+
+
+// helpers /////////////////////////////
+
+function hasCondition(flow) {
+  return !!flow.conditionExpression;
+}
+
+function isDefaultFlow(flow) {
+  const source = flow.sourceRef;
+
+  return source && source['default'] === flow;
+}
+
+function isGatewayFork(flow) {
+  const source = flow.sourceRef;
+
+  if (!source) {
+    return false;
+  }
+
+  const isDecisionGateway = (
+    is(source, 'bpmn:ExclusiveGateway') ||
+    is(source, 'bpmn:InclusiveGateway')
+  );
+
+  return isDecisionGateway && (source.outgoing || []).length > 1;
+}