feat: allow path property in Reporter#report

Closes #69
bpmn-io · Mar 7, 2022 · 4355283 · 4355283
1 parent c3cf69e
commit 4355283
Show file tree

Hide file tree

Showing 3 changed files with 70 additions and 6 deletions.
diff --git a/bin/bpmnlint.js b/bin/bpmnlint.js
@@ -107,11 +107,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() {
@@ -384,4 +394,16 @@ Learn more about configuring bpmnlint: https://github.com/bpmn-io/bpmnlint#confi
   return lint(actualFiles, config);
 }
 
-run().catch(errorAndExit);
+run().catch(errorAndExit);
+
+// helpers //////////
+
+/**
+ * @param {(number|string)[]} path
+ * @param {string} [separator]
+ *
+ * @returns {string}
+ */
+function pathStringify(path, separator = '.') {
+  return path.join(separator);
+}
diff --git a/lib/test-rule.js b/lib/test-rule.js
@@ -8,8 +8,20 @@ class Reporter {
     this.report = this.report.bind(this);
   }
 
-  report(id, message) {
-    this.messages.push({ id, message });
+  report(id, message, path) {
+    let report = {
+      id,
+      message
+    };
+
+    if (path) {
+      report = {
+        ...report,
+        path
+      };
+    }
+
+    this.messages.push(report);
   }
 }
 

diff --git a/test/spec/test-rule-spec.js b/test/spec/test-rule-spec.js
@@ -16,7 +16,7 @@ describe('test-rule', function() {
   });
 
 
-  it('should return check function reported messages', () => {
+  it('should return check function reported messages (id, message)', () => {
 
     // given
     const expectedMessages = [
@@ -35,6 +35,26 @@ describe('test-rule', function() {
   });
 
 
+  it('should return check function reported messages (id, message, path)', () => {
+
+    // given
+    const expectedMessages = [
+      {
+        id: 'Collaboration_0wzd2dx',
+        message: 'Collaboration detected',
+        path: [ 'rootElements', 0 ]
+      }
+    ];
+    const messages = testRule({
+      moddleRoot,
+      rule: createRule(fakeCheckRuleWithPath)
+    });
+
+    // then
+    expect(messages).to.eql(expectedMessages);
+  });
+
+
   it('should return { enter, leave } hook reported messages', () => {
 
     // given
@@ -85,6 +105,16 @@ function fakeCheckRuleWithReports() {
   return { check };
 }
 
+function fakeCheckRuleWithPath() {
+  function check(node, reporter) {
+    if (is(node, 'Collaboration')) {
+      reporter.report(node.id, 'Collaboration detected', [ 'rootElements', 0 ]);
+    }
+  }
+
+  return { check };
+}
+
 function fakeEnterLeaveRuleWithReports() {
   function enter(node, reporter) {
     if (is(node, 'Definitions')) {