@spaceflow/review 1.0.0 → 2.0.0

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## [1.0.0](https://github.com/Lydanne/spaceflow/compare/@spaceflow/review@0.83.0...@spaceflow/review@1.0.0) (2026-04-13)
+
+### ⚠ BREAKING CHANGES
+
+* **review:** 重构 example 数据结构,支持 `### Example:` 分组和 `#### Good:/Bad:` 标题语法
+
+### 新特性
+
+* **review:** 新增 includes 变更类型前缀语法支持 ([2f5655f](https://github.com/Lydanne/spaceflow/commit/2f5655fc414828ea3a0269fba04611d2bf2591a9))
+* **review:** 重构 example 数据结构,支持 `### Example:` 分组和 `#### Good:/Bad:` 标题语法 ([e45bd5a](https://github.com/Lydanne/spaceflow/commit/e45bd5aab5e317b8f70a8b107c17aab6548c3296))
+
+### 其他修改
+
+* **review-summary:** released version 0.52.0 [no ci] ([1d0cdac](https://github.com/Lydanne/spaceflow/commit/1d0cdacdbe12db98399e69fd53bbfdd23825cc10))
+
 ## [0.83.0](https://github.com/Lydanne/spaceflow/compare/@spaceflow/review@0.82.0...@spaceflow/review@0.83.0) (2026-04-10)
 
 ### 代码重构

package/dist/index.js

@@ -305,7 +305,7 @@ const CODE_BLOCK_TYPES = [
 function formatExample(example) {
     let text = "";
     if (example.title) {
-        text += `##### ${example.title}\n`;
+        text += `##### Example: ${example.title}\n`;
     }
     if (example.description) {
         text += `${example.description}\n`;
@@ -903,13 +903,18 @@ class ReviewSpecService {
         for (const groupSection of groupSections){
             const trimmedGroup = groupSection.trim();
             if (!trimmedGroup) continue;
-            // 提取分组描述，如 "### Example: 命名规则说明"
+            // 提取分组标题和描述，如 "### Example: 函数行数"
             let exampleTitle = "";
             let exampleDescription = "";
             const groupMatch = trimmedGroup.match(/^###\s+Example\s*[:：]\s*(.+)/i);
             if (groupMatch) {
-                exampleTitle = "Example";
-                exampleDescription = groupMatch[1].trim();
+                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();
+                }
             }
             // 在分组内按 #### 提取 Good/Bad
             const ruleContents = [];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spaceflow/review",
-  "version": "1.0.0",
+  "version": "2.0.0",
   "description": "Spaceflow 代码审查插件，使用 LLM 对 PR 代码进行自动审查",
   "license": "MIT",
   "author": "Lydanne",

package/src/prompt/specs-section.ts

@@ -31,7 +31,7 @@ export function buildSpecsSection(specs: ReviewSpec[]): string {
 function formatExample(example: RuleExample): string {
   let text = "";
   if (example.title) {
-    text += `##### ${example.title}\n`;
+    text += `##### Example: ${example.title}\n`;
   }
   if (example.description) {
     text += `${example.description}\n`;

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

@@ -1821,18 +1821,55 @@ const statusActive = "active";
       expect(spec!.rules[1].examples).toHaveLength(2);
 
       // 第一组
-      expect(spec!.rules[1].examples[0].title).toBe("Example");
-      expect(spec!.rules[1].examples[0].description).toBe("下面的明明规则说明");
+      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("Example");
-      expect(spec!.rules[1].examples[1].description).toBe("另一种场景");
+      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

@@ -694,13 +694,18 @@ export class ReviewSpecService {
       const trimmedGroup = groupSection.trim();
       if (!trimmedGroup) continue;
 
-      // 提取分组描述，如 "### Example: 命名规则说明"
+      // 提取分组标题和描述，如 "### Example: 函数行数"
       let exampleTitle = "";
       let exampleDescription = "";
       const groupMatch = trimmedGroup.match(/^###\s+Example\s*[:：]\s*(.+)/i);
       if (groupMatch) {
-        exampleTitle = "Example";
-        exampleDescription = groupMatch[1].trim();
+        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();
+        }
       }
 
       // 在分组内按 #### 提取 Good/Bad