npm - @schemasentry/cli - Versions diffs - 0.2.0 → 0.3.2 - Mend

@schemasentry/cli 0.2.0 → 0.3.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (3) hide show

package/README.md ADDED Viewed

@@ -0,0 +1,70 @@
+# @schemasentry/cli
+CLI for Schema Sentry validation and reporting.
+## Install
+```bash
+pnpm add -D @schemasentry/cli
+npm install -D @schemasentry/cli
+```
+## Commands
+### `init`
+Generate starter manifest and data files:
+```bash
+pnpm schemasentry init
+```
+With route scanning:
+```bash
+pnpm schemasentry init --scan
+```
+### `validate`
+Check schema coverage and validation:
+```bash
+pnpm schemasentry validate --manifest ./schema-sentry.manifest.json --data ./schema-sentry.data.json
+```
+With GitHub annotations:
+```bash
+pnpm schemasentry validate --annotations github
+```
+### `audit`
+Analyze site-wide schema health:
+```bash
+pnpm schemasentry audit --data ./schema-sentry.data.json --manifest ./schema-sentry.manifest.json
+```
+With HTML report:
+```bash
+pnpm schemasentry audit \
+  --data ./schema-sentry.data.json \
+  --format html \
+  --output ./report.html
+```
+## Options
+| Option | Description |
+|--------|-------------|
+| `--format json\|html` | Output format |
+| `--annotations none\|github` | CI annotations |
+| `-o, --output <path>` | Write output to file |
+| `--recommended / --no-recommended` | Enable recommended field checks |
+## Documentation
+See [Schema Sentry Docs](https://github.com/arindamdawn/schema-sentry#readme)

package/dist/index.js CHANGED Viewed

@@ -2,7 +2,7 @@
 // src/index.ts
 import { Command } from "commander";
-import { readFile } from "fs/promises";
+import { mkdir, readFile, writeFile } from "fs/promises";
 import { readFileSync } from "fs";
 import path4 from "path";
 import { stableStringify as stableStringify2 } from "@schemasentry/core";
@@ -537,6 +537,123 @@ var walkDir = async (dirPath) => {
   return files;
 };
+// src/html.ts
+var escapeHtml = (value) => String(value).replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/"/g, "&quot;").replace(/'/g, "&#39;");
+var renderRouteIssues = (route) => {
+  if (route.issues.length === 0) {
+    return '<p class="muted">No issues.</p>';
+  }
+  const items = route.issues.map((issue) => {
+    const severityClass = issue.severity === "error" ? "sev-error" : "sev-warn";
+    return `<li class="${severityClass}">
+        <span class="sev">${escapeHtml(issue.severity.toUpperCase())}</span>
+        <code>${escapeHtml(issue.ruleId)}</code>
+        <span>${escapeHtml(issue.message)}</span>
+        <small>${escapeHtml(issue.path)}</small>
+      </li>`;
+  }).join("");
+  return `<ul class="issues">${items}</ul>`;
+};
+var renderRoute = (route) => {
+  const statusClass = route.ok ? "ok" : "fail";
+  const expected = route.expectedTypes.length ? route.expectedTypes.join(", ") : "(none)";
+  const found = route.foundTypes.length ? route.foundTypes.join(", ") : "(none)";
+  return `<section class="route">
+    <header>
+      <h3>${escapeHtml(route.route)}</h3>
+      <span class="badge ${statusClass}">${route.ok ? "OK" : "FAIL"}</span>
+    </header>
+    <p><strong>Score:</strong> ${route.score}</p>
+    <p><strong>Expected types:</strong> ${escapeHtml(expected)}</p>
+    <p><strong>Found types:</strong> ${escapeHtml(found)}</p>
+    ${renderRouteIssues(route)}
+  </section>`;
+};
+var renderCoverage = (report) => {
+  if (!report.summary.coverage) {
+    return "<li><strong>Coverage:</strong> not enabled</li>";
+  }
+  const coverage = report.summary.coverage;
+  return `<li><strong>Coverage:</strong> missing_routes=${coverage.missingRoutes} missing_types=${coverage.missingTypes} unlisted_routes=${coverage.unlistedRoutes}</li>`;
+};
+var renderHtmlReport = (report, options) => {
+  const title = escapeHtml(options.title);
+  const generatedAt = escapeHtml(
+    (options.generatedAt ?? /* @__PURE__ */ new Date()).toISOString()
+  );
+  const routes = report.routes.map(renderRoute).join("");
+  return `<!doctype html>
+<html lang="en">
+<head>
+  <meta charset="utf-8" />
+  <meta name="viewport" content="width=device-width, initial-scale=1" />
+  <title>${title}</title>
+  <style>
+    :root { color-scheme: light dark; }
+    body { font-family: ui-sans-serif, system-ui, -apple-system, Segoe UI, sans-serif; margin: 24px; line-height: 1.45; }
+    h1, h2, h3 { margin: 0 0 8px; }
+    .muted { color: #666; }
+    .summary, .routes { margin-top: 20px; }
+    .route { border: 1px solid #ddd; border-radius: 8px; padding: 12px; margin: 12px 0; }
+    .route header { display: flex; align-items: center; justify-content: space-between; gap: 8px; }
+    .badge { padding: 2px 8px; border-radius: 999px; font-size: 12px; font-weight: 600; }
+    .badge.ok { background: #dcfce7; color: #166534; }
+    .badge.fail { background: #fee2e2; color: #991b1b; }
+    .issues { margin: 10px 0 0; padding-left: 16px; }
+    .issues li { margin: 8px 0; display: grid; gap: 2px; }
+    .sev { font-weight: 700; }
+    .sev-error .sev { color: #991b1b; }
+    .sev-warn .sev { color: #92400e; }
+    code { background: #f5f5f5; padding: 1px 5px; border-radius: 4px; }
+  </style>
+</head>
+<body>
+  <h1>${title}</h1>
+  <p class="muted">Generated at ${generatedAt}</p>
+  <section class="summary">
+    <h2>Summary</h2>
+    <ul>
+      <li><strong>OK:</strong> ${report.ok}</li>
+      <li><strong>Routes:</strong> ${report.summary.routes}</li>
+      <li><strong>Errors:</strong> ${report.summary.errors}</li>
+      <li><strong>Warnings:</strong> ${report.summary.warnings}</li>
+      <li><strong>Score:</strong> ${report.summary.score}</li>
+      ${renderCoverage(report)}
+    </ul>
+  </section>
+  <section class="routes">
+    <h2>Routes</h2>
+    ${routes}
+  </section>
+</body>
+</html>`;
+};
+// src/annotations.ts
+var escapeCommandValue = (value) => value.replace(/%/g, "%25").replace(/\r/g, "%0D").replace(/\n/g, "%0A");
+var escapeCommandProperty = (value) => escapeCommandValue(value).replace(/:/g, "%3A").replace(/,/g, "%2C");
+var formatIssueMessage = (route, issue) => `[${route}] ${issue.ruleId}: ${issue.message} (${issue.path})`;
+var buildGitHubAnnotationLines = (report, commandLabel) => {
+  const title = escapeCommandProperty(`Schema Sentry ${commandLabel}`);
+  const lines = [];
+  for (const route of report.routes) {
+    for (const issue of route.issues) {
+      const level = issue.severity === "error" ? "error" : "warning";
+      const message = escapeCommandValue(formatIssueMessage(route.route, issue));
+      lines.push(`::${level} title=${title}::${message}`);
+    }
+  }
+  return lines;
+};
+var emitGitHubAnnotations = (report, commandLabel) => {
+  const lines = buildGitHubAnnotationLines(report, commandLabel);
+  for (const line of lines) {
+    console.error(line);
+  }
+};
 // src/index.ts
 import { createInterface } from "readline/promises";
 import { stdin as input, stdout as output } from "process";
@@ -550,8 +667,10 @@ program.command("validate").description("Validate schema coverage and rules").op
   "-d, --data <path>",
   "Path to schema data JSON",
   "schema-sentry.data.json"
-).option("-c, --config <path>", "Path to config JSON").option("--recommended", "Enable recommended field checks").option("--no-recommended", "Disable recommended field checks").action(async (options) => {
+).option("-c, --config <path>", "Path to config JSON").option("--format <format>", "Report format (json|html)", "json").option("--annotations <provider>", "Emit CI annotations (none|github)", "none").option("-o, --output <path>", "Write report output to file").option("--recommended", "Enable recommended field checks").option("--no-recommended", "Disable recommended field checks").action(async (options) => {
   const start = Date.now();
+  const format = resolveOutputFormat(options.format);
+  const annotationsMode = resolveAnnotationsMode(options.annotations);
   const recommended = await resolveRecommendedOption(options.config);
   const manifestPath = path4.resolve(process.cwd(), options.manifest);
   const dataPath = path4.resolve(process.cwd(), options.data);
@@ -622,7 +741,13 @@ program.command("validate").description("Validate schema coverage and rules").op
     return;
   }
   const report = buildReport(manifest, data, { recommended });
-  console.log(formatReportOutput(report));
+  await emitReport({
+    report,
+    format,
+    outputPath: options.output,
+    title: "Schema Sentry Validate Report"
+  });
+  emitAnnotations(report, annotationsMode, "validate");
   printValidateSummary(report, Date.now() - start);
   process.exit(report.ok ? 0 : 1);
 });
