bpmnlint 7.3.0 → 7.6.0

package/CHANGELOG.md

@@ -6,6 +6,21 @@ All notable changes to [bpmnlint](https://github.com/bpmn-io/bpmnlint) are docum
 
 ___Note:__ Yet to be released changes appear here._
 
+## 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))

package/README.md

@@ -73,7 +73,9 @@ To try out visual validation, checkout the [bpmnlint playground](https://github.
 
 Use the [bpmnlint playground](https://github.com/bpmn-io/bpmnlint-playground) to implement new rules with quick visual feedback.
 
-For more details on how to define and consume custom lint rules check out the [bpmnlint-plugin-example](https://github.com/bpmn-io/bpmnlint-plugin-example).
+Create your first plug-in using the [plugin creator](https://github.com/nikku/create-bpmnlint-plugin).
+
+Checkout the [bpmnlint-plugin-example](https://github.com/bpmn-io/bpmnlint-plugin-example) for details on how to define, test, and consume custom lint rules.
 
 
 ## License

package/bin/bpmnlint.js

@@ -28,6 +28,8 @@ const Table = require('cli-table');
 
 const pluralize = require('pluralize');
 
+const { pathStringify } = require('@philippfromme/moddle-helpers');
+
 const CONFIG_NAME = '.bpmnlintrc';
 
 const DEFAULT_CONFIG_CONTENTS = `{
@@ -107,11 +109,21 @@ const categoryMap = {
  * Logs a formatted  message
  */
 function tableEntry(report) {
-  const category = report.category;
+  let {
+    category,
+    id = '',
+    message,
+    name = '',
+    path
+  } = report;
+
+  if (path) {
+    id = `${ id }#${ pathStringify(path) }`;
+  }
 
   const color = category === 'error' ? red : yellow;
 
-  return [ report.id || '', color(categoryMap[category] || category), report.message, report.name || '' ];
+  return [ id, color(categoryMap[ category ] || category), message, name ];
 }
 
 function createTable() {

package/lib/resolver/node-resolver.js

@@ -9,6 +9,12 @@ function NodeResolver(options) {
   this.require = options && options.require || createScopedRequire(process.cwd());
 
   this.requireLocal = options && options.requireLocal || require;
+
+  try {
+    this.pkg = this.require('./package.json').name;
+  } catch (err) {
+    this.pkg = '__unknown';
+  }
 }
 
 module.exports = NodeResolver;
@@ -16,6 +22,10 @@ module.exports = NodeResolver;
 
 NodeResolver.prototype.resolveRule = function(pkg, ruleName) {
 
+  const originalPkg = pkg;
+
+  pkg = this.normalizePkg(pkg);
+
   try {
     if (pkg === 'bpmnlint') {
       return this.requireLocal(`../../rules/${ruleName}`);
@@ -23,12 +33,16 @@ NodeResolver.prototype.resolveRule = function(pkg, ruleName) {
       return this.require(`${pkg}/rules/${ruleName}`);
     }
   } catch (err) {
-    throw new Error('Cannot resolve rule <' + ruleName + '> from <' + pkg + '>');
+    throw new Error('Cannot resolve rule <' + ruleName + '> from <' + originalPkg + '>');
   }
 };
 
 NodeResolver.prototype.resolveConfig = function(pkg, configName) {
 
+  const originalPkg = pkg;
+
+  pkg = this.normalizePkg(pkg);
+
   // resolve config via $PKG/config/$NAME
   try {
     if (pkg === 'bpmnlint') {
@@ -53,10 +67,17 @@ NodeResolver.prototype.resolveConfig = function(pkg, configName) {
   }
 
   throw new Error(
-    'Cannot resolve config <' + configName + '> from <' + pkg + '>'
+    'Cannot resolve config <' + configName + '> from <' + originalPkg + '>'
   );
 };
 
+NodeResolver.prototype.normalizePkg = function(pkg) {
+  if (pkg !== 'bpmnlint' && pkg === this.pkg) {
+    pkg = '.';
+  }
+
+  return pkg;
+};
 
 // helpers ////////////////////
 

package/lib/support/compile-config.js

@@ -7,13 +7,15 @@ const NodeResolver = require('../resolver/node-resolver');
  * a { config, resolver } bundle, resolving all enabled rules.
  *
  * @param  {Object} config the parsed bpmnlint configuration
- *
+ * @param  {NodeResolver} [resolver]
  * @return {Promise<String>} the configuration compiled to a JS file
  */
-async function compileConfig(config) {
+async function compileConfig(config, resolver) {
+
+  resolver = resolver || new NodeResolver();
 
   const linter = new Linter({
-    resolver: new NodeResolver()
+    resolver
   });
 
   const resolvedRules = await linter.resolveConfiguredRules(config);
@@ -86,7 +88,7 @@ export default bundle;
     } = linter.parseRuleName(key);
 
     return `
-import rule_${idx} from '${pkg}/rules/${ruleName}';
+import rule_${idx} from '${resolver.normalizePkg(pkg)}/rules/${ruleName}';
 cache['${pkg}/${ruleName}'] = rule_${idx};`;
   }).join('\n');
 

package/lib/test-rule.js

@@ -1,5 +1,11 @@
 const traverse = require('./traverse');
 
+const {
+  isArray,
+  isObject
+} = require('min-dash');
+
+
 class Reporter {
   constructor({ moddleRoot, rule }) {
     this.rule = rule;
@@ -8,8 +14,43 @@ class Reporter {
     this.report = this.report.bind(this);
   }
 
-  report(id, message) {
-    this.messages.push({ id, message });
+  /**
+   * @param {string} id
+   * @param {string} message
+   * @param {string[]|Object} path
+   *
+   * @example
+   *
+   * Reporter.report('foo', 'Foo error', [ 'foo', 'bar', 'baz' ]);
+   *
+   * @example
+   *
+   * Reporter.report('foo', 'Foo error', {
+   *  path: [ 'foo', 'bar', 'baz' ],
+   *  foo: 'foo'
+   * });
+   */
+  report(id, message, path) {
+    let report = {
+      id,
+      message
+    };
+
+    if (path && isArray(path)) {
+      report = {
+        ...report,
+        path
+      };
+    }
+
+    if (path && isObject(path)) {
+      report = {
+        ...report,
+        ...path
+      };
+    }
+
+    this.messages.push(report);
   }
 }
 

package/lib/testers/rule-tester.js

@@ -33,9 +33,9 @@ function verify(ruleName, rule, testCases) {
 
     describe('should lint valid', function() {
 
-      testCases.valid.forEach(({ moddleElement, it: _it }, idx) => (
+      testCases.valid.forEach(({ moddleElement, name, it: _it }, idx) => (
 
-        (_it || it)(`test case #${idx + 1}`, function() {
+        (_it || it)(getTitle(idx, name), function() {
           return (
             Promise.resolve(moddleElement)
               .then(moddleRoot => {
@@ -54,9 +54,9 @@ function verify(ruleName, rule, testCases) {
 
     describe('should lint invalid', function() {
 
-      testCases.invalid.forEach(({ moddleElement, report, it: _it }, idx) => (
+      testCases.invalid.forEach(({ moddleElement, name, report, it: _it }, idx) => (
 
-        (_it || it)(`test case #${idx}`, function() {
+        (_it || it)(getTitle(idx, name), function() {
 
           if (!Array.isArray(report)) {
             report = [
@@ -94,7 +94,11 @@ function verify(ruleName, rule, testCases) {
 
 }
 
+function getTitle(idx, name) {
+  return `test case #${ idx + 1 }${ name ? ` ${ name }`: '' }`;
+}
 
 module.exports = {
-  verify
+  verify,
+  getTitle
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "bpmnlint",
   "description": "Validate your BPMN diagrams based on configurable lint rules",
-  "version": "7.3.0",
+  "version": "7.6.0",
   "main": "lib/index.js",
   "keywords": [
     "bpmnlint",
@@ -37,24 +37,25 @@
     "bpmnlint": "./bin/bpmnlint.js"
   },
   "dependencies": {
+    "@philippfromme/moddle-helpers": "^0.1.0",
     "ansi-colors": "^4.1.1",
-    "bpmn-moddle": "^7.0.3",
+    "bpmn-moddle": "^7.1.2",
     "bpmnlint-utils": "^1.0.2",
-    "cli-table": "^0.3.1",
+    "cli-table": "^0.3.9",
     "color-support": "^1.1.3",
-    "min-dash": "^3.5.2",
-    "mri": "^1.1.6",
+    "min-dash": "^3.8.0",
+    "mri": "^1.2.0",
     "pluralize": "^7.0.0",
-    "tiny-glob": "^0.2.8"
+    "tiny-glob": "^0.2.9"
   },
   "devDependencies": {
-    "chai": "^4.2.0",
-    "eslint": "^7.14.0",
+    "chai": "^4.3.4",
+    "eslint": "^7.32.0",
     "eslint-plugin-bpmn-io": "^0.11.0",
     "esm": "^3.2.25",
-    "execa": "^2.0.3",
+    "execa": "^2.1.0",
     "install-local": "^1.0.0",
-    "mocha": "^8.2.1",
+    "mocha": "^8.4.0",
     "npm-run-all": "^4.1.5",
     "nyc": "^15.1.0",
     "strip-indent": "^2.0.0"

package/rules/conditional-flows.js

@@ -20,7 +20,7 @@ module.exports = function() {
       );
 
       if (missingCondition) {
-        reporter.report(flow.id, 'Sequence flow is missing condition');
+        reporter.report(flow.id, 'Sequence flow is missing condition', [ 'conditionExpression' ]);
       }
     });
   }

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

@@ -25,7 +25,7 @@ module.exports = function() {
       const eventDefinitions = flowElement.eventDefinitions || [];
 
       if (eventDefinitions.length === 0) {
-        reporter.report(flowElement.id, 'Start event is missing event definition');
+        reporter.report(flowElement.id, 'Start event is missing event definition', [ 'eventDefinitions' ]);
       }
     });
   }

package/rules/label-required.js

@@ -50,7 +50,7 @@ module.exports = function() {
       const name = (node.name || '').trim();
 
       if (name.length === 0) {
-        reporter.report(node.id, 'Element is missing label/name');
+        reporter.report(node.id, 'Element is missing label/name', [ 'name' ]);
       }
     }
   }

package/rules/single-event-definition.js

@@ -17,7 +17,7 @@ module.exports = function() {
     const eventDefinitions = node.eventDefinitions || [];
 
     if (eventDefinitions.length > 1) {
-      reporter.report(node.id, 'Event has multiple event definitions');
+      reporter.report(node.id, 'Event has multiple event definitions', [ 'eventDefinitions' ]);
     }
   }
 

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

@@ -26,7 +26,7 @@ module.exports = function() {
       const eventDefinitions = flowElement.eventDefinitions || [];
 
       if (eventDefinitions.length > 0) {
-        reporter.report(flowElement.id, 'Start event must be blank');
+        reporter.report(flowElement.id, 'Start event must be blank', [ 'eventDefinitions' ]);
       }
     });
   }