npm - job51-gitlab-cr-node-skill-prompt-optimize - Versions diffs - 1.3.5 → 1.3.7 - Mend

job51-gitlab-cr-node-skill-prompt-optimize 1.3.5 → 1.3.7

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 (7) hide show

package/.claude/settings.local.json ADDED Viewed

@@ -0,0 +1,8 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(ls:*)",
+      "Bash(pdftotext:*cr-node文件夹下的md和pdf文件，分别是提示词模板和报告结果)"
+    ]
+  }
+}

package/PDF_CONVERSION_README.md ADDED Viewed

@@ -0,0 +1,131 @@
+# 代码审查报告转PDF工具使用说明
+## 问题分析
+您发现当前系统存在以下问题：
+1. `mr-review-template.md` 是一个用于代码审查的提示词模板
+2. 当前目录的PDF文件是从GitLab网页导出的页面快照，不是代码审查报告
+3. 代码审查系统的输出直接发布到GitLab MR中，而不是保存为本地PDF
+## 解决方案
+我已创建了一个工具脚本 `convert-report-to-pdf.js` 来解决这个问题：
+### 功能说明
+1. **读取审查报告**：从包含 `<REPORT>` 和 `</REPORT>` 标签的文件中提取审查报告内容
+2. **格式转换**：将Markdown格式的报告转换为适合打印的HTML格式
+3. **生成可打印文档**：创建带有适当样式的HTML文档，方便转换为PDF
+### 使用方法
+#### 1. 生成代码审查报告
+首先，确保您有代码审查系统的输出文件。如果您还没有实际的审查报告，可以使用以下示例：
+```bash
+# 创建示例审查报告文件
+echo '<REPORT>
+## 🤖 AI代码审查结果
+**生成时间**: 2026-03-09 09:30:00
+**审查范围**: 2个文件（仅统计有代码变更的文件）
+---
+### 审查总览
+本次审查发现了1个严重问题和2个优化建议，主要涉及安全性、代码可读性和性能方面的问题。
+### 🔴 严重问题
+①：在UserService.java文件中，数据库查询缺少输入验证，可能存在SQL注入风险
+**文件及行号**：UserService.java:125-130
+**修改建议**：使用参数化查询替换字符串拼接方式，防止SQL注入攻击
+错误代码：
+```java
+String sql = "SELECT * FROM users WHERE id = " + userId;
+```
+正确示例代码：
+```java
+String sql = "SELECT * FROM users WHERE id = ?";
+PreparedStatement stmt = connection.prepareStatement(sql);
+stmt.setString(1, userId);
+```
+### 🟢 优化建议
+**文件及行号**：UserController.java:45-50
+**优化建议**：方法中存在重复代码，建议提取为公共方法提高可维护性
+**示例代码**：
+```java
+// 原代码
+public void updateUser(Long id, String name) {
+    validateUser(id);
+    validateName(name);
+    // ... update logic
+}
+public void createUser(String name) {
+    validateUser(null);  // 重复的验证逻辑
+    validateName(name);
+    // ... create logic
+}
+```
+**文件及行号**：ConfigService.java:78-82
+**优化建议**：配置项可以使用枚举类型提高类型安全
+**示例代码**：
+```java
+// 原代码
+public static final String DB_TYPE_MYSQL = "mysql";
+public static final String DB_TYPE_POSTGRES = "postgres";
+// 建议
+public enum DbType {
+    MYSQL("mysql"),
+    POSTGRES("postgres");
+    private final String value;
+    DbType(String value) { this.value = value; }
+    public String getValue() { return value; }
+}
+```
+### 🔄 上下文影响分析（需涵盖依赖关系、功能关联性、兼容性风险三个维度）
+**受影响组件**: 用户管理模块、数据库访问层
+**影响描述**: 如果不修复SQL注入问题，可能导致数据库被恶意查询，造成数据泄露
+**验证建议**: 使用恶意输入测试数据库查询接口，确认是否能阻止非法输入
+</REPORT>' > sample-review-report.txt
+```
+#### 2. 转换为PDF可用的HTML格式
+```bash
+node convert-report-to-pdf.js sample-review-report.txt review-report.html
+```
+#### 3. 转换为PDF
+1. 在浏览器中打开生成的 `review-report.html` 文件
+2. 按 `Ctrl+P` 打开打印对话框
+3. 选择 "另存为PDF" 作为打印机
+4. 设置页面为A4或Letter格式
+5. 点击保存
+### 注意事项
+- 转换脚本会保留报告的格式和结构
+- HTML文件包含了自动生成PDF的JavaScript代码（在浏览器中）
+- 如果您的审查报告格式与此不同，可以调整 `convert-report-to-pdf.js` 中的解析逻辑
+## 完整的工作流程
+1. 使用 `index.js` 运行代码审查并获得报告输出
+2. 将审查结果保存到文件（包含 `<REPORT>` 标签）
+3. 使用 `convert-report-to-pdf.js` 转换为HTML格式
+4. 在浏览器中打开HTML文件并打印为PDF
+这样您就可以得到一个格式良好的PDF版本的代码审查报告了。

