@spaceflow/review 0.29.1

package/src/review-report/formatters/terminal.formatter.ts

@@ -0,0 +1,130 @@
+import { extname } from "path";
+import {
+  FileSummary,
+  ReviewIssue,
+  ReviewResult,
+  ReviewStats,
+  Severity,
+} from "../../review-spec/types";
+import { ReportOptions, ReviewReportFormatter } from "../types";
+
+const SEVERITY_COLORS: Record<Severity, string> = {
+  off: "\x1b[90m",
+  warn: "\x1b[33m",
+  error: "\x1b[31m",
+};
+
+const RESET = "\x1b[0m";
+const BOLD = "\x1b[1m";
+const DIM = "\x1b[2m";
+const CYAN = "\x1b[36m";
+const GREEN = "\x1b[32m";
+const YELLOW = "\x1b[33m";
+const RED = "\x1b[31m";
+
+export class TerminalFormatter implements ReviewReportFormatter {
+  private formatFileSummaries(summaries: FileSummary[], issues: ReviewIssue[]): string {
+    if (summaries.length === 0) {
+      return "没有需要审查的文件";
+    }
+
+    const issuesByFile = new Map<string, { resolved: number; unresolved: number }>();
+    for (const issue of issues) {
+      const stats = issuesByFile.get(issue.file) || { resolved: 0, unresolved: 0 };
+      if (issue.fixed) {
+        stats.resolved++;
+      } else {
+        stats.unresolved++;
+      }
+      issuesByFile.set(issue.file, stats);
+    }
+
+    const lines: string[] = [];
+    for (const fileSummary of summaries) {
+      const stats = issuesByFile.get(fileSummary.file) || { resolved: 0, unresolved: 0 };
+      const resolvedText = stats.resolved > 0 ? `${GREEN}✅ ${stats.resolved} 已解决${RESET}` : "";
+      const unresolvedText =
+        stats.unresolved > 0 ? `${YELLOW}❌ ${stats.unresolved} 未解决${RESET}` : "";
+      const statsText = [resolvedText, unresolvedText].filter(Boolean).join(" / ");
+
+      if (statsText) {
+        lines.push(`${BOLD}${fileSummary.file}${RESET} (${statsText}): ${fileSummary.summary}`);
+      } else {
+        lines.push(`${BOLD}${fileSummary.file}${RESET}: ${fileSummary.summary}`);
+      }
+    }
+
+    return lines.join("\n");
+  }
+
+  format(result: ReviewResult, _options: ReportOptions = {}): string {
+    const lines: string[] = [];
+
+    lines.push("");
+    lines.push(`${BOLD}${CYAN}═══════════════════════════════════════════════════════════${RESET}`);
+    lines.push(
+      `${BOLD}${CYAN}                    🤖 AI 代码审查报告                      ${RESET}`,
+    );
+    lines.push(`${BOLD}${CYAN}═══════════════════════════════════════════════════════════${RESET}`);
+    lines.push("");
+
+    const issues = result.issues;
+
+    if (issues.length === 0) {
+      lines.push(`${GREEN}✅ 未发现问题${RESET}`);
+      lines.push("");
+      lines.push(this.formatFileSummaries(result.summary, []));
+    } else {
+      lines.push(`${YELLOW}⚠️  发现 ${issues.length} 个问题${RESET}`);
+      lines.push("");
+
+      for (let i = 0; i < issues.length; i++) {
+        const issue = issues[i];
+        const color = SEVERITY_COLORS[issue.severity] || SEVERITY_COLORS.error;
+        const severityLabel = issue.severity.toUpperCase();
+
+        lines.push(`${DIM}───────────────────────────────────────────────────────────${RESET}`);
+        lines.push(`${BOLD}[${i + 1}/${issues.length}]${RESET} ${color}${severityLabel}${RESET}`);
+        lines.push(`${BOLD}📍 位置:${RESET} ${issue.file}:${issue.line}`);
+        lines.push(`${BOLD}📋 规则:${RESET} ${issue.ruleId} ${DIM}(${issue.specFile})${RESET}`);
+        lines.push(`${BOLD}❓ 问题:${RESET} ${issue.reason}`);
+
+        if (issue.commit) {
+          lines.push(`${BOLD}📝 Commit:${RESET} ${issue.commit}`);
+        }
+
+        if (issue.suggestion) {
+          const ext = extname(issue.file).slice(1) || "";
+          lines.push(`${BOLD}💡 建议:${RESET}`);
+          lines.push(`${DIM}--- ${ext} ---${RESET}`);
+          lines.push(issue.suggestion);
+          lines.push(`${DIM}------------${RESET}`);
+        }
+
+        lines.push("");
+      }
+
+      lines.push(`${DIM}───────────────────────────────────────────────────────────${RESET}`);
+      lines.push("");
+      lines.push(`${BOLD}📝 总结${RESET}`);
+      lines.push(this.formatFileSummaries(result.summary, issues));
+    }
+
+    lines.push("");
+    lines.push(`${BOLD}${CYAN}═══════════════════════════════════════════════════════════${RESET}`);
+    lines.push("");
+
+    return lines.join("\n");
+  }
+
+  formatStats(stats: ReviewStats, prNumber?: number): string {
+    const title = prNumber ? `PR #${prNumber} Review 状态统计` : "Review 状态统计";
+    const lines = [`\n${BOLD}${CYAN}📊 ${title}:${RESET}`];
+    lines.push(`   总问题数: ${stats.total}`);
+    lines.push(`   ${GREEN}✅ 已修复: ${stats.fixed}${RESET}`);
+    lines.push(`   ${RED}❌ 无效: ${stats.invalid}${RESET}`);
+    lines.push(`   ${YELLOW}⚠️  待处理: ${stats.pending}${RESET}`);
+    lines.push(`   修复率: ${stats.fixRate}%`);
+    return lines.join("\n");
+  }
+}

