bpmnlint 7.5.0 → 7.6.0

package/CHANGELOG.md

@@ -6,6 +6,11 @@ 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))

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,19 +14,42 @@ class Reporter {
     this.report = this.report.bind(this);
   }
 
+  /**
+   * @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) {
+    if (path && isArray(path)) {
       report = {
         ...report,
         path
       };
     }
 
+    if (path && isObject(path)) {
+      report = {
+        ...report,
+        ...path
+      };
+    }
+
     this.messages.push(report);
   }
 }

package/package.json

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