package/convert-report-to-pdf.js ADDED Viewed

@@ -0,0 +1,240 @@
+#!/usr/bin/env node
+const fs = require('fs');
+const path = require('path');
+/**
+ * 将代码审查报告转换为PDF的HTML模板
+ */
+function createHtmlTemplate(reportContent) {
+  return `
+<!DOCTYPE html>
+<html lang="zh-CN">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>AI代码审查报告</title>
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/jspdf/2.5.1/jspdf.umd.min.js"></script>
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/html2canvas/1.4.1/html2canvas.min.js"></script>
+    <style>
+        body {
+            font-family: Arial, sans-serif;
+            padding: 20px;
+            line-height: 1.6;
+        }
+        .report-container {
+            max-width: 800px;
+            margin: 0 auto;
+            border: 1px solid #ddd;
+            padding: 30px;
+            background-color: #fff;
+        }
+        h1, h2, h3 {
+            color: #333;
+        }
+        h1 {
+            border-bottom: 2px solid #4CAF50;
+            padding-bottom: 10px;
+        }
+        h2 {
+            color: #2196F3;
+            border-left: 4px solid #2196F3;
+            padding-left: 10px;
+            margin-top: 25px;
+        }
+        .severity-high {
+            border-left: 4px solid #f44336;
+            background-color: #ffebee;
+            padding: 10px;
+            margin: 10px 0;
+        }
+        .severity-medium {
+            border-left: 4px solid #ff9800;
+            background-color: #fff3e0;
+            padding: 10px;
+            margin: 10px 0;
+        }
+        .severity-low {
+            border-left: 4px solid #4CAF50;
+            background-color: #e8f5e8;
+            padding: 10px;
+            margin: 10px 0;
+        }
+        .code-block {
+            background-color: #f5f5f5;
+            border: 1px solid #ddd;
+            border-radius: 4px;
+            padding: 10px;
+            overflow-x: auto;
+            font-family: monospace;
+            white-space: pre-wrap;
+        }
+        .file-info {
+            background-color: #e3f2fd;
+            padding: 8px;
+            border-radius: 4px;
+            margin: 5px 0;
+        }
+        ul {
+            padding-left: 20px;
+        }
+        li {
+            margin: 8px 0;
+        }
+    </style>
+</head>
+<body>
+    <div class="report-container">
+        ${reportContent}
+    </div>
+    <script>
+        // 页面加载完成后自动转换为PDF（可选）
+        function convertToPdf() {
+            const { jsPDF } = window.jspdf;
+            const element = document.querySelector('.report-container');
+            html2canvas(element, {
+                scale: 2,
+                useCORS: true,
+                backgroundColor: '#ffffff'
+            }).then(canvas => {
+                const imgData = canvas.toDataURL('image/png');
+                const pdf = new jsPDF('p', 'mm', 'a4');
+                const imgWidth = 210;
+                const pageHeight = 295;
+                const imgHeight = canvas.height * imgWidth / canvas.width;
+                let heightLeft = imgHeight;
+                let position = 0;
+                pdf.addImage(imgData, 'PNG', 0, position, imgWidth, imgHeight);
+                heightLeft -= pageHeight;
+                while (heightLeft >= 0) {
+                    position = heightLeft - imgHeight;
+                    pdf.addPage();
+                    pdf.addImage(imgData, 'PNG', 0, position, imgHeight > pageHeight ? imgWidth : imgWidth, imgHeight > pageHeight ? pageHeight : imgHeight);
+                    heightLeft -= pageHeight;
+                }
+                pdf.save('ai-code-review-report.pdf');
+            });
+        }
+        // 5秒后自动执行转换，或用户手动调用
+        // setTimeout(convertToPdf, 5000);
+    </script>
+</body>
+</html>`;
+}
+/**
+ * 将Markdown格式的报告转换为HTML
+ */
+function mdToHtml(mdContent) {
+  // 简单的Markdown到HTML转换
+  let html = mdContent;
+  // 转义HTML特殊字符
+  html = html.replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;');
+  // 标题
+  html = html.replace(/^###\s+(.*)$/gm, '<h3>$1</h3>');
+  html = html.replace(/^##\s+(.*)$/gm, '<h2>$1</h2>');
+  html = html.replace(/^#\s+(.*)$/gm, '<h1>$1</h1>');
+  // 段落
+  html = html.replace(/^\s*(.+)$/gm, '<p>$1</p>');
+  // 特殊标记（严重问题、警告、优化建议）
+  html = html.replace(/🔴\s+严重问题/g, '<h2 class="severity-high-title">🔴 严重问题</h2>');
+  html = html.replace(/🟡\s+警告/g, '<h2 class="severity-medium-title">🟡 警告</h2>');
+  html = html.replace(/🟢\s+优化建议/g, '<h2 class="severity-low-title">🟢 优化建议</h2>');
+  // 回滚之前的替换，只处理行首的标题
+  html = html.replace(/<p>##\s+(.*?)<\/p>/g, '<h2>$1</h2>');
+  html = html.replace(/<p>###\s+(.*?)<\/p>/g, '<h3>$1</h3>');
+  // 文件和行号信息
+  html = html.replace(/\*\*文件及行号\*\*：([^\n<]+)/g, '<div class="file-info"><strong>文件及行号：</strong>$1</div>');
+  // 修改建议和示例代码
+  html = html.replace(/\*\*修改建议\*\*：([\s\S]*?)(?=<div class="file-info"|<h2>|<\/div>|$)/g,
+    '<div class="severity-high"><strong>修改建议：</strong><br>$1</div>');
+  html = html.replace(/\*\*优化建议\*\*：([\s\S]*?)(?=<div class="file-info"|<h2>|<\/div>|$)/g,
+    '<div class="severity-low"><strong>优化建议：</strong><br>$1</div>');
+  // 代码块
+  html = html.replace(/```([\s\S]*?)```/g, '<div class="code-block">$1</div>');
+  // 换行处理
+  html = html.replace(/\n/g, '<br>');
+  // 恢复一些必要的换行和结构
+  html = html.replace(/<br><\/div>/g, '</div>');
+  html = html.replace(/<br><\/h2>/g, '</h2>');
+  html = html.replace(/<br><\/h3>/g, '</h3>');
+  html = html.replace(/<br><\/p>/g, '</p>');
+  html = html.replace(/<br><\/strong>/g, '</strong>');
+  return html;
+}
+/**
+ * 从文件读取审查报告并转换为PDF可用的HTML
+ */
+function convertReviewReportToPdfHtml(inputFilePath, outputHtmlPath) {
+  try {
+    // 读取输入文件
+    const content = fs.readFileSync(inputFilePath, 'utf8');
+    // 如果内容被REPORT标签包围，只提取标签内的内容
+    const reportMatch = content.match(/<REPORT>([\s\S]*?)<\/REPORT>/);
+    const reportContent = reportMatch ? reportMatch[1] : content;
+    // 转换Markdown为HTML
+    const htmlContent = mdToHtml(reportContent);
+    // 创建完整的HTML文档
+    const fullHtml = createHtmlTemplate(htmlContent);
+    // 写入输出文件
+    fs.writeFileSync(outputHtmlPath, fullHtml);
+    console.log(`✅ 已成功将代码审查报告转换为HTML格式: ${outputHtmlPath}`);
+    console.log(`💡 要生成PDF，请在浏览器中打开此HTML文件并使用Ctrl+P打印为PDF`);
+    return true;
+  } catch (error) {
+    console.error('❌ 转换过程中发生错误:', error.message);
+    return false;
+  }
+}
+// 如果直接运行此脚本
+if (require.main === module) {
+  const args = process.argv.slice(2);
+  if (args.length < 2) {
+    console.log('📝 使用方法:');
+    console.log('   node convert-report-to-pdf.js <输入报告文件> <输出HTML文件>');
+    console.log('');
+    console.log('📖 示例:');
+    console.log('   node convert-report-to-pdf.js review-output.txt review-report.html');
+    console.log('');
+    console.log('💡 提示: 生成的HTML文件可以直接在浏览器中打开，然后使用打印功能保存为PDF');
+    process.exit(1);
+  }
+  const inputPath = args[0];
+  const outputPath = args[1];
+  convertReviewReportToPdfHtml(inputPath, outputPath);
+}
+module.exports = {
+  convertReviewReportToPdfHtml,
+  createHtmlTemplate,
+  mdToHtml
+};

package/mr-review-template.md CHANGED Viewed

@@ -104,7 +104,19 @@
         >   - **处理**：不报告此安全问题
         >   - 若该行以 `+` 开头表示新增或保留
         >   - **处理**：报告安全问题，错误代码展示该行（不带 `-` 前缀）
+18. **变更内容解析步骤**（分析前必须执行）：
+    > - **步骤 1：识别变更类型**
+        >   - 遍历 `<CHANGE_CONTENT>` 中的每一行
+        >   - 标记每行的类型：`-`（删除）、`+`（新增）、空格（保留）
+    > - **步骤 2：构建变更后代码视图**
+        >   - 仅保留 `+` 开头的行和空格开头的行
+        >   - **丢弃**所有 `-` 开头的行
+    > - **步骤 3：基于变更后代码视图进行审查**
+        >   - 所有问题识别、行号计算、错误代码选取均基于变更后代码视图
+        >   - **禁止**引用已丢弃的 `-` 开头行
+    > - **步骤 4：验证错误代码示例**
+        >   - 检查错误代码示例中是否包含 `-` 前缀
+        >   - 若包含，必须移除 `-` 前缀或重新选取变更后实际存在的代码
 <REPORT>
 ## 🤖 AI代码审查结果
@@ -120,42 +132,42 @@
 ### 🔴 严重问题
-  [带圈数字序号，如：①，字体格式和后续问题描述一致]：[具体问题描述]<br/>
+  [带圈数字序号，如：①，字体格式和后续问题描述一致][具体问题描述]<br/>
   **文件及行号**：[问题所在文件相关代码块开始至结束行号，格式类似：ApplyPushServiceImpl.java:176-180]<br/>
   **修改建议**：[修复建议，展示错误代码及对应修改后的示例代码，注意：错误代码和正确示例代码是必须存在的部分！！！]
-  [带圈数字序号，如：②，字体格式和后续问题描述一致]：[具体问题描述]<br/>
+  [带圈数字序号，如：②，字体格式和后续问题描述一致][具体问题描述]<br/>
   **文件及行号**：[问题所在文件相关代码块开始至结束行号，格式类似：ApplyPushServiceImpl.java:176-180]<br/>
   **修改建议**：[修复建议，展示错误代码及对应修改后的示例代码，注意：错误代码和正确示例代码是必须存在的部分！！！]
 ### 🟡 警告
-  [带圈数字序号，如：①，字体格式和后续问题描述一致]：[具体问题描述]<br/>
+  [带圈数字序号，如：①，字体格式和后续问题描述一致][具体问题描述]<br/>
   **文件及行号**：[问题所在文件相关代码块开始至结束行号，格式类似：ApplyPushServiceImpl.java:176-180]<br/>
   **修改建议**：[改进建议，展示相应代码及对应修改后的示例代码]
-  [带圈数字序号，如：②，字体格式和后续问题描述一致]：[具体问题描述]<br/>
+  [带圈数字序号，如：②，字体格式和后续问题描述一致][具体问题描述]<br/>
   **文件及行号**：[问题所在文件相关代码块开始至结束行号，格式类似：ApplyPushServiceImpl.java:176-180]<br/>
   **修改建议**：[改进建议，展示相应代码及对应修改后的示例代码]
 ### 🟢 优化建议
+  [带圈数字序号，如：①，字体格式和后续优化建议一致][优化建议及可以直接使用的修改提示词]<br/>
   **文件及行号**：[问题所在文件相关代码块开始至结束行号，格式类似：ApplyPushServiceImpl.java:176-180]<br/>
-  **优化建议**：[优化建议及可以直接使用的修改提示词]<br/>
   **示例代码**：[展示相应代码及对应修改优化后的示例代码]
+  [带圈数字序号，如：②，字体格式和后续优化建议一致][优化建议及可以直接使用的修改提示词]<br/>
   **文件及行号**：[问题所在文件相关代码块开始至结束行号，格式类似：ApplyPushServiceImpl.java:176-180]<br/>
-  **优化建议**：[优化建议及可以直接使用的修改提示词]<br/>
   **示例代码**：[展示相应代码及对应修改优化后的示例代码]
 ### 🔄 上下文影响分析（需涵盖依赖关系、功能关联性、兼容性风险三个维度）
+  [带圈数字序号，如：①，字体格式和影响描述建议一致][影响描述：功能正确性影响、性能影响、兼容性影响（如API变更导致的下游系统影响）]<br/>
   **受影响组件**: [直接依赖的类/方法/模块、间接关联的功能模块]<br/>
-  **影响描述**: [功能正确性影响、性能影响、兼容性影响（如API变更导致的下游系统影响）]<br/>
   **验证建议**: [如何验证是否存在此问题]
+  [带圈数字序号，如：②，字体格式和影响描述建议一致][影响描述：功能正确性影响、性能影响、兼容性影响（如API变更导致的下游系统影响）]<br/>
   **受影响组件**: [直接依赖的类/方法/模块、间接关联的功能模块]<br/>
-  **影响描述**: [功能正确性影响、性能影响、兼容性影响（如API变更导致的下游系统影响）]<br/>
   **验证建议**: [如何验证是否存在此问题]
 </REPORT>

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "job51-gitlab-cr-node-skill-prompt-optimize",
-  "version": "1.3.5",
+  "version": "1.3.7",
   "description": "GitLab merge request code review tool with AI-powered analysis",
   "main": "index.js",
   "bin": {

package/print-div-pdf.html ADDED Viewed

@@ -0,0 +1,167 @@
+<!DOCTYPE html>
+<html lang="zh-CN">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>打印Div为PDF示例</title>
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/jspdf/2.5.1/jspdf.umd.min.js"></script>
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/html2canvas/1.4.1/html2canvas.min.js"></script>
+    <style>
+        body {
+            font-family: Arial, sans-serif;
+            padding: 20px;
+        }
+        #contentToPrint {
+            border: 2px solid #ccc;
+            padding: 20px;
+            margin: 20px 0;
+            background-color: #f9f9f9;
+            min-height: 300px;
+        }
+        button {
+            background-color: #4CAF50;
+            color: white;
+            padding: 10px 20px;
+            border: none;
+            cursor: pointer;
+            border-radius: 4px;
+            font-size: 16px;
+        }
+        button:hover {
+            background-color: #45a049;
+        }
+        h2 {
+            color: #333;
+        }
+        p {
+            line-height: 1.6;
+        }
+    </style>
+</head>
+<body>
+    <h1>打印Div为PDF示例</h1>
+    <button onclick="printDivToPDF()">打印指定区域为PDF</button>
+    <div id="contentToPrint">
+        <h2>这是一个要打印到PDF的区域</h2>
+        <p>这里是第一段内容。这是一些测试文本，用来展示如何将特定的div区域打印为PDF。</p>
+        <p>这里是第二段内容。可以看到我们有丰富的文本内容可以被转换成PDF。</p>
+        <ul>
+            <li>列表项 1</li>
+            <li>列表项 2</li>
+            <li>列表项 3</li>
+        </ul>
+        <p>最后的段落，展示更多内容。</p>
+    </div>
+    <div>
+        <p>这个区域不会被打印到PDF中，因为它不在目标div内。</p>
+    </div>
+    <script>
+        // 获取jsPDF实例
+        const { jsPDF } = window.jspdf;
+        function printDivToPDF() {
+            // 获取要打印的div元素
+            const element = document.getElementById('contentToPrint');
+            // 使用html2canvas将div转换为canvas
+            html2canvas(element, {
+                scale: 2, // 提高清晰度
+                useCORS: true, // 允许跨域图像
+                backgroundColor: '#ffffff' // 设置背景色
+            }).then(canvas => {
+                // 将canvas转换为数据URL
+                const imgData = canvas.toDataURL('image/png');
+                // 创建PDF
+                const pdf = new jsPDF('p', 'mm', 'a4');
+                // 计算图片在PDF中的尺寸以适应页面宽度
+                const imgWidth = 210; // A4页面宽度(mm)
+                const pageHeight = 295; // A4页面高度(mm)
+                const imgHeight = canvas.height * imgWidth / canvas.width;
+                let heightLeft = imgHeight;
+                let position = 0;
+                // 第一页添加图像
+                pdf.addImage(imgData, 'PNG', 0, position, imgWidth, imgHeight);
+                heightLeft -= pageHeight;
+                // 如果内容超过一页，则添加新页
+                while (heightLeft >= 0) {
+                    position = heightLeft - imgHeight;
+                    pdf.addPage();
+                    pdf.addImage(imgData, 'PNG', 0, position, imgWidth, imgHeight);
+                    heightLeft -= pageHeight;
+                }
+                // 保存PDF
+                pdf.save('div-content.pdf');
+            });
+        }
+        // 纯函数版本：将div转换为PDF的可重用函数
+        function divToPDF(divId, filename = 'output.pdf') {
+            return new Promise((resolve, reject) => {
+                const element = document.getElementById(divId);
+                if (!element) {
+                    reject(new Error(`Element with id '${divId}' not found`));
+                    return;
+                }
+                html2canvas(element, {
+                    scale: 2,
+                    useCORS: true,
+                    backgroundColor: '#ffffff'
+                }).then(canvas => {
+                    const imgData = canvas.toDataURL('image/png');
+                    const pdf = new jsPDF('p', 'mm', 'a4');
+                    const imgWidth = 210;
+                    const pageHeight = 295;
+                    const imgHeight = canvas.height * imgWidth / canvas.width;
+                    let heightLeft = imgHeight;
+                    let position = 0;
+                    pdf.addImage(imgData, 'PNG', 0, position, imgWidth, imgHeight);
+                    heightLeft -= pageHeight;
+                    while (heightLeft >= 0) {
+                        position = heightLeft - imgHeight;
+                        pdf.addPage();
+                        pdf.addImage(imgData, 'PNG', 0, position, imgWidth, imgHeight);
+                        heightLeft -= pageHeight;
+                    }
+                    pdf.save(filename);
+                    resolve(pdf);
+                }).catch(error => {
+                    reject(error);
+                });
+            });
+        }
+        // 示例：使用纯函数版本
+        function printWithFunction() {
+            divToPDF('contentToPrint', 'my-document.pdf')
+                .then(() => {
+                    console.log('PDF已成功生成');
+                })
+                .catch(error => {
+                    console.error('生成PDF时出错:', error);
+                });
+        }
+    </script>
+</body>
+</html>

package/refactor(ci)_ /346/233/264/346/226/260GitLab CI/351/205/215/347/275/256/345/271/266/344/274/230/345/214/226/347/253/236/344/272/211/345/210/206/346/236/220/346/227/245/345/277/227/346/234/215/345/212/241 (!118) /302/267 Merge requests /302/267 51JobWeb _ dev-boot-test /302/267 GitLab.pdf ADDED Viewed

Binary file