@retemper/lodestar-reporter-junit 0.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Minhyeok Kang and contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.d.ts

@@ -0,0 +1,27 @@
+import { Violation, RunSummary, WorkspaceReporter } from '@retemper/lodestar-types';
+
+/** Options for the JUnit reporter */
+interface JunitReporterOptions {
+    /** Output file path — writes to stdout if omitted */
+    readonly output?: string;
+}
+/** Collected result per rule */
+interface RuleEntry {
+    readonly ruleId: string;
+    readonly violations: Violation[];
+    readonly durationMs: number;
+    readonly error?: Error;
+}
+/** Create a JUnit XML reporter that outputs test-suite style results */
+declare function createJunitReporter(options?: JunitReporterOptions): WorkspaceReporter;
+/** Build JUnit XML string from rule entries */
+declare function buildJunitXml(entries: readonly RuleEntry[], summary: RunSummary): string;
+/** Escape special XML characters */
+declare function escapeXml(str: string): string;
+/** Create a JUnit ReporterFactory for use in lodestar config */
+declare function junitReporter(options?: JunitReporterOptions): {
+    name: string;
+    create: () => WorkspaceReporter;
+};
+
+export { type JunitReporterOptions, buildJunitXml, createJunitReporter, escapeXml, junitReporter };

package/dist/index.js

