covgate 0.0.0-stage → 0.2.0

package/src/report/markdown.js

@@ -0,0 +1,343 @@
+import {
+  displayPercent,
+  escapeMarkdown,
+  formatDuration,
+  formatThreshold
+} from "../util.js";
+
+const METRICS = ["lines", "statements", "functions", "branches"];
+const METRIC_LABELS = {
+  lines: "行",
+  statements: "语句",
+  functions: "函数",
+  branches: "分支"
+};
+const BT = String.fromCharCode(96);
+const FENCE = BT.repeat(3);
+
+/**
+ * @param {unknown} value
+ */
+function code(value) {
+  return BT + String(value) + BT;
+}
+
+/**
+ * @param {string} value
+ */
+function fence(value) {
+  let marker = FENCE;
+  while (value.includes(marker)) marker += BT;
+  return [marker + "text", value, marker];
+}
+
+/**
+ * @param {any} scope
+ */
+function scopeTableRow(scope) {
+  const cells = [
+    escapeMarkdown(scope.label) + " (" + code(scope.name) + ")",
+    scope.profile
+  ];
+  for (const metric of METRICS) {
+    const value = scope.metrics[metric];
+    if (!value.applicable || value.percent === null) {
+      cells.push("N/A");
+      continue;
+    }
+    cells.push(
+      displayPercent(value.percent) +
+        " (" +
+        value.covered +
+        "/" +
+        value.total +
+        ") / " +
+        formatThreshold(value.threshold) +
+        "% " +
+        (value.passed ? "✓" : "✗")
+    );
+  }
+  cells.push(scope.passed ? "✓ 通过" : "✗ 未通过");
+  return "| " + cells.join(" | ") + " |";
+}
+
+/**
+ * @param {any} report
+ */
+export function renderMarkdownReport(report) {
+  const lines = [];
+  const statusText =
+    report.status === "pass"
+      ? "通过"
+      : report.status === "fail"
+        ? "未通过"
+        : "运行失败";
+  lines.push("# CovGate 覆盖率报告");
+  lines.push("");
+  lines.push("- 状态：**" + statusText + "**");
+  lines.push("- 生成时间：" + report.generatedAt);
+  lines.push(
+    "- 模式：" + (report.mode === "check" ? "只检查已有报告" : "执行测试并检查")
+  );
+  lines.push(
+    "- 配置：" +
+      code(report.config.path) +
+      "（sha256: " +
+      code(report.config.sha256 ?? "n/a") +
+      "）"
+  );
+  lines.push("- 用时：" + formatDuration(report.durationMs));
+  lines.push("");
+
+  for (const issue of report.issues) {
+    lines.push(
+      "> " + (issue.severity === "error" ? "✗" : "!") + " " + issue.message
+    );
+    if (issue.outputTail) {
+      lines.push("");
+      lines.push(...fence(issue.outputTail));
+    }
+  }
+  if (report.issues.length > 0) lines.push("");
+
+  lines.push("## 总览");
+  lines.push("");
+  lines.push("| Scope | 类型 | 行 | 语句 | 函数 | 分支 | 结果 |");
+  lines.push("| --- | --- | --- | --- | --- | --- | --- |");
+  for (const scope of report.scopes) lines.push(scopeTableRow(scope));
+  lines.push("");
+  lines.push(
+    "总计：scope " +
+      report.summary.scopes +
+      " 个，通过 " +
+      report.summary.passedScopes +
+      " 个；豁免 " +
+      report.summary.waivers +
+      " 条；配置排除 " +
+      report.summary.exclusions +
+      " 条；缺失源码报告 " +
+      report.summary.missingSources +
+      " 个。"
+  );
+  lines.push("");
+
+  for (const scope of report.scopes) {
+    lines.push("## " + escapeMarkdown(scope.label) + "（" + scope.name + "）");
+    lines.push("");
+    lines.push("- 结果：**" + (scope.passed ? "通过" : "未通过") + "**");
+    lines.push("- 覆盖率格式：" + code(scope.format));
+    lines.push(
+      "- 源码文件：" +
+        scope.expectedSourceCount +
+        "；报告文件：" +
+        scope.reportedFileCount
+    );
+    lines.push(
+      "- 豁免：" +
+        scope.waivers.length +
+        "；配置排除：" +
+        scope.exclusions.length
+    );
+
+    if (scope.missingSources.length > 0) {
+      lines.push("");
+      lines.push("### 缺失覆盖率报告");
+      lines.push("");
+      for (const file of scope.missingSources) lines.push("- " + code(file));
+    }
+
+    const issues = scope.issues.concat(
+      scope.warnings.map((warning) => ({ ...warning, severity: "warning" }))
+    );
+    if (issues.length > 0) {
+      lines.push("");
+      lines.push("### 问题");
+      lines.push("");
+      for (const issue of issues) {
+        const location = issue.file ? " " + code(issue.file) : "";
+        lines.push(
+          "- **" + issue.severity + "**" + location + ": " + issue.message
+        );
+      }
+      lines.push("");
+    }
+
+    if (scope.failingFiles.length > 0) {
+      lines.push("");
+      lines.push("### 未覆盖明细");
+      lines.push("");
+      for (const file of scope.failingFiles) {
+        lines.push("#### " + code(file.path));
+        lines.push("");
+        lines.push(
+          "- 行：" +
+            displayPercent(file.metrics.lines?.percent ?? null) +
+            " (" +
+            (file.metrics.lines?.covered ?? 0) +
+            "/" +
+            (file.metrics.lines?.total ?? 0) +
+            ")"
+        );
+        if (file.metrics.statements) {
+          lines.push(
+            "- 语句：" +
+              displayPercent(file.metrics.statements.percent) +
+              " (" +
+              file.metrics.statements.covered +
+              "/" +
+              file.metrics.statements.total +
+              ")"
+          );
+        }
+        lines.push(
+          "- 函数：" +
+            displayPercent(file.metrics.functions.percent) +
+            " (" +
+            file.metrics.functions.covered +
+            "/" +
+            file.metrics.functions.total +
+            ")"
+        );
+        lines.push(
+          "- 分支：" +
+            displayPercent(file.metrics.branches.percent) +
+            " (" +
+            file.metrics.branches.covered +
+            "/" +
+            file.metrics.branches.total +
+            ")"
+        );
+        if (file.uncovered.linesTotal > 0) {
+          lines.push(
+            "- 未覆盖行：" + code(file.uncovered.lines.join(", "))
+          );
+        }
+        if (file.uncovered.statementsTotal > 0) {
+          lines.push(
+            "- 未覆盖语句行：" +
+              code(file.uncovered.statements.map((unit) => unit.line).join(", "))
+          );
+        }
+        if (file.uncovered.functionsTotal > 0) {
+          lines.push(
+            "- 未覆盖函数：" +
+              file.uncovered.functions
+                .map((unit) => code(unit.name) + " @L" + unit.line)
+                .join(", ")
+          );
+        }
+        if (file.uncovered.branchesTotal > 0) {
+          lines.push(
+            "- 未覆盖分支：" +
+              file.uncovered.branches
+                .map((unit) => "L" + unit.line + "#" + unit.index)
+                .join(", ")
+          );
+        }
+        lines.push("");
+      }
+    }
+
+    if (scope.waivers.length > 0) {
+      lines.push("### 豁免审计");
+      lines.push("");
+      lines.push("| 文件 | 行 | 状态 | 原因 | owner | expires | ticket |");
+      lines.push("| --- | --- | --- | --- | --- | --- | --- |");
+      for (const waiver of scope.waivers) {
+        const range =
+          waiver.kind === "file"
+            ? "整个文件"
+            : waiver.startLine + "-" + waiver.endLine;
+        lines.push(
+          "| " +
+            code(escapeMarkdown(waiver.file)) +
+            " | " +
+            range +
+            " | " +
+            waiver.status +
+            " | " +
+            escapeMarkdown(waiver.reason) +
+            " | " +
+            escapeMarkdown(waiver.owner ?? "") +
+            " | " +
+            (waiver.expires ?? "") +
+            " | " +
+            escapeMarkdown(waiver.ticket ?? "") +
+            " |"
+        );
+      }
+      lines.push("");
+    }
+
+    if (scope.exclusions.length > 0) {
+      lines.push("### 配置排除");
+      lines.push("");
+      lines.push("| 模式 | 文件数 | 状态 | 原因 | owner | expires |");
+      lines.push("| --- | --- | --- | --- | --- | --- |");
+      for (const exclusion of scope.exclusions) {
+        lines.push(
+          "| " +
+            code(escapeMarkdown(exclusion.pattern)) +
+            " | " +
+            exclusion.fileCount +
+            " | " +
+            exclusion.status +
+            " | " +
+            escapeMarkdown(exclusion.reason) +
+            " | " +
+            escapeMarkdown(exclusion.owner ?? "") +
+            " | " +
+            (exclusion.expires ?? "") +
+            " |"
+        );
+      }
+      lines.push("");
+    }
+  }
+
+  if (report.commands.length > 0) {
+    lines.push("## 测试命令");
+    lines.push("");
+    lines.push("| Scope | 命令 | 退出码 | 用时 |");
+    lines.push("| --- | --- | --- | --- |");
+    for (const command of report.commands) {
+      lines.push(
+        "| " +
+          command.scope +
+          " | " +
+          code(escapeMarkdown(command.command)) +
+          " | " +
+          (command.exitCode ?? "null") +
+          " | " +
+          formatDuration(command.durationMs) +
+          " |"
+      );
+    }
+    lines.push("");
+  }
+
+  const targetLabels = report.scopes
+    .map(
+      (scope) =>
+        scope.label +
+        "：" +
+        METRICS.filter((metric) => scope.metrics[metric].applicable)
+          .map(
+            (metric) =>
+              METRIC_LABELS[metric] +
+              "≥" +
+              formatThreshold(scope.metrics[metric].threshold) +
+              "%"
+          )
+          .join("、")
+    )
+    .filter(Boolean);
+  if (targetLabels.length > 0) {
+    lines.push("## 门槛");
+    lines.push("");
+    for (const label of targetLabels) lines.push("- " + label);
+    lines.push("");
+  }
+
+  return lines.join("\n") + "\n";
+}

