@cms-lab/reporter 1.2.1 → 1.2.3

package/README.md

@@ -9,6 +9,16 @@ import { renderHtmlReport } from "@cms-lab/reporter";
 The CLI uses this package for `cms-lab scan --report`. The generated report is a
 self-contained HTML file with grouped diagnostics and client-side filters.
 
+Use the share privacy mode when rendering a report that may be attached to a
+public issue:
+
+```ts
+renderHtmlReport(result, { privacy: "share" });
+```
+
+Share-safe reports keep diagnostic codes, severity, route paths, and field paths
+visible, but redact CMS source IDs and local project paths.
+
 ## Release History
 
 See the repository [changelog](https://github.com/i-afaqrashid/cms-lab/blob/main/CHANGELOG.md)

package/dist/index.d.ts

@@ -5,6 +5,10 @@ type ReporterStatus = {
     format: "html";
 };
 declare function getReporterStatus(): ReporterStatus;
-declare function renderHtmlReport(result: ScanResult): string;
+type HtmlReportPrivacy = "full" | "share";
+type HtmlReportOptions = {
+    privacy?: HtmlReportPrivacy;
+};
+declare function renderHtmlReport(result: ScanResult, options?: HtmlReportOptions): string;
 
-export { type ReporterStatus, getReporterStatus, renderHtmlReport };
+export { type HtmlReportOptions, type HtmlReportPrivacy, type ReporterStatus, getReporterStatus, renderHtmlReport };

package/dist/index.js

@@ -18,9 +18,10 @@ function getReporterStatus() {
     format: "html"
   };
 }
-function renderHtmlReport(result) {
+function renderHtmlReport(result, options = {}) {
   const generatedAt = (/* @__PURE__ */ new Date()).toISOString();
   const diagnostics = result.diagnostics;
+  const privacy = options.privacy ?? "full";
   const status = result.summary.errors > 0 ? "failed" : "passed";
   const statusClass = result.summary.errors > 0 ? "fail" : result.summary.warnings > 0 ? "warn" : "ok";
   const grouped = groupDiagnostics(diagnostics);
@@ -411,6 +412,7 @@ function renderHtmlReport(result) {
                 <span class="badge ${statusClass}">${escapeHtml(statusLabel(result))}</span>
                 ${result.summary.warnings > 0 ? `<span class="badge warn">${result.summary.warnings} ${escapeHtml(plural(result.summary.warnings, "warning"))}</span>` : ""}
                 ${result.summary.info > 0 ? `<span class="badge info">${result.summary.info} ${escapeHtml(plural(result.summary.info, "info item"))}</span>` : ""}
+                ${privacy === "share" ? `<span class="badge">Share-safe report</span>` : ""}
               </div>
               <div class="subtitle">
                 ${escapeHtml(projectLabel(result))} \xB7 ${result.documents.length} ${escapeHtml(plural(result.documents.length, "document"))}
@@ -436,7 +438,7 @@ function renderHtmlReport(result) {
           ${grouped.map((group) => `<button class="chip" type="button" data-filter-kind="group" data-filter-value="${escapeHtml(group.label)}">${escapeHtml(group.label)} <span class="n">${group.diagnostics.length}</span></button>`).join("")}
         </div>
 
-        ${diagnostics.length === 0 ? `<div class="empty-state">No diagnostics found.</div>` : grouped.map((group) => diagnosticsGroup(group)).join("")}
+        ${diagnostics.length === 0 ? `<div class="empty-state">No diagnostics found.</div>` : grouped.map((group) => diagnosticsGroup(group, result, privacy)).join("")}
 
         <div class="report-foot">
           <span>project: <span class="path-code">${escapeHtml(result.project.framework)} ${escapeHtml(result.project.router)}</span></span>
@@ -542,24 +544,45 @@ function groupForDiagnostic(diagnostic) {
   }
   return "other";
 }
-function diagnosticsGroup(group) {
+function diagnosticsGroup(group, result, privacy) {
   return `<section class="diagnostic-group" data-diagnostic-group="${escapeHtml(group.label)}">
   <div class="group-header">
     <span>${escapeHtml(group.label)}</span> \xB7 <span class="count" data-visible-count>${group.diagnostics.length} ${escapeHtml(plural(group.diagnostics.length, "diagnostic"))}</span>
   </div>
-  ${group.diagnostics.map((diagnostic, index) => diagnosticRow(diagnostic, group.label, index + 1)).join("")}
+  ${group.diagnostics.map((diagnostic, index) => diagnosticRow(diagnostic, group.label, index + 1, result, privacy)).join("")}
   </section>`;
 }
-function diagnosticRow(diagnostic, group, index) {
+function diagnosticRow(diagnostic, group, index, result, privacy) {
+  const path = diagnostic.path ? redactReportValue(diagnostic.path, result, privacy) : void 0;
+  const message = redactReportValue(diagnostic.message, result, privacy);
+  const source = privacy === "share" ? diagnostic.source ? "[redacted CMS source]" : void 0 : diagnostic.source;
   return `<div class="diag ${escapeHtml(diagnostic.severity)}" data-diagnostic data-group="${escapeHtml(group)}" data-severity="${escapeHtml(diagnostic.severity)}">
     <div class="col-num">${index}</div>
     <div class="sev"><span class="marker"></span>${escapeHtml(diagnostic.severity)}</div>
     <div class="msg">
-      ${diagnostic.path ? `<strong>${escapeHtml(diagnostic.path)}</strong> ` : ""}${escapeHtml(diagnostic.message)}
-      <span class="ctx"><span class="diag-code">${escapeHtml(diagnostic.code)}</span>${diagnostic.source ? ` <span aria-hidden="true">\xB7</span> <span>${escapeHtml(diagnostic.source)}</span>` : ""}</span>
+      ${path ? `<strong>${escapeHtml(path)}</strong> ` : ""}${escapeHtml(message)}
+      <span class="ctx"><span class="diag-code">${escapeHtml(diagnostic.code)}</span>${source ? ` <span aria-hidden="true">\xB7</span> <span>${escapeHtml(source)}</span>` : ""}</span>
     </div>
   </div>`;
 }
+function redactReportValue(value, result, privacy) {
+  if (privacy !== "share") {
+    return value;
+  }
+  let redacted = value;
+  const projectPaths = [
+    result.project.appDir,
+    result.project.pagesDir,
+    result.project.rootDir
+  ].filter((path) => Boolean(path)).sort((a, b) => b.length - a.length);
+  for (const projectPath of projectPaths) {
+    redacted = redacted.replaceAll(projectPath, "[redacted project path]");
+  }
+  return redacted.replaceAll(
+    /(?:\/Users|\/private\/var|\/var\/folders)\/[^\s<>"')]+/g,
+    "[redacted project path]"
+  ).replaceAll(/[A-Z]:\\Users\\[^\s<>"')]+/gi, "[redacted project path]");
+}
 function capitalize(value) {
   return value.charAt(0).toUpperCase() + value.slice(1);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cms-lab/reporter",
-  "version": "1.2.1",
+  "version": "1.2.3",
   "type": "module",
   "description": "HTML report rendering for cms-lab.",
   "license": "MIT",
@@ -35,7 +35,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@cms-lab/core": "1.2.1"
+    "@cms-lab/core": "1.2.3"
   },
   "author": "Afaq Rashid",
   "scripts": {