@spaceflow/review 0.83.0 → 2.0.0

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

@@ -35,7 +35,7 @@ describe("ReviewSpecService", () => {
 - 排除配置文件
 - 排除测试文件
 
-### Good
+#### Good: 合理的常量命名
 \`\`\`js
 const MAX_COUNT = 100;
 \`\`\``;
@@ -59,10 +59,13 @@ const MAX_COUNT = 100;
       expect(specs[0].rules[1].description).toContain("排除配置文件");
       expect(specs[0].rules[1].description).toContain("排除测试文件");
       expect(specs[0].rules[1].examples).toHaveLength(1);
-      expect(specs[0].rules[1].examples[0]).toEqual({
-        lang: "js",
-        code: "const MAX_COUNT = 100;",
+      expect(specs[0].rules[1].examples[0].title).toBe("");
+      expect(specs[0].rules[1].examples[0].description).toBe("");
+      expect(specs[0].rules[1].examples[0].content).toHaveLength(1);
+      expect(specs[0].rules[1].examples[0].content[0]).toEqual({
+        title: "合理的常量命名",
         type: "good",
+        description: "const MAX_COUNT = 100;",
       });
 
       expect(specs[1].filename).toBe("vue.file-name.md");
@@ -309,7 +312,7 @@ const MAX_COUNT = 100;
 
 > - severity \`warn\`
 
-### Good
+#### Good: 合理的常量命名
 \`\`\`js
 const MAX_COUNT = 100;
 \`\`\``;
@@ -566,6 +569,92 @@ const MAX_COUNT = 100;
 
       expect(result).toHaveLength(2);
     });
+
+    it("should filter issues by spec includes with added| prefix when fileStatusMap provided", () => {
+      const specs = [
+        {
+          filename: "js.models.md",
+          extensions: ["js"],
+          type: "models",
+          content: "",
+          overrides: [],
+          severity: "error" as const,
+          includes: ["added|*.model.js"],
+          rules: [
+            { id: "Js.Models", title: "Models", description: "", examples: [], overrides: [] },
+          ],
+        },
+      ];
+
+      const issues = [
+        { file: "user/models/user.model.js", ruleId: "Js.Models.Rule1", reason: "test" },
+        { file: "user/models/product.model.js", ruleId: "Js.Models.Rule2", reason: "test" },
+      ];
+
+      // added 文件保留，modified 文件被 added| 前缀过滤
+      const changedFiles = ChangedFileCollection.from([
+        { filename: "user/models/user.model.js", status: "added" },
+        { filename: "user/models/product.model.js", status: "modified" },
+      ]);
+      const result = service.filterIssuesByIncludes(issues, specs, changedFiles);
+      expect(result).toHaveLength(1);
+      expect(result[0].file).toBe("user/models/user.model.js");
+    });
+
+    it("should fall back to pure glob matching when fileStatusMap not provided", () => {
+      const specs = [
+        {
+          filename: "js.models.md",
+          extensions: ["js"],
+          type: "models",
+          content: "",
+          overrides: [],
+          severity: "error" as const,
+          includes: ["added|*.model.js"],
+          rules: [
+            { id: "Js.Models", title: "Models", description: "", examples: [], overrides: [] },
+          ],
+        },
+      ];
+
+      const issues = [
+        { file: "user/models/user.model.js", ruleId: "Js.Models.Rule1", reason: "test" },
+        { file: "src/app.js", ruleId: "Js.Models.Rule2", reason: "test" },
+      ];
+
+      // 无 status map 时，added| 前缀降级为纯 glob 匹配
+      const result = service.filterIssuesByIncludes(issues, specs);
+      expect(result).toHaveLength(1);
+      expect(result[0].file).toBe("user/models/user.model.js");
+    });
+
+    it("should filter issues by spec includes with modified| prefix", () => {
+      const specs = [
+        {
+          filename: "js.nest.md",
+          extensions: ["ts"],
+          type: "nest",
+          content: "",
+          overrides: [],
+          severity: "error" as const,
+          includes: ["modified|*.controller.ts"],
+          rules: [{ id: "JsTs.Nest", title: "Nest", description: "", examples: [], overrides: [] }],
+        },
+      ];
+
+      const issues = [
+        { file: "user.controller.ts", ruleId: "JsTs.Nest.Rule1", reason: "test" },
+        { file: "app.controller.ts", ruleId: "JsTs.Nest.Rule2", reason: "test" },
+      ];
+
+      const changedFiles = ChangedFileCollection.from([
+        { filename: "user.controller.ts", status: "modified" },
+        { filename: "app.controller.ts", status: "added" },
+      ]);
+      const result = service.filterIssuesByIncludes(issues, specs, changedFiles);
+      expect(result).toHaveLength(1);
+      expect(result[0].file).toBe("user.controller.ts");
+    });
   });
 
   describe("matchRuleId", () => {
@@ -714,7 +803,13 @@ const MAX_COUNT = 100;
               id: "JsTs.Base.Rule1",
               title: "Rule1",
               description: "rule desc",
-              examples: [{ lang: "ts", code: "const x = 1;", type: "good" as const }],
+              examples: [
+                {
+                  title: "",
+                  description: "",
+                  content: [{ title: "", type: "good" as const, description: "const x = 1;" }],
+                },
+              ],
               overrides: [],
             },
           ],