@@ -664,8 +789,10 @@ program.command("audit").description("Analyze schema health and report issues").
   "-d, --data <path>",
   "Path to schema data JSON",
   "schema-sentry.data.json"
-).option("-m, --manifest <path>", "Path to manifest JSON (optional)").option("--scan", "Scan the filesystem for routes").option("--root <path>", "Project root for scanning", ".").option("-c, --config <path>", "Path to config JSON").option("--recommended", "Enable recommended field checks").option("--no-recommended", "Disable recommended field checks").action(async (options) => {
+).option("-m, --manifest <path>", "Path to manifest JSON (optional)").option("--scan", "Scan the filesystem for routes").option("--root <path>", "Project root for scanning", ".").option("-c, --config <path>", "Path to config JSON").option("--format <format>", "Report format (json|html)", "json").option("--annotations <provider>", "Emit CI annotations (none|github)", "none").option("-o, --output <path>", "Write report output to file").option("--recommended", "Enable recommended field checks").option("--no-recommended", "Disable recommended field checks").action(async (options) => {
   const start = Date.now();
+  const format = resolveOutputFormat(options.format);
+  const annotationsMode = resolveAnnotationsMode(options.annotations);
   const recommended = await resolveRecommendedOption(options.config);
   const dataPath = path4.resolve(process.cwd(), options.data);
   let dataRaw;
@@ -746,7 +873,13 @@ program.command("audit").description("Analyze schema health and report issues").
     manifest,
     requiredRoutes: requiredRoutes.length > 0 ? requiredRoutes : void 0
   });
-  console.log(formatReportOutput(report));
+  await emitReport({
+    report,
+    format,
+    outputPath: options.output,
+    title: "Schema Sentry Audit Report"
+  });
+  emitAnnotations(report, annotationsMode, "audit");
   printAuditSummary(report, Boolean(manifest), Date.now() - start);
   process.exit(report.ok ? 0 : 1);
 });