package/src/review-report/index.ts

@@ -0,0 +1,4 @@
+export * from "./types";
+export * from "./formatters";
+export * from "./review-report.service";
+export * from "./review-report.module";

package/src/review-report/review-report.module.ts

@@ -0,0 +1,8 @@
+import { Module } from "@nestjs/common";
+import { ReviewReportService } from "./review-report.service";
+
+@Module({
+  providers: [ReviewReportService],
+  exports: [ReviewReportService],
+})
+export class ReviewReportModule {}

package/src/review-report/review-report.service.ts

@@ -0,0 +1,58 @@
+import { Injectable } from "@nestjs/common";
+import { ReviewResult, ReviewStats } from "../review-spec/types";
+import { JsonFormatter, MarkdownFormatter, TerminalFormatter } from "./formatters";
+import { ParsedReport, ReportFormat, ReportOptions, ReviewReportFormatter } from "./types";
+
+@Injectable()
+export class ReviewReportService {
+  private readonly markdownFormatter = new MarkdownFormatter();
+  private readonly terminalFormatter = new TerminalFormatter();
+
+  private formatters: Map<ReportFormat, ReviewReportFormatter> = new Map([
+    ["markdown", this.markdownFormatter],
+    ["json", new JsonFormatter()],
+    ["terminal", this.terminalFormatter],
+  ]);
+
+  format(result: ReviewResult, format: ReportFormat = "markdown", options?: ReportOptions): string {
+    const formatter = this.formatters.get(format);
+    if (!formatter) {
+      throw new Error(`Unsupported format: ${format}`);
+    }
+    return formatter.format(result, options);
+  }
+
+  formatMarkdown(result: ReviewResult, options?: ReportOptions): string {
+    return this.format(result, "markdown", options);
+  }
+
+  formatJson(result: ReviewResult, options?: ReportOptions): string {
+    return this.format(result, "json", options);
+  }
+
+  formatTerminal(result: ReviewResult, options?: ReportOptions): string {
+    return this.format(result, "terminal", options);
+  }
+
+  parseMarkdown(content: string): ParsedReport | null {
+    return this.markdownFormatter.parse(content);
+  }
+
+  registerFormatter(format: ReportFormat, formatter: ReviewReportFormatter): void {
+    this.formatters.set(format, formatter);
+  }
+
+  /**
+   * 格式化统计信息为终端输出
+   */
+  formatStatsTerminal(stats: ReviewStats, prNumber?: number): string {
+    return this.terminalFormatter.formatStats(stats, prNumber);
+  }
+
+  /**
+   * 格式化统计信息为 Markdown
+   */
+  formatStatsMarkdown(stats: ReviewStats, prNumber?: number): string {
+    return this.markdownFormatter.formatStats(stats, prNumber);
+  }
+}

package/src/review-report/types.ts

@@ -0,0 +1,26 @@
+import { ReviewIssue, ReviewResult, ReviewStats } from "../review-spec/types";
+
+export type ReportFormat = "markdown" | "json" | "terminal";
+
+export interface ReportOptions {
+  prNumber?: number;
+  includeReanalysisCheckbox?: boolean;
+  includeJsonData?: boolean;
+  reviewCommentMarker?: string;
+}
+
+export interface ParsedReport {
+  /** 完整的 ReviewResult 数据 */
+  result: ReviewResult;
+  /** 是否请求重新分析 */
+  hasReanalysisRequest?: boolean;
+}
+
+export interface ReviewReportFormatter {
+  format(result: ReviewResult, options?: ReportOptions): string;
+  formatStats?(stats: ReviewStats, prNumber?: number): string;
+}
+
+export interface ReviewReportParser {
+  parse(content: string): ParsedReport | null;
+}

package/src/review-spec/index.ts

@@ -0,0 +1,3 @@
+export * from "./types";
+export * from "./review-spec.service";
+export * from "./review-spec.module";

package/src/review-spec/review-spec.module.ts

@@ -0,0 +1,10 @@
+import { Module } from "@nestjs/common";
+import { GitProviderModule } from "@spaceflow/core";
+import { ReviewSpecService } from "./review-spec.service";
+
+@Module({
+  imports: [GitProviderModule.forFeature()],
+  providers: [ReviewSpecService],
+  exports: [ReviewSpecService],
+})
+export class ReviewSpecModule {}