@@ -723,7 +818,7 @@ const MAX_COUNT = 100;
       const result = service.buildSpecsSection(specs);
       expect(result).toContain("基础规范");
       expect(result).toContain("Rule1");
-      expect(result).toContain("推荐做法");
+      expect(result).toContain("good");
     });
 
     it("should handle rules without examples", () => {
@@ -1163,7 +1258,7 @@ const MAX_COUNT = 100;
       ];
       const issues = [{ ruleId: "JsTs.FileName", file: "src/app.ts", line: "10" }];
       const consoleSpy = vi.spyOn(console, "error").mockImplementation(() => {});
-      const result = service.filterIssuesByOverrides(issues, specs, 1);
+      const result = service.filterIssuesByOverrides(issues, specs, undefined, 1);
       expect(result).toHaveLength(0);
       expect(consoleSpy).toHaveBeenCalled();
       consoleSpy.mockRestore();
@@ -1192,7 +1287,7 @@ const MAX_COUNT = 100;
       ];
       const issues = [{ ruleId: "Other.Rule", file: "src/app.ts" }];
       const consoleSpy = vi.spyOn(console, "error").mockImplementation(() => {});
-      service.filterIssuesByOverrides(issues, specs, 3);
+      service.filterIssuesByOverrides(issues, specs, undefined, 3);
       expect(consoleSpy).toHaveBeenCalled();
       consoleSpy.mockRestore();
     });
@@ -1558,14 +1653,16 @@ const MAX_COUNT = 100;
 
   describe("extractExamples - bad type", () => {
     it("should extract bad examples", () => {
-      const content = `### Bad
+      const content = `#### Bad: 不合理的命名
 
 \`\`\`ts
 const bad_name = 1;
 \`\`\``;
       const examples = (service as any).extractExamples(content);
       expect(examples).toHaveLength(1);
-      expect(examples[0].type).toBe("bad");
+      expect(examples[0].content).toHaveLength(1);
+      expect(examples[0].content[0].type).toBe("bad");
+      expect(examples[0].content[0].title).toBe("不合理的命名");
     });
   });
 
@@ -1617,4 +1714,162 @@ const bad_name = 1;
       expect(result[0].file).toBe("user.controller.ts");
     });
   });
