bpmnlint 10.3.1 → 11.1.0

package/README.md

@@ -72,6 +72,8 @@ import NodeResolver from 'bpmnlint/lib/resolver/node-resolver';
 
 import BpmnModdle from 'bpmn-moddle';
 
+const moddle = new BpmnModdle();
+
 const linter = new Linter({ 
   config: {
     extends: 'bpmnlint:recommended'

package/config/all.js

@@ -1,4 +1,5 @@
 const allRules = [
+  'ad-hoc-sub-process',
   'conditional-flows',
   'end-event-required',
   'event-sub-process-typed-start-event',

package/config/recommended.js

@@ -1,5 +1,6 @@
 module.exports = {
   rules: {
+    'ad-hoc-sub-process': 'error',
     'conditional-flows': 'error',
     'end-event-required': 'error',
     'event-sub-process-typed-start-event': 'error',

package/lib/resolver/node-resolver.js

@@ -117,18 +117,5 @@ NodeResolver.prototype.normalizePkg = function(pkg) {
 // helpers ////////////////////
 
 function createScopedRequire(cwd) {
-
-  // shim createRequireFromPath for Node < 10.12
-  // shim createRequireFromPath for Node < 12.2.0
-  const createRequireFromPath = Module.createRequire || Module.createRequireFromPath || (filename => {
-    const mod = new Module(filename, null);
-
-    mod.filename = filename;
-    mod.paths = Module._nodeModulePaths(path.dirname(filename));
-    mod._compile('module.exports = require;', filename);
-
-    return mod.exports;
-  });
-
-  return createRequireFromPath(path.join(cwd, '__placeholder__.js'));
+  return Module.createRequire(path.join(cwd, '__placeholder__.js'));
 }

package/lib/test-rule.js

@@ -2,7 +2,8 @@ const traverse = require('./traverse');
 
 const {
   isArray,
-  isObject
+  isObject,
+  isFunction
 } = require('min-dash');
 
 
@@ -57,10 +58,12 @@ class Reporter {
 module.exports = function testRule({ moddleRoot, rule }) {
   const reporter = new Reporter({ rule, moddleRoot });
 
-  const check = rule.check;
+  const check = rule.check || {};
 
-  const enter = check && check.enter || check;
-  const leave = check && check.leave;
+  const leave = 'leave' in check ? check.leave : undefined;
+  const enter = 'enter' in check ? check.enter : (
+    isFunction(check) ? check : undefined
+  );
 
   if (!enter && !leave) {
     throw new Error('no check implemented');

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "bpmnlint",
   "description": "Validate your BPMN diagrams based on configurable lint rules",
-  "version": "10.3.1",
+  "version": "11.1.0",
   "main": "lib/index.js",
   "keywords": [
     "bpmnlint",
@@ -23,12 +23,12 @@
     }
   ],
   "engines": {
-    "node": ">= 16"
+    "node": ">= 20"
   },
   "license": "MIT",
   "scripts": {
     "all": "run-s lint test-coverage",
-    "lint": "eslint . --ext js,mjs",
+    "lint": "eslint .",
     "dev": "npm test -- --watch",
     "test": "mocha --exclude 'test/integration/*/**' 'test/**/*.*js'",
     "test-coverage": "nyc --reporter=lcov --reporter=html npm test",
@@ -40,26 +40,25 @@
   "dependencies": {
     "@bpmn-io/moddle-utils": "^0.2.1",
     "ansi-colors": "^4.1.3",
-    "bpmn-moddle": "^8.1.0",
+    "bpmn-moddle": "^9.0.1",
     "bpmnlint-utils": "^1.1.1",
     "cli-table": "^0.3.11",
     "color-support": "^1.1.3",
-    "min-dash": "^4.2.1",
+    "min-dash": "^4.2.2",
     "mri": "^1.2.0",
     "pluralize": "^7.0.0",
     "tiny-glob": "^0.2.9"
   },
   "devDependencies": {
     "@bpmn-io/bpmnlint-generate-docs-images": "^0.4.0",
-    "bpmnlint": ".",
-    "chai": "^4.4.1",
-    "eslint": "^8.57.0",
-    "eslint-plugin-bpmn-io": "^1.0.0",
-    "execa": "^8.0.1",
+    "chai": "^4.5.0",
+    "eslint": "^9.17.0",
+    "eslint-plugin-bpmn-io": "^2.0.2",
+    "execa": "^9.5.2",
     "install-local": "^3.0.1",
-    "mocha": "^10.4.0",
+    "mocha": "^11.0.1",
     "npm-run-all": "^4.1.5",
-    "nyc": "^15.1.0",
+    "nyc": "^17.1.0",
     "strip-indent": "^3.0.0"
   },
   "files": [

package/rules/ad-hoc-sub-process.js

@@ -0,0 +1,45 @@
+const {
+  is,
+  isAny
+} = require('bpmnlint-utils');
+
+/**
+ * A rule that ensures that an Ad Hoc Sub Process is valid according to the BPMN spec:
+ *
+ * - No start or end events
+ * - Every intermediate event has an outgoing sequence flow
+ */
+module.exports = function() {
+
+  function check(node, reporter) {
+
+    if (!is(node, 'bpmn:AdHocSubProcess')) {
+      return;
+    }
+
+    const flowElements = node.flowElements || [];
+
+    flowElements.forEach(function(flowElement) {
+
+      if (is(flowElement, 'bpmn:StartEvent')) {
+        reporter.report(flowElement.id, 'A <Start Event> is not allowed in <Ad Hoc Sub Process>');
+      }
+
+      if (is(flowElement, 'bpmn:EndEvent')) {
+        reporter.report(flowElement.id, 'An <End Event> is not allowed in <Ad Hoc Sub Process>');
+      }
+
+      if (isAny(flowElement, [ 'bpmn:IntermediateCatchEvent', 'bpmn:IntermediateThrowEvent' ])) {
+        if (!flowElement.outgoing || flowElement.outgoing.length === 0) {
+          reporter.report(flowElement.id, 'An intermediate event inside <Ad Hoc Sub Process> must have an outgoing sequence flow');
+        }
+      }
+
+    });
+  }
+
+  return {
+    check
+  };
+
+};

package/rules/no-bpmndi.js

@@ -103,13 +103,13 @@ function getAllBpmnElements(rootElements) {
  */
 function getAllDiBpmnReferences(definitionsNode) {
   return flatten(
-    definitionsNode.diagrams.map((diagram) => {
+    definitionsNode.get('diagrams').map((diagram) => {
 
       const diElements = diagram.plane.planeElement || [];
 
       return diElements.map((element) => {
 
-        return element.bpmnElement.id;
+        return element.bpmnElement?.id;
       });
     })
   );

package/rules/no-overlapping-elements.js

@@ -108,7 +108,15 @@ function checkElementsArray(elements, elementsToReport, diObjects) {
         continue;
       }
 
-      if (isCollision(diObjects.get(element).bounds, diObjects.get(element2).bounds)) {
+      const bounds1 = diObjects.get(element)?.bounds;
+      const bounds2 = diObjects.get(element2)?.bounds;
+
+      // ignore if an element doesn't have bounds
+      if (!bounds1 || !bounds2) {
+        continue;
+      }
+
+      if (isCollision(bounds1, bounds2)) {
         elementsToReport.add(element);
         elementsToReport.add(element2);
       }