bpmnlint 7.7.0 → 8.0.0

package/bin/bpmnlint.js

@@ -28,7 +28,7 @@ const Table = require('cli-table');
 
 const pluralize = require('pluralize');
 
-const { pathStringify } = require('@philippfromme/moddle-helpers');
+const { pathStringify } = require('@bpmn-io/moddle-utils');
 
 const CONFIG_NAME = '.bpmnlintrc';
 

package/lib/linter.js

@@ -77,7 +77,7 @@ Linter.prototype.applyRule = function applyRule(moddleRoot, ruleDefinition) {
 };
 
 
-Linter.prototype.resolveRule = function(name) {
+Linter.prototype.resolveRule = function(name, config) {
 
   const {
     pkg,
@@ -98,7 +98,7 @@ Linter.prototype.resolveRule = function(name) {
       throw new Error(`unknown rule <${name}>`);
     }
 
-    const rule = this.cachedRules[id] = ruleFactory();
+    const rule = this.cachedRules[id] = ruleFactory(config);
 
     return rule;
   });
@@ -163,10 +163,11 @@ Linter.prototype.resolveRules = function(config) {
     const loaders = enabledRules.map((definition) => {
 
       const {
-        name
+        name,
+        config
       } = definition;
 
-      return this.resolveRule(name).then(function(rule) {
+      return this.resolveRule(name, config).then(function(rule) {
         return {
           ...definition,
           rule

package/lib/support/compile-config.js

@@ -21,19 +21,21 @@ async function compileConfig(config, resolver) {
   const resolvedRules = await linter.resolveConfiguredRules(config);
 
   // only process and serialize enabled rules
-  const enabledRules = Object.keys(resolvedRules).reduce(function(enabledRules, key) {
+  const rules = Object.keys(resolvedRules).reduce(function(rules, key) {
     const value = resolvedRules[key];
 
     const { category } = linter.parseRuleValue(value);
 
-    if (category !== 'off') {
-      enabledRules[key] = value;
+    if (category === 'off') {
+      rules[key] = 0;
+    } else {
+      rules[key] = value;
     }
 
-    return enabledRules;
+    return rules;
   }, {});
 
-  const serializedRules = JSON.stringify(enabledRules, null, '  ');
+  const serializedRules = JSON.stringify(rules, null, '  ');
 
   const preambleCode = `
 const cache = {};
@@ -81,7 +83,11 @@ export { resolver, config };
 export default bundle;
 `;
 
-  const importCode = Object.keys(enabledRules).map((key, idx) => {
+  const importCode = Object.entries(rules).map(([ key, value ], idx) => {
+
+    if (!value) {
+      return null;
+    }
 
     const {
       pkg, ruleName
@@ -90,7 +96,7 @@ export default bundle;
     return `
 import rule_${idx} from '${resolver.normalizePkg(pkg)}/rules/${ruleName}';
 cache['${pkg}/${ruleName}'] = rule_${idx};`;
-  }).join('\n');
+  }).filter(e => e).join('\n');
 
   return `${preambleCode}\n\n${importCode}`;
 }

package/lib/testers/rule-tester.js

@@ -14,11 +14,12 @@ function expectEqual(a, b) {
   assert.deepStrictEqual(JSON.stringify(a, replacer, 2), JSON.stringify(b, replacer, 2));
 }
 
-
 function verify(ruleName, rule, testCases) {
-  const linterConfig = {
-    rules: { [ruleName]: 2 }
-  };
+  function createLinterConfig(config = {}) {
+    return {
+      rules: { [ruleName]: [ 2, config ] }
+    };
+  }
 
   describe(`rules/${ruleName}`, function() {
 
@@ -33,13 +34,13 @@ function verify(ruleName, rule, testCases) {
 
     describe('should lint valid', function() {
 
-      testCases.valid.forEach(({ moddleElement, name, it: _it }, idx) => (
+      testCases.valid.forEach(({ config = {}, it: _it, moddleElement, name }, idx) => (
 
         (_it || it)(getTitle(idx, name), function() {
           return (
             Promise.resolve(moddleElement)
               .then(moddleRoot => {
-                return linter.lint(moddleRoot.root, linterConfig);
+                return linter.lint(moddleRoot.root, createLinterConfig(config));
               })
               .then(lintResults => {
                 expectEqual(lintResults, {});
@@ -54,7 +55,7 @@ function verify(ruleName, rule, testCases) {
 
     describe('should lint invalid', function() {
 
-      testCases.invalid.forEach(({ moddleElement, name, report, it: _it }, idx) => (
+      testCases.invalid.forEach(({ config = {}, it: _it, moddleElement, name, report }, idx) => (
 
         (_it || it)(getTitle(idx, name), function() {
 
@@ -78,7 +79,7 @@ function verify(ruleName, rule, testCases) {
           return (
             Promise.resolve(moddleElement)
               .then(moddleRoot => {
-                return linter.lint(moddleRoot.root, linterConfig);
+                return linter.lint(moddleRoot.root, createLinterConfig(config));
               })
               .then(lintResults => {
                 expectEqual(lintResults, expectedLintResults);
@@ -95,16 +96,9 @@ function verify(ruleName, rule, testCases) {
 }
 
 function getTitle(idx, name) {
-  return `test case #${ idx + 1 }${ name ? ` ${ name }`: '' }`;
+  return `test case #${ idx + 1 }${ name ? ` ${ name }` : '' }`;
 }
 
-module.exports = {
-  expectEqual,
-  verify,
-  getTitle,
-  replacer
-};
-
 function replacer(_, value) {
   if (!value) {
     return value;
@@ -133,4 +127,11 @@ function replacer(_, value) {
   }
 
   return value;
-}
+}
+
+module.exports = {
+  expectEqual,
+  verify,
+  getTitle,
+  replacer
+};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "bpmnlint",
   "description": "Validate your BPMN diagrams based on configurable lint rules",
-  "version": "7.7.0",
+  "version": "8.0.0",
   "main": "lib/index.js",
   "keywords": [
     "bpmnlint",
@@ -23,7 +23,7 @@
     }
   ],
   "engines": {
-    "node": ">= 10"
+    "node": ">= 12"
   },
   "license": "MIT",
   "scripts": {
@@ -37,27 +37,33 @@
     "bpmnlint": "./bin/bpmnlint.js"
   },
   "dependencies": {
-    "@philippfromme/moddle-helpers": "^0.1.0",
-    "ansi-colors": "^4.1.1",
-    "bpmn-moddle": "^7.1.2",
+    "@bpmn-io/moddle-utils": "^0.1.0",
+    "ansi-colors": "^4.1.3",
+    "bpmn-moddle": "^7.1.3",
     "bpmnlint-utils": "^1.0.2",
-    "cli-table": "^0.3.9",
+    "cli-table": "^0.3.11",
     "color-support": "^1.1.3",
-    "min-dash": "^3.8.0",
+    "min-dash": "^3.8.1",
     "mri": "^1.2.0",
     "pluralize": "^7.0.0",
     "tiny-glob": "^0.2.9"
   },
   "devDependencies": {
     "chai": "^4.3.4",
-    "eslint": "^7.32.0",
-    "eslint-plugin-bpmn-io": "^0.11.0",
+    "eslint": "^8.23.1",
+    "eslint-plugin-bpmn-io": "^0.16.0",
     "esm": "^3.2.25",
-    "execa": "^2.1.0",
-    "install-local": "^1.0.0",
+    "execa": "^5.1.1",
+    "install-local": "^3.0.1",
     "mocha": "^8.4.0",
     "npm-run-all": "^4.1.5",
     "nyc": "^15.1.0",
-    "strip-indent": "^2.0.0"
-  }
+    "strip-indent": "^3.0.0"
+  },
+  "files": [
+    "bin",
+    "config",
+    "lib",
+    "rules"
+  ]
 }

package/rules/no-bpmndi.js

@@ -53,7 +53,6 @@ module.exports = function() {
  */
 function getAllBpmnElements(rootElements) {
   return flatten(rootElements.map((rootElement) => {
-
     const laneSet =
       rootElement.laneSets && rootElement.laneSets[0] || rootElement.childLaneSet;
 
@@ -66,13 +65,15 @@ function getAllBpmnElements(rootElements) {
     // * nested laneSets
     // * childLaneSets
     // * nested childLaneSets
+    // * messageFlows
     const elements = flatten([].concat(
       rootElement.flowElements || [],
       (rootElement.flowElements && getAllBpmnElements(rootElement.flowElements.filter(hasFlowElements))) || [],
       rootElement.participants || [],
       rootElement.artifacts || [],
       laneSet && laneSet.lanes || [],
-      laneSet && laneSet.lanes && getAllBpmnElements(laneSet.lanes.filter(hasChildLaneSet)) || []
+      laneSet && laneSet.lanes && getAllBpmnElements(laneSet.lanes.filter(hasChildLaneSet)) || [],
+      rootElement.messageFlows || []
     ));
 
     if (elements.length > 0) {
@@ -115,7 +116,7 @@ function getAllDiBpmnReferences(definitionsNode) {
 }
 
 function hasVisualRepresentation(element) {
-  const noVisRepresentation = ['bpmn:DataObject'];
+  const noVisRepresentation = [ 'bpmn:DataObject' ];
 
   return noVisRepresentation.includes(element.$type) ? false : true;
 }

package/CHANGELOG.md

@@ -1,205 +0,0 @@
-# Changelog
-
-All notable changes to [bpmnlint](https://github.com/bpmn-io/bpmnlint) are documented here. We use [semantic versioning](http://semver.org/) for releases.
-
-## Unreleased
-
-___Note:__ Yet to be released changes appear here._
-
-## 7.7.0
-
-* `FEAT`: fuzzy test for equality of nodes when using `RuleTester#verify` ([#79](https://github.com/bpmn-io/bpmnlint/pull/79/files))
-
-## 7.6.0
-
-* `FEAT`: allow passing object as third parameter to `Reporter#report` ([#75](https://github.com/bpmn-io/bpmnlint/pull/75))
-
-
-## 7.5.0
-
-* `FEAT`: add optional `path` parameter to `Reporter#report` ([#73](https://github.com/bpmn-io/bpmnlint/pull/73))
-* `FEAT`: add optional `name` parameter to `RuleTester#verify` ([#68](https://github.com/bpmn-io/bpmnlint/pull/68))
-* `CHORE`: update to `bpmn-moddle@7.1.2`
-
-## 7.4.0
-
-* `FEAT`: resolve local package by name ([#64](https://github.com/bpmn-io/bpmnlint/pull/64))
-
-## 7.3.0
-
-* `FEAT`: support `--version` command line flag ([#65](https://github.com/bpmn-io/bpmnlint/pull/65))
-* `FEAT`: allow rule testers to provide custom `it`
-* `FIX`: make `no-bpmndi` handle missing `LaneSet#lanes` gracefully ([#63](https://github.com/bpmn-io/bpmnlint/issues/63), [#66](https://github.com/bpmn-io/bpmnlint/pull/66))
-
-## 7.2.1
-
-* `FIX`: exclude compensation boundary and activity in `no-disconnected` check ([#60](https://github.com/bpmn-io/bpmnlint/pull/60))
-
-## 7.2.0
-
-* `FEAT`: add `no-bpmndi` rule ([#55](https://github.com/bpmn-io/bpmnlint/issues/55))
-
-## 7.1.0
-
-* `FEAT`: allow rules to skip sub-tree traversal ([#53](https://github.com/bpmn-io/bpmnlint/issues/53))
-* `FEAT`: allow rules to hook into node `enter` and `leave` ([#52](https://github.com/bpmn-io/bpmnlint/issues/52))
-
-## 7.0.1
-
-* `CHORE`: drop debug log statement
-
-## 7.0.0
-
-* `CHORE`: update to `bpmn-moddle@7`
-* `CHORE`: reduce library footprint
-* `CHORE`: require `NodeJS>=10`
-
-## 6.5.0
-
-* `FEAT`: add globbing support ([#46](https://github.com/bpmn-io/bpmnlint/issues/46))
-* `DOCS`: add explaination to `no-inclusive-gateway` rule
-
-## 6.4.0
-
-* `FEAT`: add `superfluous-gateway` check ([#42](https://github.com/bpmn-io/bpmnlint/pull/42/files))
-
-## 6.3.0
-
-* `FEAT`: support rules and configuration provided by scoped packages ([#35](https://github.com/bpmn-io/bpmnlint/issues/35))
-* `CHORE`: improve `Node >= 12.20` compatibility ([#37](https://github.com/bpmn-io/bpmnlint/pull/37))
-
-## 6.2.0
-
-* `DOCS`: document existing rules ([#14](https://github.com/bpmn-io/bpmnlint/issues/14))
-
-## 6.1.2
-
-* `FIX`: exclude event-based sub-processes from `no-disconnected` check ([#31](https://github.com/bpmn-io/bpmnlint/issues/31))
-
-## 6.1.1
-
-* `FEAT`: allow tool to be used with `Node >= 8`
-
-## 6.1.0
-
-* `FEAT`: resolve local rules in plug-ins without prefix ([`640e411a`](https://github.com/bpmn-io/bpmnlint/commit/640e411ac8c6045198bd09b79b5c53c6e29e251c))
-
-## 6.0.0
-
-* `FEAT`: resolve plug-in provided rules/configuration local to working directory ([`f1bf331f`](https://github.com/bpmn-io/bpmnlint/commit/f1bf331f4bcece62de16da34bb3f8fda08182fbc))
-* `CHORE`: improve errors on rule/plugin resolution failures
-* `CHORE`: require `>= node@10.12`
-
-## 5.3.0
-
-* `FEAT`: add `--init` option to create `.bpmnlintrc` in current working directory
-
-## 5.2.0
-
-* `FEAT`: provide help on missing `.bpmnlintrc`
-
-## 5.1.2
-
-* `DOCS`: add package description
-
-## 5.1.1
-
-* `CHORE`: exclude additional development assets from distribution
-
-## 5.1.0
-
-* `FEAT`: add `no-duplicate-sequence-flows` rule ([#22](https://github.com/bpmn-io/bpmnlint/issues/22))
-* `FEAT`: catch more BPMN parse errors
-* `FEAT`: be able to define multiple expected test results in `RuleTester`
-* `FIX`: make `nyc` a development dependency
-* `CHORE`: update to `bpmn-moddle@6`
-
-## 5.0.0
-
-* `FEAT`: don't expose utils to rules; use `bpmnlint-utils` instead
-
-## 4.1.0
-
-* `FEAT`: handle and report diagram import errors and warnings via CLI
-* `FEAT`: properly handle generic moddle elements during rule checking
-* `FEAT`: report rule execution errors
-
-## 4.0.0
-
-* `FEAT`: add ability to batch lint multiple files via CLI
-* `FEAT`: don't resolve disabled rules ([`6c45f3f9`](https://github.com/bpmn-io/bpmnlint/commit/6c45f3f952a412dda05deb5c57861a1c76af23bb))
-* `CHORE`: unify messages of built-in rules
-* `CHORE`: adopt cli output to eslint styling
-
-## 3.3.1
-
-* `FIX`: handle empty flow element containers in rules
-
-## 3.3.0
-
-* `FEAT`: do not expose disabled rules when bundling `.bpmnlintrc`
-
-## 3.2.1
-
-* `DOCS`: fix readme code snippet
-
-## 3.2.0
-
-* `FEAT`: add ability to pass linter configuration via constructor
-
-## 3.1.0
-
-* `FEAT`: add support script to compile `.bpmnlintrc` files to JavaScript ([`cf53a389`](https://github.com/bpmn-io/bpmnlint/commit/cf53a3894b6bd821e18ddfc7bdaa8da857356a37))
-
-## 3.0.0
-
-#### Breaking Changes
-
-* `FEAT`: treat unprefixed rules as built-in ones
-
-## 2.0.0
-
-#### Breaking Changes
-
-* `CHORE`: make `NodeResolver` a constructor
-* `CHORE`: unify file names to `dashed-case`
-* `CHORE`: rework `Resolver` APIs
-
-#### Other Enhancements
-
-* `FEAT`: add `StaticResolver` to load cached resources
-* `FEAT`: add `{ Linter }` as a library export
-* `CHORE`: move rule and config name resolution to linter
-* `CHORE`: catch all cli errors and exit accordingly
-
-## 1.0.0
-
-* `FEAT`: add numerous new rules ([#5](https://github.com/bpmn-io/bpmnlint/issues/5))
-* `FEAT`: add `bpmnlint:all` configuration
-* `FEAT`: improve `label-required` rule ([#11](https://github.com/bpmn-io/bpmnlint/issues/11))
-* `FEAT`: group lint results by rule names
-* `FEAT`: exit cli with code=1 on lint errors
-* `FEAT`: add `isAny(node, [ ... types ])` method to `utils`
-* `CHORE`: improve / test cover existing rules
-* `CHORE`: include new rules in `bpmnlint:recommended` configuration
-
-## 1.0.0-alpha6
-
-* `DOCS`: documentation simplification / improvements
-
-## 1.0.0-alpha5
-
-_Initial stable release._
-
-* `FEAT`: configure, resolve and execute local and external rules
-* `FEAT`: extend external configuration via `extends`
-* `FEAT`: make rule and configuration resolution async
-* `FEAT`: provide `bpmnlint:recommended` configuration
-* `CHORE`: `linter` is now a constructor, offering a `#lint(moddleElement, config)` method
-* `CHORE`: moved library to [bpmn-io/bpmnlint](https://github.com/bpmn-io/bpmnlint)
-* `CHORE`: full rewrite of internals
-* `CHORE`: `utils` API change
-
-## ...
-
-Check `git log` for earlier history.