package/src/report/text.js

@@ -0,0 +1,267 @@
+import {
+  displayPercent,
+  formatDuration,
+  formatThreshold
+} from "../util.js";
+
+const METRIC_LABELS = {
+  lines: "行",
+  statements: "语句",
+  functions: "函数",
+  branches: "分支"
+};
+
+const ESC = String.fromCharCode(27);
+
+/**
+ * @param {any} report
+ * @param {{ color?: boolean }} [options]
+ */
+export function renderTextReport(report, options = {}) {
+  const useColor = options.color === true && !process.env.NO_COLOR;
+  const paint = (code, value) =>
+    useColor ? ESC + "[" + code + "m" + value + ESC + "[0m" : value;
+  const green = (value) => paint("32", value);
+  const red = (value) => paint("31", value);
+  const yellow = (value) => paint("33", value);
+  const dim = (value) => paint("2", value);
+  const bold = (value) => paint("1", value);
+  const symbols = {
+    pass: green("✓"),
+    fail: red("✗"),
+    error: red("✗"),
+    warning: yellow("!")
+  };
+  const lines = [];
+
+  lines.push(bold("CovGate · 覆盖率门禁 v" + report.tool.version));
+  lines.push(
+    dim(
+      "模式 " +
+        (report.mode === "check" ? "只检查已有报告" : "执行测试并检查") +
+        " · 配置 " +
+        report.config.path +
+        " · 用时 " +
+        formatDuration(report.durationMs)
+    )
+  );
+  lines.push("");
+
+  for (const issue of report.issues) {
+    lines.push((symbols[issue.severity] ?? "?") + " " + issue.message);
+    if (issue.outputTail) lines.push(dim(issue.outputTail));
+  }
+  if (report.issues.length > 0) lines.push("");
+
+  for (const scope of report.scopes) {
+    const symbol = scope.passed ? symbols.pass : symbols.fail;
+    lines.push(
+      symbol +
+        " " +
+        bold(scope.label) +
+        " " +
+        dim("[" + scope.name + "/" + scope.profile + "]") +
+        " " +
+        (scope.passed ? green("通过") : red("未通过"))
+    );
+
+    const metricParts = [];
+    for (const metric of ["lines", "statements", "functions", "branches"]) {
+      const value = scope.metrics[metric];
+      if (!value.applicable || value.percent === null) {
+        metricParts.push(METRIC_LABELS[metric] + " N/A");
+        continue;
+      }
+      const state = value.passed ? "" : red(" ✗");
+      metricParts.push(
+        METRIC_LABELS[metric] +
+          " " +
+          displayPercent(value.percent) +
+          " " +
+          dim(
+            "(" +
+              value.covered +
+              "/" +
+              value.total +
+              ", 目标 " +
+              formatThreshold(value.threshold) +
+              "%)"
+          ) +
+          state
+      );
+    }
+    lines.push("  " + metricParts.join("  ·  "));
+    lines.push(
+      dim(
+        "  源码 " +
+          scope.expectedSourceCount +
+          " 个 · 报告 " +
+          scope.reportedFileCount +
+          " 个 · 豁免 " +
+          scope.waivers.length +
+          " 条 · 排除 " +
+          scope.exclusions.length +
+          " 条"
+      )
+    );
+
+    const errorIssues = scope.issues.filter((issue) => issue.severity === "error");
+    const warningIssues = scope.warnings.concat(
+      scope.issues.filter((issue) => issue.severity === "warning")
+    );
+    const shownIssues = errorIssues.concat(warningIssues).slice(0, 8);
+    if (shownIssues.length > 0) {
+      lines.push("");
+      for (const issue of shownIssues) {
+        const prefix = issue.severity === "error" ? red("  ✗") : yellow("  !");
+        const location = issue.file
+          ? " " + issue.file + (issue.line ? ":" + issue.line : "")
+          : "";
+        lines.push(prefix + location + " " + issue.message);
+      }
+      const rest = errorIssues.length + warningIssues.length - shownIssues.length;
+      if (rest > 0) lines.push(dim("    … 还有 " + rest + " 条问题，见报告文件"));
+    }
+
+    if (!scope.passed && scope.failingFiles.length > 0) {
+      lines.push("");
+      lines.push("  未覆盖明细：");
+      for (const file of scope.failingFiles.slice(0, 12)) {
+        const percent = file.metrics.lines?.percent;
+        lines.push(
+          "    " +
+            file.path +
+            (percent === null || percent === undefined
+              ? ""
+              : dim(" (行 " + displayPercent(percent) + ")"))
+        );
+        if (file.uncovered.linesTotal > 0) {
+          const values = file.uncovered.lines.slice(0, 20).join(", ");
+          const more =
+            file.uncovered.linesTotal > 20
+              ? " … + " + (file.uncovered.linesTotal - 20)
+              : "";
+          lines.push("      行: " + values + more);
+        }
+        if ((file.uncovered.statementsTotal ?? 0) > 0) {
+          const values = file.uncovered.statements
+            .map((unit) => "L" + unit.line)
+            .slice(0, 15)
+            .join(", ");
+          const more =
+            (file.uncovered.statementsTotal ?? 0) > 15
+              ? " … + " + ((file.uncovered.statementsTotal ?? 0) - 15)
+              : "";
+          lines.push("      语句: " + values + more);
+        }
+        if (file.uncovered.functionsTotal > 0) {
+          const values = file.uncovered.functions
+            .slice(0, 10)
+            .map((unit) => unit.name + "@L" + unit.line)
+            .join(", ");
+          const more =
+            file.uncovered.functionsTotal > 10
+              ? " … + " + (file.uncovered.functionsTotal - 10)
+              : "";
+          lines.push("      函数: " + values + more);
+        }
+        if (file.uncovered.branchesTotal > 0) {
+          const values = file.uncovered.branches
+            .slice(0, 10)
+            .map((unit) => "L" + unit.line + "#" + unit.index)
+            .join(", ");
+          const more =
+            file.uncovered.branchesTotal > 10
+              ? " … + " + (file.uncovered.branchesTotal - 10)
+              : "";
+          lines.push("      分支: " + values + more);
+        }
+      }
+      if (scope.failingFiles.length > 12) {
+        lines.push(
+          dim("    … 还有 " + (scope.failingFiles.length - 12) + " 个文件，见报告文件")
+        );
+      }
+    }
+
+    if (scope.exclusions.length > 0) {
+      lines.push("");
+      lines.push("  配置排除（均需人工复核）：");
+      for (const exclusion of scope.exclusions.slice(0, 10)) {
+        const status =
+          exclusion.status === "applied"
+            ? ""
+            : red(" [" + exclusion.status + "]");
+        lines.push(
+          "    " +
+            exclusion.pattern +
+            " (" +
+            exclusion.fileCount +
+            " 个文件) — " +
+            exclusion.reason +
+            status
+        );
+      }
+      if (scope.exclusions.length > 10) {
+        lines.push(
+          dim("    … 还有 " + (scope.exclusions.length - 10) + " 条，见报告文件")
+        );
+      }
+    }
+
+    if (scope.waivers.length > 0) {
+      lines.push("");
+      lines.push("  豁免（均需人工复核）：");
+      for (const waiver of scope.waivers.slice(0, 10)) {
+        const location =
+          waiver.kind === "file"
+            ? waiver.file
+            : waiver.file +
+              ":" +
+              waiver.startLine +
+              (waiver.endLine !== waiver.startLine
+                ? "-" + waiver.endLine
+                : "");
+        const status =
+          waiver.status === "applied" ? "" : red(" [" + waiver.status + "]");
+        const meta = [
+          waiver.owner ? "owner=" + waiver.owner : null,
+          waiver.expires ? "expires=" + waiver.expires : null
+        ]
+          .filter(Boolean)
+          .join(", ");
+        lines.push(
+          "    " +
+            location +
+            " — " +
+            waiver.reason +
+            (meta ? dim(" (" + meta + ")") : "") +
+            status
+        );
+      }
+      if (scope.waivers.length > 10) {
+        lines.push(dim("    … 还有 " + (scope.waivers.length - 10) + " 条，见报告文件"));
+      }
+    }
+    lines.push("");
+  }
+
+  const statusColor = report.status === "pass" ? green : red;
+  const statusText =
+    report.status === "pass"
+      ? "通过"
+      : report.status === "fail"
+        ? "未通过"
+        : "运行失败";
+  lines.push(bold("结果") + ": " + statusColor(statusText));
+  if (report.artifacts.json) {
+    lines.push(dim("JSON 报告: " + report.artifacts.json));
+  }
+  if (report.artifacts.markdown) {
+    lines.push(dim("Markdown 报告: " + report.artifacts.markdown));
+  }
+  if (report.status !== "pass" && report.summary.failedScopes.length > 0) {
+    lines.push(dim("失败 scope: " + report.summary.failedScopes.join(", ")));
+  }
+  return lines.join("\n") + "\n";
+}