+
+  describe("extractExamples - #### level with colon", () => {
+    it("should extract examples from #### Good: / #### Bad: format without group", () => {
+      const content = `#### Good: 合理的常量命名
+
+\`\`\`javascript
+const MAX_COUNT = 100;
+\`\`\`
+
+#### Bad: 不合理的常量命名
+
+\`\`\`javascript
+const maxCount = 100;
+\`\`\``;
+      const examples = (service as any).extractExamples(content);
+      expect(examples).toHaveLength(1);
+      expect(examples[0].title).toBe("");
+      expect(examples[0].description).toBe("");
+      expect(examples[0].content).toHaveLength(2);
+      expect(examples[0].content[0]).toEqual({
+        title: "合理的常量命名",
+        type: "good",
+        description: "const MAX_COUNT = 100;",
+      });
+      expect(examples[0].content[1]).toEqual({
+        title: "不合理的常量命名",
+        type: "bad",
+        description: "const maxCount = 100;",
+      });
+    });
+
+    it("should parse full rule with #### examples", () => {
+      const mockContent = `# 基础代码规范 \`[JsTs.Base]\`
+
+## 常量名使用大写加下划线命名 \`[JsTs.Base.ConstUpperCase]\`
+
+- 不检查 nodejs 的导包定义
+- 常量检查只需检查 const 声明的静态值
+
+#### Good: 合理的常量命名
+
+\`\`\`javascript
+const MAX_COUNT = 100;
+\`\`\`
+
+#### Bad: 不合理的常量命名
+
+\`\`\`javascript
+const maxCount = 100;
+\`\`\``;
+
+      const spec = service.parseSpecFile("js&ts.base.md", mockContent);
+      expect(spec).not.toBeNull();
+      expect(spec!.rules).toHaveLength(2);
+      expect(spec!.rules[1].id).toBe("JsTs.Base.ConstUpperCase");
+      expect(spec!.rules[1].description).toContain("不检查 nodejs");
+      expect(spec!.rules[1].description).not.toContain("Good");
+      expect(spec!.rules[1].examples).toHaveLength(1);
+      expect(spec!.rules[1].examples[0].content).toHaveLength(2);
+      expect(spec!.rules[1].examples[0].content[0].type).toBe("good");
+      expect(spec!.rules[1].examples[0].content[1].type).toBe("bad");
+    });
+
+    it("should parse multiple example groups with ### Example:", () => {
+      const mockContent = `# 基础代码规范 \`[JsTs.Base]\`
+
+## 常量名使用大写加下划线命名 \`[JsTs.Base.ConstUpperCase]\`
+
+- 不检查 nodejs 的导包定义
+- 常量检查只需检查 const 声明的静态值
+
+### Example: 下面的明明规则说明
+
+#### Good: 合理的常量命名
+
+\`\`\`javascript
+const MAX_COUNT = 100;
+\`\`\`
+
+#### Bad: 不合理的常量命名
+
+\`\`\`javascript
+const maxCount = 100;
+\`\`\`
+
+### Example: 另一种场景
+
+#### Good: 枚举值命名
+
+\`\`\`javascript
+const STATUS_ACTIVE = "active";
+\`\`\`
+
+#### Bad: 枚举值小驼峰
+
+\`\`\`javascript
+const statusActive = "active";
+\`\`\``;
+
+      const spec = service.parseSpecFile("js&ts.base.md", mockContent);
+      expect(spec).not.toBeNull();
+      expect(spec!.rules[1].id).toBe("JsTs.Base.ConstUpperCase");
+      expect(spec!.rules[1].description).toContain("不检查 nodejs");
+      expect(spec!.rules[1].description).not.toContain("Example");
+      expect(spec!.rules[1].examples).toHaveLength(2);
+
+      // 第一组
+      expect(spec!.rules[1].examples[0].title).toBe("下面的明明规则说明");
+      expect(spec!.rules[1].examples[0].description).toBe("");
+      expect(spec!.rules[1].examples[0].content).toHaveLength(2);
+      expect(spec!.rules[1].examples[0].content[0].type).toBe("good");
+      expect(spec!.rules[1].examples[0].content[1].type).toBe("bad");
+
+      // 第二组
+      expect(spec!.rules[1].examples[1].title).toBe("另一种场景");
+      expect(spec!.rules[1].examples[1].description).toBe("");
+      expect(spec!.rules[1].examples[1].content).toHaveLength(2);
+      expect(spec!.rules[1].examples[1].content[0].type).toBe("good");
+      expect(spec!.rules[1].examples[1].content[1].type).toBe("bad");
+    });
+
+    it("should parse Example with title and description paragraph", () => {
+      const mockContent = `# 基础代码规范 \`[JsTs.Base]\`
+
+## 函数行数限制 \`[JsTs.Base.FuncLines]\`
+
+- 函数不能太长
+
+### Example: 函数行数
+
+例子说明 desc
+
+#### Good: 函数不超过 200 行
+
+\`\`\`javascript
+function getUserInfo() {
+  // ... 小于等于 200
+}
+\`\`\`
+
+#### Bad: 函数超过 200 行
+
+\`\`\`javascript
+function getUserInfo() {
+  // ... 大于 200
+}
+\`\`\``;
+
+      const spec = service.parseSpecFile("js&ts.base.md", mockContent);
+      expect(spec).not.toBeNull();
+      expect(spec!.rules[1].examples).toHaveLength(1);
+      expect(spec!.rules[1].examples[0].title).toBe("函数行数");
+      expect(spec!.rules[1].examples[0].description).toBe("例子说明 desc");
+      expect(spec!.rules[1].examples[0].content).toHaveLength(2);
+      expect(spec!.rules[1].examples[0].content[0].type).toBe("good");
+      expect(spec!.rules[1].examples[0].content[0].title).toBe("函数不超过 200 行");
+    });
+  });
 });

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