@@ -780,9 +913,65 @@ function isSchemaData(value) {
   }
   return true;
 }
-function formatReportOutput(report) {
+function resolveOutputFormat(value) {
+  const format = (value ?? "json").trim().toLowerCase();
+  if (format === "json" || format === "html") {
+    return format;
+  }
+  printCliError(
+    "output.invalid_format",
+    `Unsupported report format '${value ?? ""}'`,
+    "Use --format json or --format html."
+  );
+  process.exit(1);
+  return "json";
+}
+function resolveAnnotationsMode(value) {
+  const mode = (value ?? "none").trim().toLowerCase();
+  if (mode === "none" || mode === "github") {
+    return mode;
+  }
+  printCliError(
+    "annotations.invalid_provider",
+    `Unsupported annotations provider '${value ?? ""}'`,
+    "Use --annotations none or --annotations github."
+  );
+  process.exit(1);
+  return "none";
+}
+function formatReportOutput(report, format, title) {
+  if (format === "html") {
+    return renderHtmlReport(report, { title });
+  }
   return stableStringify2(report);
 }
+async function emitReport(options) {
+  const { report, format, outputPath, title } = options;
+  const content = formatReportOutput(report, format, title);
+  if (!outputPath) {
+    console.log(content);
+    return;
+  }
+  const resolvedPath = path4.resolve(process.cwd(), outputPath);
+  try {
+    await mkdir(path4.dirname(resolvedPath), { recursive: true });
+    await writeFile(resolvedPath, content, "utf8");
+    console.error(`Report written to ${resolvedPath}`);
+  } catch (error) {
+    const reason = error instanceof Error && error.message.length > 0 ? error.message : "Unknown file system error";
+    printCliError(
+      "output.write_failed",
+      `Could not write report to ${resolvedPath}: ${reason}`
+    );
+    process.exit(1);
+  }
+}
+function emitAnnotations(report, mode, commandLabel) {
+  if (mode !== "github") {
+    return;
+  }
+  emitGitHubAnnotations(report, commandLabel);
+}
 function printCliError(code, message, suggestion) {
   console.error(
     stableStringify2({

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@schemasentry/cli",
-  "version": "0.2.0",
+  "version": "0.3.2",
   "description": "CLI for Schema Sentry validation and reporting.",
   "license": "MIT",
   "type": "module",
@@ -33,10 +33,11 @@
   },
   "dependencies": {
     "commander": "^12.0.0",
-    "@schemasentry/core": "0.2.0"
+    "@schemasentry/core": "0.3.2"
   },
   "scripts": {
     "build": "tsup src/index.ts --format esm --dts --clean --tsconfig tsconfig.build.json",
+    "benchmark:200": "node ./scripts/benchmark-200-routes.mjs",
     "lint": "echo \"lint not configured\" && exit 0",
     "test": "vitest run"
   }