bpmnlint 11.1.0 → 11.3.0

package/rules/no-implicit-split.js

@@ -2,13 +2,19 @@ const {
   isAny
 } = require('bpmnlint-utils');
 
+const {
+  annotateRule
+} = require('./helper');
+
 
 /**
  * A rule that checks that no implicit split is modeled
  * starting from a task.
  *
- * users should model the parallel splitting gateway
+ * Users should model the parallel splitting gateway
  * explicitly instead.
+ *
+ * @type { import('../lib/types.js').RuleFactory }
  */
 module.exports = function() {
 
@@ -32,9 +38,9 @@ module.exports = function() {
     }
   }
 
-  return {
+  return annotateRule('no-implicit-split', {
     check
-  };
+  });
 
 };
 

package/rules/no-implicit-start.js

@@ -3,9 +3,14 @@ const {
   isAny
 } = require('bpmnlint-utils');
 
+const {
+  annotateRule
+} = require('./helper');
 
 /**
  * A rule that checks that an element is not an implicit start (token spawn).
+ *
+ * @type { import('../lib/types.js').RuleFactory }
  */
 module.exports = function() {
 
@@ -50,5 +55,7 @@ module.exports = function() {
     }
   }
 
-  return { check };
+  return annotateRule('no-implicit-start', {
+    check
+  });
 };

package/rules/no-inclusive-gateway.js

@@ -1,3 +1,3 @@
 const disallowNodeType = require('./helper').disallowNodeType;
 
-module.exports = disallowNodeType('bpmn:InclusiveGateway');
+module.exports = disallowNodeType('bpmn:InclusiveGateway', 'no-inclusive-gateway');

package/rules/no-overlapping-elements.js

@@ -2,11 +2,18 @@ const {
   is
 } = require('bpmnlint-utils');
 
+const {
+  annotateRule
+} = require('./helper');
+
 
 /**
  * Rule that checks if two elements overlap except:
+ *
  * - Boundary events overlap their host
  * - Child elements overlap / are on top of their parent (e.g., elements within a subProcess)
+ *
+ * @type { import('../lib/types.js').RuleFactory }
  */
 module.exports = function() {
 
@@ -44,9 +51,9 @@ module.exports = function() {
     elementsOutsideToReport.forEach(element => reporter.report(element.id, 'Element is outside of parent boundary'));
   }
 
-  return {
-    check: check
-  };
+  return annotateRule('no-overlapping-elements', {
+    check
+  });
 };
 
 // helpers /////////////////

package/rules/single-blank-start-event.js

@@ -2,9 +2,16 @@ const {
   is
 } = require('bpmnlint-utils');
 
+const {
+  annotateRule
+} = require('./helper');
+
+
 /**
  * A rule that checks whether not more than one blank start event
  * exists per scope.
+ *
+ * @type { import('../lib/types.js').RuleFactory }
  */
 module.exports = function() {
 
@@ -34,8 +41,8 @@ module.exports = function() {
     }
   }
 
-  return {
+  return annotateRule('single-blank-start-event', {
     check
-  };
+  });
 
 };

package/rules/single-event-definition.js

@@ -2,9 +2,15 @@ const {
   is
 } = require('bpmnlint-utils');
 
+const {
+  annotateRule
+} = require('./helper');
+
 
 /**
  * A rule that verifies that an event contains maximum one event definition.
+ *
+ * @type { import('../lib/types.js').RuleFactory }
  */
 module.exports = function() {
 
@@ -21,8 +27,8 @@ module.exports = function() {
     }
   }
 
-  return {
+  return annotateRule('single-event-definition', {
     check
-  };
+  });
 
 };

package/rules/start-event-required.js

@@ -3,9 +3,15 @@ const {
   isAny
 } = require('bpmnlint-utils');
 
+const {
+  annotateRule
+} = require('./helper');
+
 
 /**
  * A rule that checks for the presence of a start event per scope.
+ *
+ * @type { import('../lib/types.js').RuleFactory }
  */
 module.exports = function() {
 
@@ -33,5 +39,7 @@ module.exports = function() {
     }
   }
 
-  return { check };
+  return annotateRule('start-event-required', {
+    check
+  });
 };

package/rules/sub-process-blank-start-event.js

@@ -2,10 +2,16 @@ const {
   is
 } = require('bpmnlint-utils');
 
+const {
+  annotateRule
+} = require('./helper');
+
 
 /**
  * A rule that checks that start events inside a normal sub-processes
  * are blank (do not have an event definition).
+ *
+ * @type { import('../lib/types.js').RuleFactory }
  */
 module.exports = function() {
 
@@ -31,8 +37,8 @@ module.exports = function() {
     });
   }
 
-  return {
+  return annotateRule('sub-process-blank-start-event', {
     check
-  };
+  });
 
 };

package/rules/superfluous-gateway.js

@@ -2,10 +2,17 @@ const {
   is
 } = require('bpmnlint-utils');
 
+const {
+  annotateRule
+} = require('./helper');
+
+
 /**
  * A rule that checks, whether a gateway has only one source and target.
  *
  * Those gateways are superfluous since they don't do anything.
+ *
+ * @type { import('../lib/types.js').RuleFactory }
  */
 module.exports = function() {
 
@@ -23,8 +30,8 @@ module.exports = function() {
     }
   }
 
-  return {
+  return annotateRule('superfluous-gateway', {
     check
-  };
+  });
 
 };

package/rules/superfluous-termination.js

@@ -1,11 +1,19 @@
 const {
-  is, isAny
+  is,
+  isAny
 } = require('bpmnlint-utils');
 
+const {
+  annotateRule
+} = require('./helper');
+
+
 /**
  * A rule that checks, whether a gateway has only one source and target.
  *
  * Those gateways are superfluous since they don't do anything.
+ *
+ * @type { import('../lib/types.js').RuleFactory }
  */
 module.exports = function() {
 
@@ -42,9 +50,9 @@ module.exports = function() {
     }
   }
 
-  return {
+  return annotateRule('superfluous-termination', {
     check
-  };
+  });
 
 };