@@ -12,9 +12,9 @@ import { readdir, readFile, mkdir, access, writeFile, unlink } from "fs/promises
 import { join, basename } from "path";
 import { homedir } from "os";
 import { execSync, execFileSync } from "child_process";
-import micromatch from "micromatch";
-import { ReviewSpec, ReviewRule, RuleExample, Severity } from "./types";
-import { extractGlobsFromIncludes } from "../review-includes-filter";
+import { ReviewSpec, ReviewRule, RuleExample, RuleContent, Severity } from "./types";
+import { matchIncludes } from "../review-includes-filter";
+import { buildSpecsSection as buildSpecsSectionPrompt } from "../prompt/specs-section";
 
 export class ReviewSpecService {
   constructor(protected readonly gitProvider?: GitProviderService) {}
@@ -606,7 +606,9 @@ export class ReviewSpecService {
 
       // 提取描述：在第一个例子之前的文本
       let description = ruleContent;
-      const firstExampleIndex = ruleContent.search(/(?:^|\n)###\s+(?:good|bad)/i);
+      const firstExampleIndex = ruleContent.search(
+        /(?:^|\n)(?:####\s+(?:good|bad)|###\s+Example:)/i,
+      );
       if (firstExampleIndex !== -1) {
         description = ruleContent.slice(0, firstExampleIndex).trim();
       } else {
@@ -684,27 +686,69 @@ export class ReviewSpecService {
 
   protected extractExamples(content: string): RuleExample[] {
     const examples: RuleExample[] = [];
-    const sections = content.split(/(?:^|\n)###\s+/);
-
-    for (const section of sections) {
-      const trimmedSection = section.trim();
-      if (!trimmedSection) continue;
 
-      let type: "good" | "bad" | null = null;
-      if (/^good\b/i.test(trimmedSection)) {
-        type = "good";
-      } else if (/^bad\b/i.test(trimmedSection)) {
-        type = "bad";
+    // 按 ### Example: 分组
+    const groupSections = content.split(/(?:^|\n)(?=###\s+Example:)/);
+
+    for (const groupSection of groupSections) {
+      const trimmedGroup = groupSection.trim();
+      if (!trimmedGroup) continue;
+
+      // 提取分组标题和描述，如 "### Example: 函数行数"
+      let exampleTitle = "";
+      let exampleDescription = "";
+      const groupMatch = trimmedGroup.match(/^###\s+Example\s*[:：]\s*(.+)/i);
+      if (groupMatch) {
+        exampleTitle = groupMatch[1].trim();
+        // 提取标题行和第一个 #### 之间的文本作为 description
+        const afterTitle = trimmedGroup.slice(trimmedGroup.indexOf("\n")).trim();
+        const firstSubIdx = afterTitle.search(/(?:^|\n)####\s+/);
+        if (firstSubIdx > 0) {
+          exampleDescription = afterTitle.slice(0, firstSubIdx).trim();
+        }
       }
 
-      if (!type) continue;
+      // 在分组内按 #### 提取 Good/Bad
+      const ruleContents: RuleContent[] = [];
+      const sections = trimmedGroup.split(/(?:^|\n)####\s+/);
+
+      for (const section of sections) {
+        const trimmedSection = section.trim();
+        if (!trimmedSection) continue;
+
+        let type: "good" | "bad" | null = null;
+        let contentTitle = "";
+        if (/^good:/i.test(trimmedSection)) {
+          type = "good";
+          contentTitle = trimmedSection.match(/^good:\s*(.+)/i)?.[1]?.trim() ?? "";
+        } else if (/^bad:/i.test(trimmedSection)) {
+          type = "bad";
+          contentTitle = trimmedSection.match(/^bad:\s*(.+)/i)?.[1]?.trim() ?? "";
+        }
+
+        if (!type) continue;
 
-      const codeBlockRegex = /```(\w*)\n([\s\S]*?)```/g;
-      let codeMatch;
-      while ((codeMatch = codeBlockRegex.exec(trimmedSection)) !== null) {
-        const lang = codeMatch[1] || "text";
-        const code = codeMatch[2].trim();
-        examples.push({ lang, code, type });
+        // 提取代码块作为 description
+        const codeBlockRegex = /```(\w*)\n([\s\S]*?)```/g;
+        let codeMatch;
+        const codeParts: string[] = [];
+        while ((codeMatch = codeBlockRegex.exec(trimmedSection)) !== null) {
+          codeParts.push(codeMatch[2].trim());
+        }
+
+        ruleContents.push({
+          title: contentTitle,
+          type,
+          description: codeParts.join("\n\n"),
+        });
+      }
+
+      if (ruleContents.length > 0) {
+        examples.push({
+          title: exampleTitle,
+          description: exampleDescription,
+          content: ruleContents,
+        });
       }
     }
 
@@ -748,10 +792,12 @@ export class ReviewSpecService {
    * 根据 spec 的 includes 配置过滤 issues
    * 只保留文件名匹配对应 spec includes 模式的 issues
    * 如果 spec 没有 includes 配置，则保留该 spec 的所有 issues
+   * 支持 `added|`/`modified|`/`deleted|` 前缀语法
    */
   filterIssuesByIncludes<T extends { file: string; ruleId: string }>(
     issues: T[],
     specs: ReviewSpec[],
+    changedFiles?: ChangedFileCollection,
   ): T[] {
     // 构建 spec filename -> includes 的映射
     const specIncludesMap = new Map<string, string[]>();
@@ -771,14 +817,9 @@ export class ReviewSpecService {
         return true;
       }
 
-      // 检查文件是否匹配 includes 模式（转换为纯 glob，避免 status| 前缀和 code-* 空串传入 micromatch）
-      const globs = extractGlobsFromIncludes(includes);
-      if (globs.length === 0) return true;
-      const matches = micromatch.isMatch(issue.file, globs, { matchBase: true });
-      if (!matches) {
-        // console.log(`   Issue [${issue.ruleId}] 在文件 ${issue.file} 不匹配 includes 模式，跳过`);
-      }
-      return matches;
+      // 使用 matchIncludes 检查文件是否匹配 includes 模式（支持 status|glob 前缀）
+      const fileStatus = changedFiles?.getStatus(issue.file);
+      return matchIncludes(includes, issue.file, fileStatus);
     });
   }
 
@@ -816,6 +857,7 @@ export class ReviewSpecService {
   filterIssuesByOverrides<T extends { ruleId: string; file?: string }>(
     issues: T[],
     specs: ReviewSpec[],
+    changedFiles?: ChangedFileCollection,
     verbose?: VerboseLevel,
   ): T[] {
     // ========== 阶段1: 收集 spec -> overrides 的映射（保留作用域信息） ==========
@@ -887,10 +929,9 @@ export class ReviewSpecService {
         if (scoped.includes.length === 0) {
           return true;
         }
-        // 使用 micromatch 检查文件是否匹配 includes 模式（转换为纯 glob）
-        const globs = extractGlobsFromIncludes(scoped.includes);
-        if (globs.length === 0) return true;
-        return issueFile && micromatch.isMatch(issueFile, globs, { matchBase: true });
+        // 使用 matchIncludes 检查文件是否匹配 includes 模式（支持 status|glob 前缀）
+        const fileStatus = changedFiles?.getStatus(issueFile);
+        return matchIncludes(scoped.includes, issueFile, fileStatus);
       });
 
       if (matched) {
@@ -1011,29 +1052,7 @@ export class ReviewSpecService {
    * 构建 specs 的 prompt 部分
    */
   buildSpecsSection(specs: ReviewSpec[]): string {
-    return specs
-      .map((spec) => {
-        const firstRule = spec.rules[0];
-        const rulesText = spec.rules
-          .slice(1)
-          .map((rule) => {
-            let text = `#### [${rule.id}] ${rule.title}\n`;
-            if (rule.description) {
-              text += `${rule.description}\n`;
-            }
-            if (rule.examples.length > 0) {
-              for (const example of rule.examples) {
-                text += `##### ${example.type === "good" ? "推荐做法 (Good)" : "不推荐做法 (Bad)"}\n`;
-                text += `\`\`\`${example.lang}\n${example.code}\n\`\`\`\n`;
-              }
-            }
-            return text;
-          })
-          .join("\n");
-
-        return `### ${firstRule.title}\n- 规范文件: ${spec.filename}\n- 适用扩展名: ${spec.extensions.join(", ")}\n\n${rulesText}`;
-      })
-      .join("\n\n-------------------\n\n");
+    return buildSpecsSectionPrompt(specs);
   }
 
   /**

package/src/review-spec/types.ts

@@ -24,9 +24,15 @@ export interface ReviewSpec {
 }
 
 export interface RuleExample {
-  lang: string;
-  code: string;
+  title: string;
+  description: string;
+  content: RuleContent[];
+}
+
+export interface RuleContent {
+  title: string;
   type: "good" | "bad";
+  description: string;
 }
 
 export interface ReviewRule {

package/src/review.service.ts

@@ -3,7 +3,6 @@ import {
   PullRequestCommit,
   type LLMMode,
   LlmProxyService,
-  type VerboseLevel,
   shouldLog,
   GitSdkService,
 } from "@spaceflow/core";
@@ -281,7 +280,7 @@ export class ReviewService {
     const { commits, fileContents, changedFiles, isDirectFileMode, context } = opts;
     const { verbose } = context;
 
-    let filtered = this.reviewSpecService.filterIssuesByIncludes(issues, specs);
+    let filtered = this.reviewSpecService.filterIssuesByIncludes(issues, specs, changedFiles);
     if (shouldLog(verbose, 1)) {
       console.log(`   应用 includes 过滤后: ${filtered.length} 个问题`);
     }
@@ -291,7 +290,12 @@ export class ReviewService {
       console.log(`   应用规则存在性过滤后: ${filtered.length} 个问题`);
     }
 
-    filtered = this.reviewSpecService.filterIssuesByOverrides(filtered, specs, verbose);
+    filtered = this.reviewSpecService.filterIssuesByOverrides(
+      filtered,
+      specs,
+      changedFiles,
+      verbose,
+    );
 
     // 变更行过滤
     if (shouldLog(verbose, 3)) {

package/dist/551.js

@@ -1,9 +0,0 @@
-export const __rspack_esm_id = "551";
-export const __rspack_esm_ids = ["551"];
-export const __webpack_modules__ = {
-946(module) {
-module.exports = import("micromatch").then(function(module) { return module; });
-
-},
-
-};