refactor: adjust rule details format in generated markdown report

Rather than generating one big table, with lots of wide columns, this
generates one table per violation to be more extendable with new fields.
It also ends up being more consistent with how the data is displayed in
the CLI output.

Signed-off-by: Dustin Popp <[email protected]>

Author: dpopp07

packages/validator/src/markdown-report/tables/rule-violation-details.js

@@ -1,28 +1,26 @@
 /**
- * Copyright 2024 IBM Corporation.
+ * Copyright 2024 - 2025 IBM Corporation.
  * SPDX-License-Identifier: Apache2.0
  */
 
 const MarkdownTable = require('../markdown-table');
 
-function getTable({ error, warning }) {
-  const table = new MarkdownTable(
-    'Rule',
-    'Message',
-    'Path',
-    'Line',
-    'Severity'
-  );
+function getTables(violations) {
+  let tableOutput = '';
+  for (const severity of ['error', 'warning']) {
+    for (const { message, path, rule, line } of violations[severity].results) {
+      const table = new MarkdownTable('Rule', rule);
+      table.addRow('Message', message);
+      table.addRow('Path', path.join('.'));
+      table.addRow('Line', line);
+      table.addRow('Severity', severity);
 
-  error.results.forEach(({ message, path, rule, line }) => {
-    table.addRow(rule, message, path.join('.'), line, 'error');
-  });
+      tableOutput += `${table.render()}\n\n`;
+    }
+  }
 
-  warning.results.forEach(({ message, path, rule, line }) => {
-    table.addRow(rule, message, path.join('.'), line, 'warning');
-  });
-
-  return table.render();
+  // Remove the final newline characters from the string.
+  return tableOutput.trim();
 }
 
-module.exports = getTable;
+module.exports = getTables;

packages/validator/test/markdown-report/tables/rule-violation-details.test.js

@@ -1,5 +1,5 @@
 /**
- * Copyright 2024 IBM Corporation.
+ * Copyright 2024 - 2025 IBM Corporation.
  * SPDX-License-Identifier: Apache2.0
  */
 
@@ -10,17 +10,44 @@ describe('ruleViolationDetails table tests', function () {
   it('should produce a table with all rule violations from the results', function () {
     const tableRows = ruleViolationDetails(validatorResults).split('\n');
 
-    expect(tableRows).toHaveLength(5);
-    expect(tableRows[0]).toBe('| Rule | Message | Path | Line | Severity |');
-    expect(tableRows[1]).toBe('| --- | --- | --- | --- | --- |');
+    expect(tableRows).toHaveLength(20);
+
+    // First rule.
+    expect(tableRows[0]).toBe(
+      '| Rule | ibm-no-consecutive-path-parameter-segments |'
+    );
+    expect(tableRows[1]).toBe('| --- | --- |');
     expect(tableRows[2]).toBe(
-      '| ibm-no-consecutive-path-parameter-segments | Path contains two or more consecutive path parameter references: /pets/{pet_id}/{id} | paths./pets/{pet_id}/{id} | 84 | error |'
+      '| Message | Path contains two or more consecutive path parameter references: /pets/{pet_id}/{id} |'
+    );
+    expect(tableRows[3]).toBe('| Path | paths./pets/{pet_id}/{id} |');
+    expect(tableRows[4]).toBe('| Line | 84 |');
+    expect(tableRows[5]).toBe('| Severity | error |');
+    expect(tableRows[6]).toBe('');
+
+    // Second rule.
+    expect(tableRows[7]).toBe('| Rule | ibm-integer-attributes |');
+    expect(tableRows[8]).toBe('| --- | --- |');
+    expect(tableRows[9]).toBe(
+      `| Message | Integer schemas should define property 'minimum' |`
+    );
+    expect(tableRows[10]).toBe(
+      '| Path | components.schemas.Pet.properties.id |'
     );
-    expect(tableRows[3]).toBe(
-      "| ibm-integer-attributes | Integer schemas should define property 'minimum' | components.schemas.Pet.properties.id | 133 | error |"
+    expect(tableRows[11]).toBe('| Line | 133 |');
+    expect(tableRows[12]).toBe('| Severity | error |');
+    expect(tableRows[13]).toBe('');
+
+    // Third rule.
+    expect(tableRows[14]).toBe('| Rule | ibm-anchored-patterns |');
+    expect(tableRows[15]).toBe('| --- | --- |');
+    expect(tableRows[16]).toBe(
+      `| Message | A regular expression used in a 'pattern' attribute should be anchored with ^ and $ |`
     );
-    expect(tableRows[4]).toBe(
-      "| ibm-anchored-patterns | A regular expression used in a 'pattern' attribute should be anchored with ^ and $ | components.schemas.Error.properties.message.pattern | 233 | warning |"
+    expect(tableRows[17]).toBe(
+      '| Path | components.schemas.Error.properties.message.pattern |'
     );
+    expect(tableRows[18]).toBe('| Line | 233 |');
+    expect(tableRows[19]).toBe('| Severity | warning |');
   });
 });