@@ -0,0 +1,97 @@
+// src/reporter/junit-reporter.ts
+import { writeFile } from "fs/promises";
+function createJunitReporter(options) {
+  const ruleEntries = [];
+  return {
+    name: "junit",
+    onStart() {
+    },
+    onRuleComplete(result) {
+      ruleEntries.push({
+        ruleId: result.ruleId,
+        violations: [...result.violations],
+        durationMs: result.durationMs,
+        error: result.error
+      });
+    },
+    onViolation() {
+    },
+    async onComplete(summary) {
+      const xml = buildJunitXml(ruleEntries, summary);
+      if (options?.output) {
+        await writeFile(options.output, xml, "utf-8");
+      } else {
+        process.stdout.write(xml);
+      }
+    },
+    onPackageStart(_pkg) {
+    },
+    onPackageComplete(_pkg, _summary) {
+    }
+  };
+}
+function buildJunitXml(entries, summary) {
+  const lines = [];
+  lines.push('<?xml version="1.0" encoding="UTF-8"?>');
+  const totalTests = entries.length;
+  const totalFailures = entries.filter(
+    (e) => e.violations.some((v) => v.severity === "error")
+  ).length;
+  const totalErrors = entries.filter((e) => e.error).length;
+  const totalTime = (summary.durationMs / 1e3).toFixed(3);
+  lines.push(
+    `<testsuites tests="${totalTests}" failures="${totalFailures}" errors="${totalErrors}" time="${totalTime}">`
+  );
+  for (const entry of entries) {
+    const errors = entry.violations.filter((v) => v.severity === "error");
+    const warnings = entry.violations.filter((v) => v.severity === "warn");
+    const time = (entry.durationMs / 1e3).toFixed(3);
+    lines.push(
+      `  <testsuite name="${escapeXml(entry.ruleId)}" tests="1" failures="${errors.length > 0 ? 1 : 0}" errors="${entry.error ? 1 : 0}" time="${time}">`
+    );
+    if (entry.error) {
+      lines.push(`    <testcase name="${escapeXml(entry.ruleId)}" time="${time}">`);
+      lines.push(
+        `      <error message="${escapeXml(entry.error.message)}">${escapeXml(entry.error.message)}</error>`
+      );
+      lines.push("    </testcase>");
+    } else if (errors.length > 0) {
+      lines.push(`    <testcase name="${escapeXml(entry.ruleId)}" time="${time}">`);
+      const failureText = errors.map((v) => formatViolation(v)).join("\n");
+      lines.push(
+        `      <failure message="${escapeXml(`${errors.length} violation(s)`)}">${escapeXml(failureText)}</failure>`
+      );
+      lines.push("    </testcase>");
+    } else if (warnings.length > 0) {
+      lines.push(`    <testcase name="${escapeXml(entry.ruleId)}" time="${time}">`);
+      const warnText = warnings.map((v) => formatViolation(v)).join("\n");
+      lines.push(`      <system-out>${escapeXml(warnText)}</system-out>`);
+      lines.push("    </testcase>");
+    } else {
+      lines.push(`    <testcase name="${escapeXml(entry.ruleId)}" time="${time}"/>`);
+    }
+    lines.push("  </testsuite>");
+  }
+  lines.push("</testsuites>");
+  return lines.join("\n");
+}
+function formatViolation(v) {
+  const location = v.location ? ` at ${v.location.file}${v.location.line ? `:${v.location.line}` : ""}` : "";
+  return `${v.message}${location}`;
+}
+function escapeXml(str) {
+  return str.replaceAll("&", "&amp;").replaceAll("<", "&lt;").replaceAll(">", "&gt;").replaceAll('"', "&quot;").replaceAll("'", "&apos;");
+}
+function junitReporter(options) {
+  return {
+    name: "junit",
+    create: () => createJunitReporter(options)
+  };
+}
+export {
+  buildJunitXml,
+  createJunitReporter,
+  escapeXml,
+  junitReporter
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/reporter/junit-reporter.ts"],"sourcesContent":["import { writeFile } from 'node:fs/promises';\nimport type {\n  WorkspaceReporter,\n  WorkspacePackageInfo,\n  Violation,\n  RunSummary,\n  RuleResultSummary,\n} from '@retemper/lodestar-types';\n\n/** Options for the JUnit reporter */\ninterface JunitReporterOptions {\n  /** Output file path — writes to stdout if omitted */\n  readonly output?: string;\n}\n\n/** Collected result per rule */\ninterface RuleEntry {\n  readonly ruleId: string;\n  readonly violations: Violation[];\n  readonly durationMs: number;\n  readonly error?: Error;\n}\n\n/** Create a JUnit XML reporter that outputs test-suite style results */\nfunction createJunitReporter(options?: JunitReporterOptions): WorkspaceReporter {\n  const ruleEntries: RuleEntry[] = [];\n\n  return {\n    name: 'junit',\n\n    onStart() {},\n\n    onRuleComplete(result: RuleResultSummary) {\n      ruleEntries.push({\n        ruleId: result.ruleId,\n        violations: [...result.violations],\n        durationMs: result.durationMs,\n        error: result.error,\n      });\n    },\n\n    onViolation() {},\n\n    async onComplete(summary: RunSummary) {\n      const xml = buildJunitXml(ruleEntries, summary);\n\n      if (options?.output) {\n        await writeFile(options.output, xml, 'utf-8');\n      } else {\n        process.stdout.write(xml);\n      }\n    },\n\n    onPackageStart(_pkg: WorkspacePackageInfo) {},\n    onPackageComplete(_pkg: WorkspacePackageInfo, _summary: RunSummary) {},\n  };\n}\n\n/** Build JUnit XML string from rule entries */\nfunction buildJunitXml(entries: readonly RuleEntry[], summary: RunSummary): string {\n  const lines: string[] = [];\n  lines.push('<?xml version=\"1.0\" encoding=\"UTF-8\"?>');\n\n  const totalTests = entries.length;\n  const totalFailures = entries.filter((e) =>\n    e.violations.some((v) => v.severity === 'error'),\n  ).length;\n  const totalErrors = entries.filter((e) => e.error).length;\n  const totalTime = (summary.durationMs / 1000).toFixed(3);\n\n  lines.push(\n    `<testsuites tests=\"${totalTests}\" failures=\"${totalFailures}\" errors=\"${totalErrors}\" time=\"${totalTime}\">`,\n  );\n\n  for (const entry of entries) {\n    const errors = entry.violations.filter((v) => v.severity === 'error');\n    const warnings = entry.violations.filter((v) => v.severity === 'warn');\n    const time = (entry.durationMs / 1000).toFixed(3);\n\n    lines.push(\n      `  <testsuite name=\"${escapeXml(entry.ruleId)}\" tests=\"1\" failures=\"${errors.length > 0 ? 1 : 0}\" errors=\"${entry.error ? 1 : 0}\" time=\"${time}\">`,\n    );\n\n    if (entry.error) {\n      lines.push(`    <testcase name=\"${escapeXml(entry.ruleId)}\" time=\"${time}\">`);\n      lines.push(\n        `      <error message=\"${escapeXml(entry.error.message)}\">${escapeXml(entry.error.message)}</error>`,\n      );\n      lines.push('    </testcase>');\n    } else if (errors.length > 0) {\n      lines.push(`    <testcase name=\"${escapeXml(entry.ruleId)}\" time=\"${time}\">`);\n      const failureText = errors.map((v) => formatViolation(v)).join('\\n');\n      lines.push(\n        `      <failure message=\"${escapeXml(`${errors.length} violation(s)`)}\">${escapeXml(failureText)}</failure>`,\n      );\n      lines.push('    </testcase>');\n    } else if (warnings.length > 0) {\n      lines.push(`    <testcase name=\"${escapeXml(entry.ruleId)}\" time=\"${time}\">`);\n      const warnText = warnings.map((v) => formatViolation(v)).join('\\n');\n      lines.push(`      <system-out>${escapeXml(warnText)}</system-out>`);\n      lines.push('    </testcase>');\n    } else {\n      lines.push(`    <testcase name=\"${escapeXml(entry.ruleId)}\" time=\"${time}\"/>`);\n    }\n\n    lines.push('  </testsuite>');\n  }\n\n  lines.push('</testsuites>');\n  return lines.join('\\n');\n}\n\n/** Format a violation as a human-readable string */\nfunction formatViolation(v: Violation): string {\n  const location = v.location\n    ? ` at ${v.location.file}${v.location.line ? `:${v.location.line}` : ''}`\n    : '';\n  return `${v.message}${location}`;\n}\n\n/** Escape special XML characters */\nfunction escapeXml(str: string): string {\n  return str\n    .replaceAll('&', '&amp;')\n    .replaceAll('<', '&lt;')\n    .replaceAll('>', '&gt;')\n    .replaceAll('\"', '&quot;')\n    .replaceAll(\"'\", '&apos;');\n}\n\n/** Create a JUnit ReporterFactory for use in lodestar config */\nfunction junitReporter(options?: JunitReporterOptions) {\n  return {\n    name: 'junit',\n    create: () => createJunitReporter(options),\n  };\n}\n\nexport { createJunitReporter, junitReporter, buildJunitXml, escapeXml };\nexport type { JunitReporterOptions };\n"],"mappings":";AAAA,SAAS,iBAAiB;AAwB1B,SAAS,oBAAoB,SAAmD;AAC9E,QAAM,cAA2B,CAAC;AAElC,SAAO;AAAA,IACL,MAAM;AAAA,IAEN,UAAU;AAAA,IAAC;AAAA,IAEX,eAAe,QAA2B;AACxC,kBAAY,KAAK;AAAA,QACf,QAAQ,OAAO;AAAA,QACf,YAAY,CAAC,GAAG,OAAO,UAAU;AAAA,QACjC,YAAY,OAAO;AAAA,QACnB,OAAO,OAAO;AAAA,MAChB,CAAC;AAAA,IACH;AAAA,IAEA,cAAc;AAAA,IAAC;AAAA,IAEf,MAAM,WAAW,SAAqB;AACpC,YAAM,MAAM,cAAc,aAAa,OAAO;AAE9C,UAAI,SAAS,QAAQ;AACnB,cAAM,UAAU,QAAQ,QAAQ,KAAK,OAAO;AAAA,MAC9C,OAAO;AACL,gBAAQ,OAAO,MAAM,GAAG;AAAA,MAC1B;AAAA,IACF;AAAA,IAEA,eAAe,MAA4B;AAAA,IAAC;AAAA,IAC5C,kBAAkB,MAA4B,UAAsB;AAAA,IAAC;AAAA,EACvE;AACF;AAGA,SAAS,cAAc,SAA+B,SAA6B;AACjF,QAAM,QAAkB,CAAC;AACzB,QAAM,KAAK,wCAAwC;AAEnD,QAAM,aAAa,QAAQ;AAC3B,QAAM,gBAAgB,QAAQ;AAAA,IAAO,CAAC,MACpC,EAAE,WAAW,KAAK,CAAC,MAAM,EAAE,aAAa,OAAO;AAAA,EACjD,EAAE;AACF,QAAM,cAAc,QAAQ,OAAO,CAAC,MAAM,EAAE,KAAK,EAAE;AACnD,QAAM,aAAa,QAAQ,aAAa,KAAM,QAAQ,CAAC;AAEvD,QAAM;AAAA,IACJ,sBAAsB,UAAU,eAAe,aAAa,aAAa,WAAW,WAAW,SAAS;AAAA,EAC1G;AAEA,aAAW,SAAS,SAAS;AAC3B,UAAM,SAAS,MAAM,WAAW,OAAO,CAAC,MAAM,EAAE,aAAa,OAAO;AACpE,UAAM,WAAW,MAAM,WAAW,OAAO,CAAC,MAAM,EAAE,aAAa,MAAM;AACrE,UAAM,QAAQ,MAAM,aAAa,KAAM,QAAQ,CAAC;AAEhD,UAAM;AAAA,MACJ,sBAAsB,UAAU,MAAM,MAAM,CAAC,yBAAyB,OAAO,SAAS,IAAI,IAAI,CAAC,aAAa,MAAM,QAAQ,IAAI,CAAC,WAAW,IAAI;AAAA,IAChJ;AAEA,QAAI,MAAM,OAAO;AACf,YAAM,KAAK,uBAAuB,UAAU,MAAM,MAAM,CAAC,WAAW,IAAI,IAAI;AAC5E,YAAM;AAAA,QACJ,yBAAyB,UAAU,MAAM,MAAM,OAAO,CAAC,KAAK,UAAU,MAAM,MAAM,OAAO,CAAC;AAAA,MAC5F;AACA,YAAM,KAAK,iBAAiB;AAAA,IAC9B,WAAW,OAAO,SAAS,GAAG;AAC5B,YAAM,KAAK,uBAAuB,UAAU,MAAM,MAAM,CAAC,WAAW,IAAI,IAAI;AAC5E,YAAM,cAAc,OAAO,IAAI,CAAC,MAAM,gBAAgB,CAAC,CAAC,EAAE,KAAK,IAAI;AACnE,YAAM;AAAA,QACJ,2BAA2B,UAAU,GAAG,OAAO,MAAM,eAAe,CAAC,KAAK,UAAU,WAAW,CAAC;AAAA,MAClG;AACA,YAAM,KAAK,iBAAiB;AAAA,IAC9B,WAAW,SAAS,SAAS,GAAG;AAC9B,YAAM,KAAK,uBAAuB,UAAU,MAAM,MAAM,CAAC,WAAW,IAAI,IAAI;AAC5E,YAAM,WAAW,SAAS,IAAI,CAAC,MAAM,gBAAgB,CAAC,CAAC,EAAE,KAAK,IAAI;AAClE,YAAM,KAAK,qBAAqB,UAAU,QAAQ,CAAC,eAAe;AAClE,YAAM,KAAK,iBAAiB;AAAA,IAC9B,OAAO;AACL,YAAM,KAAK,uBAAuB,UAAU,MAAM,MAAM,CAAC,WAAW,IAAI,KAAK;AAAA,IAC/E;AAEA,UAAM,KAAK,gBAAgB;AAAA,EAC7B;AAEA,QAAM,KAAK,eAAe;AAC1B,SAAO,MAAM,KAAK,IAAI;AACxB;AAGA,SAAS,gBAAgB,GAAsB;AAC7C,QAAM,WAAW,EAAE,WACf,OAAO,EAAE,SAAS,IAAI,GAAG,EAAE,SAAS,OAAO,IAAI,EAAE,SAAS,IAAI,KAAK,EAAE,KACrE;AACJ,SAAO,GAAG,EAAE,OAAO,GAAG,QAAQ;AAChC;AAGA,SAAS,UAAU,KAAqB;AACtC,SAAO,IACJ,WAAW,KAAK,OAAO,EACvB,WAAW,KAAK,MAAM,EACtB,WAAW,KAAK,MAAM,EACtB,WAAW,KAAK,QAAQ,EACxB,WAAW,KAAK,QAAQ;AAC7B;AAGA,SAAS,cAAc,SAAgC;AACrD,SAAO;AAAA,IACL,MAAM;AAAA,IACN,QAAQ,MAAM,oBAAoB,OAAO;AAAA,EAC3C;AACF;","names":[]}

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@retemper/lodestar-reporter-junit",
+  "version": "0.0.0",
+  "type": "module",
+  "description": "JUnit XML reporter for Lodestar — output violations as JUnit test results for CI integration",
+  "license": "MIT",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@retemper/lodestar-types": "0.0.0"
+  },
+  "devDependencies": {
+    "tsup": "^8.3.0",
+    "typescript": "^5.6.0",
+    "vitest": "^4.1.0"
+  },
+  "sideEffects": false,
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/retemper/lodestar",
+    "directory": "packages/reporter-junit"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "type-check": "tsc --noEmit",
+    "lint": "eslint src/"
+  }
+}