bpmnlint 11.4.4 → 11.6.0

package/README.md

@@ -75,6 +75,12 @@ You may also extend from multiple configurations, including those provided by [c
 
 This will amend core `recommended` rules with `recommended` rulesets provided by `bpmnlint-plugin-foo` and `@bar/bpmnlint-plugin-bar`, respectively.
 
+### Available Configurations
+
+* [`bpmnlint:all`](./config/all.js) - all rules as errors
+* [`bpmnlint:recommended`](./config/recommended.js) - opinionated rules ("best practices") and rules enforcing BPMN compliance
+* [`bpmnlint:correctness`](./config/correctness.js) - rules enforcing BPMN compliance
+
 ## API
 
 Invoke the tool directly from [NodeJS](https://nodejs.org/en):

package/bin/bpmnlint.js

@@ -24,6 +24,7 @@ const BpmnModdle = require('bpmn-moddle');
 
 const Linter = require('../lib/linter');
 const NodeResolver = require('../lib/resolver/node-resolver');
+const { createScopedRequire } = require('../lib/resolver/helper');
 
 const Table = require('cli-table');
 
@@ -59,8 +60,6 @@ Usage
 `;
 
 
-const moddle = new BpmnModdle();
-
 function boldRed(str) {
   return bold(red(str));
 }
@@ -81,10 +80,11 @@ function glob(files) {
  * Reads XML form path and return moddle object
  *
  * @param {string} diagramXML
+ * @param {BpmnModdle.BPMNModdle} moddle
  *
  * @return { Promise<{ moddleElement: any; warnings: Error[], error?: Error }> } parseResult
  */
-async function parseDiagram(diagramXML) {
+async function parseDiagram(diagramXML, moddle) {
 
   try {
     const {
@@ -235,7 +235,7 @@ function printReports(filePath, results) {
   };
 }
 
-async function lintDiagram(diagramPath, config) {
+async function lintDiagram(diagramPath, config, moddle) {
 
   let diagramXML;
 
@@ -250,7 +250,7 @@ async function lintDiagram(diagramPath, config) {
     error: importError,
     warnings: importWarnings,
     moddleElement
-  } = await parseDiagram(diagramXML);
+  } = await parseDiagram(diagramXML, moddle);
 
   if (importError) {
     return printReports(diagramPath, {
@@ -307,8 +307,10 @@ async function lint(files, config, maxWarnings) {
 
   console.log();
 
+  const moddle = createModdle(config);
+
   for (let i = 0; i < files.length; i++) {
-    let results = await lintDiagram(files[i], config);
+    let results = await lintDiagram(files[i], config, moddle);
 
     errorCount += results.errorCount;
     warningCount += results.warningCount;
@@ -405,4 +407,32 @@ Learn more about configuring bpmnlint: https://github.com/bpmn-io/bpmnlint#confi
   return lint(actualFiles, config, maxWarnings);
 }
 
-run().catch(errorAndExit);
+run().catch(errorAndExit);
+
+/**
+ * Create moddle instance with extensions from the config.
+ *
+ * @param {object} config
+ * @returns {BpmnModdle.BPMNModdle}
+ */
+function createModdle(config) {
+  const scopedRequire = createScopedRequire(process.cwd());
+
+  const options = config.moddleExtensions || {};
+
+  for (const key in options) {
+    const extension = options[key];
+
+    try {
+      options[key] = scopedRequire(extension);
+    } catch (error) {
+      errorAndExit('Error: Could not load moddle extension <%s> from %s\n\n', key, extension, /** @type { Error } */ (error).message);
+    }
+  }
+
+  try {
+    return new BpmnModdle(options);
+  } catch (error) {
+    errorAndExit('Error: Could not create moddle instance\n\n%s', /** @type { Error } */ (error).message);
+  }
+}

package/config/correctness.js

@@ -4,6 +4,7 @@ module.exports = {
     'event-sub-process-typed-start-event': 'error',
     'link-event': 'error',
     'no-duplicate-sequence-flows': 'warn',
-    'sub-process-blank-start-event': 'error'
+    'sub-process-blank-start-event': 'error',
+    'single-blank-start-event': 'error'
   }
 };

package/lib/resolver/helper.js

@@ -0,0 +1,12 @@
+const Module = require('node:module');
+const path = require('node:path');
+
+/**
+ * Create require function for a given path.
+ *
+ * @param {string} cwd
+ * @returns {NodeRequire}
+ */
+module.exports.createScopedRequire = function(cwd) {
+  return Module.createRequire(path.join(cwd, '__placeholder__.js'));
+};

package/lib/resolver/node-resolver.js

@@ -1,4 +1,3 @@
-const Module = require('node:module');
 const path = require('node:path');
 const { cwd } = require('node:process');
 
@@ -9,6 +8,7 @@ const { isString } = require('min-dash');
  * @typedef { import('../types.js').Config } Config
  */
 
+const { createScopedRequire } = require('./helper');
 
 /**
  * A resolver that locates rules and configurations
@@ -133,13 +133,4 @@ NodeResolver.prototype.normalizePkg = function(pkg) {
   }
 
   return pkg;
-};
-
-// helpers ////////////////////
-
-/**
- * @param {string} cwd
- */
-function createScopedRequire(cwd) {
-  return Module.createRequire(path.join(cwd, '__placeholder__.js'));
-}
+};

package/package.json

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