gitlab-ai-review 3.2.3 → 3.2.4

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 (2) hide show
  1. package/lib/prompt-tools.js +30 -34
  2. package/package.json +1 -1
@@ -84,7 +84,7 @@ export function buildFileReviewPrompt(fileName, meaningfulChanges) {
84
84
  2. **优先检查"类型: 删除"的代码**,确认是否有其他地方仍在使用
85
85
  3. **只对有问题的行提出审查意见**,没有问题的行不需要评论
86
86
  4. **必须使用中文**返回审查意见
87
- 5. 返回 JSON 格式的结果,格式如下:
87
+ 5. **必须返回标准 JSON 格式**,不要用其他格式,结构如下:
88
88
 
89
89
  \`\`\`json
90
90
  {
@@ -92,24 +92,25 @@ export function buildFileReviewPrompt(fileName, meaningfulChanges) {
92
92
  {
93
93
  "lineNumber": 15,
94
94
  "hasIssue": true,
95
- "comment": "请按照项目审查规则中定义的格式填写审查意见"
96
- },
97
- {
98
- "lineNumber": 20,
99
- "hasIssue": false
95
+ "comment": "这里填写审查意见内容"
100
96
  }
101
97
  ]
102
98
  }
103
99
  \`\`\`
104
100
 
105
- **JSON 格式要求:**
101
+ **🚨 重要:外层必须是标准 JSON**
102
+ - 整个响应必须是合法的 JSON 对象
103
+ - 不要在最外层使用【】、emoji 或其他特殊格式
106
104
  - lineNumber 必须是数字
107
- - hasIssue 必须是布尔值
108
- - **comment 字段的内容格式:请严格遵循"项目特定的审查规则"中定义的格式**
109
- - 如果项目规则中没有定义特殊格式,使用中文简洁描述即可
105
+ - hasIssue 必须是布尔值(true/false)
106
+ - comment 必须是字符串
107
+
108
+ **comment 字段的内容:**
109
+ - 如果"项目特定的审查规则"中定义了 comment 格式(如包含 emoji、评分等),请在 comment 字符串内使用该格式
110
+ - 如果没有定义特殊格式,使用中文简洁描述即可
110
111
 
111
112
  6. 如果所有代码都没有问题,返回空的 reviews 数组:\`{"reviews": []}\`
112
- 7. 只返回 JSON,不要包含其他文字说明
113
+ 7. **只返回 JSON**,不要在 JSON 外面添加任何文字说明
113
114
 
114
115
  **再次强调:**
115
116
  - 看到 "类型: 删除" 和 "-" → 代码被移除了
@@ -328,7 +329,7 @@ export function buildFileReviewWithImpactPrompt(fileName, meaningfulChanges, imp
328
329
  7. 如果发现其他文件使用了**被删除/修改**的符号,需要提醒可能的影响
329
330
  8. **只对有问题的行提出审查意见**,没有问题的行不需要评论
330
331
  9. **必须使用中文**返回审查意见
331
- 10. 返回 JSON 格式的结果,格式如下:
332
+ 10. **必须返回标准 JSON 格式**,不要用其他格式,结构如下:
332
333
 
333
334
  \`\`\`json
334
335
  {
@@ -336,42 +337,37 @@ export function buildFileReviewWithImpactPrompt(fileName, meaningfulChanges, imp
336
337
  {
337
338
  "lineNumber": 15,
338
339
  "hasIssue": true,
339
- "comment": "请按照项目审查规则中定义的格式填写审查意见"
340
- },
341
- {
342
- "lineNumber": 20,
343
- "hasIssue": false
340
+ "comment": "这里填写审查意见内容"
344
341
  }
345
342
  ]
346
343
  }
347
344
  \`\`\`
348
345
 
349
- **🚨 关键规则:**
350
- - lineNumber 必须是上面"代码变更"中列出的行号(如第 15 行、第 20 行等)
346
+ **🚨 JSON 格式的关键规则:**
347
+ - **整个响应必须是合法的 JSON 对象**
348
+ - **不要在最外层使用【】、emoji 或其他特殊格式**
349
+ - lineNumber 必须是上面"代码变更"中列出的行号
350
+ - lineNumber 必须是数字,不能是 null、undefined
351
351
  - **不要使用其他文件的行号**,即使发现其他文件受影响
352
- - 如果发现其他文件受影响,在当前变更行的 comment 中说明影响范围
353
- - lineNumber 必须是数字,不能是 null、undefined 或其他值
354
- - 如果某个变更没有问题,可以不在 reviews 中包含它
355
- - **comment 字段的内容格式:请严格遵循"项目特定的审查规则"中定义的格式**(如果有定义)
352
+ - 如果发现其他文件受影响,在当前变更行的 comment 字符串中说明
353
+
354
+ **comment 字段的内容:**
355
+ - 如果"项目特定的审查规则"中定义了 comment 格式(如包含【严重程度评分】、emoji、分点说明等),**请在 comment 字符串内**使用该格式
356
+ - comment 是一个字符串,可以包含换行符 \\n 来格式化内容
357
+ - 如果没有定义特殊格式,使用中文简洁描述即可
356
358
 
357
359
  **示例:**
358
- 如果删除了第 15 行的函数,且发现其他文件在使用:
359
- \`\`\`json
360
- {
361
- "lineNumber": 15,
362
- "hasIssue": true,
363
- "comment": "删除函数 fetchData 会导致以下文件调用失败:components/UserList.vue (第 45 行)、pages/Dashboard.vue (第 78 行)。建议保留该函数或提供替代方案。"
364
- }
365
- \`\`\`
360
+ 如果删除了第 15 行的函数,且发现其他文件在使用,comment 内容可以是:
361
+ "【严重程度评分:8/10】\\n\\n📋 问题描述:\\n删除了函数 fetchData 但该函数仍被多处使用\\n\\n🔍 影响分析:\\n• 当前文件:函数定义被完全移除\\n• 受影响的其他文件:components/UserList.vue (第 45 行)\\n\\n💡 改进建议:\\n1. 恢复此函数或提供替代方案\\n2. 先标记为 @deprecated"
366
362
 
367
363
  11. 如果所有代码都没有问题,返回空的 reviews 数组:\`{"reviews": []}\`
368
- 12. 只返回 JSON,不要包含其他文字说明
369
- 13. comment 字段必须使用中文,要简洁明了,重点指出影响范围
364
+ 12. **只返回 JSON**,不要在 JSON 外面添加任何文字说明
370
365
 
371
366
  **最后再次确认:**
372
367
  - 看到 **"类型: 删除"** 和 **"-"** → 代码**被移除了**,需要检查影响
373
368
  - 看到 **"类型: 新增"** 和 **"+"** → 代码**是新的**,检查代码质量
374
- - **千万不要把删除理解成新增!**`;
369
+ - **千万不要把删除理解成新增!**
370
+ - **返回的必须是标准 JSON,不要在最外层使用特殊字符!**`;
375
371
 
376
372
  return prompt;
377
373
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "gitlab-ai-review",
3
- "version": "3.2.3",
3
+ "version": "3.2.4",
4
4
  "description": "GitLab AI Review SDK with Impact Analysis - 支持影响分析、删除符号检测、注释代码识别、文件内部冲突检查、智能文件过滤的智能代码审查工具",
5
5
  "main": "index.js",
6
6
  "type": "module",