g2log 1.3.0 → 1.4.1

package/README.md

@@ -1,4 +1,4 @@
-# Git 用户日志工具
+# AI-Git 用户日报生成工具
 
 这是一个基于 Node.js 开发的命令行工具，用于获取指定用户在特定时间范围内的 Git 提交记录，并通过 AI 自动生成工作总结。
 
@@ -66,13 +66,20 @@ npx g2log [--since="2023-01-01"] [--until="2023-12-31"] [选项]
 
 ### 命令行参数
 
+时间参数:
 - `--since="YYYY-MM-DD"` - 起始日期（如未指定，使用配置中的默认值）
 - `--until="YYYY-MM-DD"` - 结束日期（如未指定，使用配置中的默认值）
-- `--local` - 使用本地仓库，忽略配置文件中的仓库设置
-- `--output="文件路径"` - 将输出保存到指定文件
+- `--days=N` - 查询最近N天的记录
 
-### 配置管理命令
+显示设置:
+- `--no-color` - 禁用彩色输出
+- `--save` 或 `--output="文件路径"` - 将输出保存到文件
+- `--debug` - 显示调试信息
+- `--show-prompt` - 显示完整的prompt内容
+- `--version` - 显示当前版本号
 
+配置管理命令:
+- `--config` - 启动交互式配置向导
 - `--set-api-key="KEY"` - 设置API密钥
 - `--set-ai-model="MODEL"` - 设置AI模型（默认: deepseek-chat）
 - `--set-api-provider="PROVIDER"` - 设置API提供商（deepseek或openai）
@@ -85,6 +92,7 @@ npx g2log [--since="2023-01-01"] [--until="2023-12-31"] [选项]
 - `--set-prompt-template="file.txt"` - 从文件设置AI总结的prompt模板
 - `--reset-prompt-template` - 重置AI总结的prompt模板为默认值
 - `--fix-config` - 修复配置文件格式问题
+- `--uninstall` - 删除g2log配置文件
 - `--help` - 显示帮助信息
 
 ### 配置文件
@@ -95,7 +103,7 @@ npx g2log [--since="2023-01-01"] [--until="2023-12-31"] [选项]
 {
   "api_key": "your-api-key-here",
   "default_author": "张三",
-  "default_since": "today",
+  "default_since": "7 days ago",
   "default_until": "today",
   "model": "deepseek-chat",
   "api_base_url": "https://api.deepseek.com",
@@ -104,7 +112,7 @@ npx g2log [--since="2023-01-01"] [--until="2023-12-31"] [选项]
     "前端": "/path/to/frontend-project",
     "后端": "/path/to/backend-project"
   },
-  "prompt_template": "请根据下面的Git提交记录，用3-5句话简洁地总结一天的工作内容..."
+  "prompt_template": "请根据下面的Git提交记录，用3-5句话简洁地总结一天的工作内容。\n\n以下是Git提交记录:\n\n{{GIT_LOGS}}\n\n要求：\n1. 按项目和日期组织内容\n2. 每个项目每天的工作内容用3-5句话概括\n3. 使用清晰、专业但不晦涩的语言\n4. 突出重要的功能开发、问题修复和优化改进\n5. 适合放入工作日报的简洁描述\n6. 输出格式为：【日期】：\n                  【项目名称】- 【工作内容概述】\n                  【项目名称】- 【工作内容概述】\n7. 回复不要出现多余的内容，非必要不要用markdown格式"
 }
 ```
 

package/git-user-log.js

@@ -17,6 +17,7 @@ const fs = require('fs');
 const https = require('https');
 const os = require('os');
 const readline = require('readline');
+const ora = require('ora');
 
 // 检测是否通过npx运行
 const isRunningWithNpx = process.env.npm_lifecycle_event === 'npx' || 
@@ -375,62 +376,41 @@ function fixConfigFile() {
 // 显示帮助
 function showHelp() {
   console.log(`
-${colorize('✨ 获取指定用户和时间范围的Git日志 ✨', 'bright')}
-
-${colorize('📋 使用方法:', 'yellow')} 
-  g2log [--since="2023-01-01"] [--until="2023-12-31"] [选项]
-
-${colorize('🕒 时间参数:', 'green')}
-  --since="YYYY-MM-DD"     起始日期 (如未指定，使用配置文件中的默认值)
-  --until="YYYY-MM-DD"     结束日期 (如未指定，使用配置文件中的默认值)
-  --local                  使用本地仓库，忽略配置文件中的仓库设置
-
-${colorize('🎨 显示设置:', 'blue')}
-  --color, --force-color   强制启用彩色输出 (即使在管道或重定向中)
-  --no-color               禁用彩色输出
-  --nosave                 不保存到文件 (仅在终端显示)
-  --save="file.txt"        保存结果到指定文件
-  --debug, --show-prompt   显示发送给AI的完整提示内容
-
-${colorize('⚙️ 配置管理:', 'magenta')}
-  --config                 启动交互式配置向导
-  --skip-config-check      跳过配置检查
-  --set-api-key="KEY"      设置API密钥
-  --set-api-provider="PROVIDER"  设置API提供商 (deepseek或openai)
-  --set-api-url="URL"      设置API基础URL
-  --set-ai-model="MODEL"   设置AI模型 (默认: deepseek-chat，可选: deepseek-reasoner)
-  --set-default-author="NAME"  设置默认作者
-  --set-time-range --since="DATE" --until="DATE"  设置默认时间范围
-  --add-repo="ALIAS" --path="/path/to/repo"  添加仓库配置
-  --remove-repo="ALIAS"    删除仓库配置
-  --list-repos             列出所有配置的仓库
-  --set-prompt-template="file.txt"  从文件设置AI总结的prompt模板
-  --reset-prompt-template  重置AI总结的prompt模板为默认值
-  --fix-config             修复配置文件格式问题
-  --help                   显示帮助信息
-
-${colorize('📝 示例:', 'cyan')}
-  # 使用配置的默认值生成今日工作总结 (处理配置中的所有仓库)
-  g2log
-  
-  # 指定时间范围
-  g2log --since="2023-01-01" --until="2023-12-31"
-  
-  # 使用本地仓库
-  g2log --local
-  
-  # 强制启用颜色显示（在使用管道或重定向时有用）
-  g2log --color | less -R
-  
-  # 启动交互式配置向导
+使用方法: g2log [选项]
+
+时间参数:
+  --since <date>          开始日期 (默认: 7天前)
+  --until <date>          结束日期 (默认: 今天)
+  --days <number>         查询最近n天的记录 (默认: 7)
+
+显示设置:
+  --no-color             禁用彩色输出
+  --save                 保存结果到文件
+  --debug                显示调试信息
+  --show-prompt          显示完整的prompt内容
+  --version              显示当前版本号
+
+配置管理:
+  --config               启动交互式配置向导
+  --set-api-key         设置API密钥
+  --set-api-provider     设置API提供商 (OpenAI/DeepSeek)
+  --set-api-base-url     设置API基础URL
+  --set-ai-model         设置AI模型
+  --set-default-author   设置默认作者
+  --add-repo            添加仓库配置
+  --remove-repo         移除仓库配置
+  --list-repos          列出所有配置的仓库
+  --uninstall           删除g2log配置文件 (~/.git-user-log-config.json)
+
+示例:
+  g2log --since "2024-01-01" --until "2024-01-31"
+  g2log --days 30
   g2log --config
-  
-  # 设置配置
-  g2log --set-default-author="张三"
-  g2log --set-ai-model="deepseek-reasoner"
-  g2log --set-api-provider="openai"
-  g2log --set-api-url="https://api.openai.com"
-  g2log --add-repo="frontend" --path="/path/to/frontend-project"
+  g2log --set-api-key "your-api-key"
+  g2log --add-repo "alias" "path/to/repo"
+  g2log --remove-repo "alias"
+  g2log --list-repos
+  g2log --version
 `);
   process.exit(0);
 }
@@ -804,54 +784,54 @@ async function getOpenAIResponse(apiKey, prompt, modelName, apiBaseURL, spinner
       
       // 确定使用http还是https
       const protocol = urlObj.protocol === 'https:' ? require('https') : require('http');
-      
-      // 创建请求
-      const req = protocol.request(options, (res) => {
+    
+    // 创建请求
+    const req = protocol.request(options, (res) => {
         // 检查状态码
-        if (res.statusCode !== 200) {
-          let errorData = '';
-          res.on('data', chunk => {
-            errorData += chunk.toString();
-          });
-          res.on('end', () => {
+      if (res.statusCode !== 200) {
+        let errorData = '';
+        res.on('data', chunk => {
+          errorData += chunk.toString();
+        });
+        res.on('end', () => {
             let errorMessage = `OpenAI API请求失败 (${res.statusCode})`;
-            try {
-              const parsedError = JSON.parse(errorData);
+          try {
+            const parsedError = JSON.parse(errorData);
               errorMessage += `: ${JSON.stringify(parsedError)}`;
-            } catch (e) {
+          } catch (e) {
               errorMessage += `: ${errorData}`;
             }
             if (spinner) spinner.fail(`❌ ${errorMessage}`);
             reject(new Error(errorMessage));
-          });
-          return;
-        }
-        
+        });
+        return;
+      }
+      
         let fullContent = '';
-        let buffer = '';
-        
+      let buffer = '';
+      
         // 处理数据
-        res.on('data', (chunk) => {
-          // 将新的数据添加到缓冲区
-          buffer += chunk.toString();
+      res.on('data', (chunk) => {
+        // 将新的数据添加到缓冲区
+        buffer += chunk.toString();
+        
+        // 尝试从缓冲区中提取完整的SSE消息
+        let match;
+        const dataRegex = /data: (.*?)\n\n/gs;
+        
+        while ((match = dataRegex.exec(buffer)) !== null) {
+          const data = match[1];
           
-          // 尝试从缓冲区中提取完整的SSE消息
-          let match;
-          const dataRegex = /data: (.*?)\n\n/gs;
+          // 跳过 [DONE] 消息
+          if (data === '[DONE]') continue;
           
-          while ((match = dataRegex.exec(buffer)) !== null) {
-            const data = match[1];
+          try {
+            const parsedData = JSON.parse(data);
             
-            // 跳过 [DONE] 消息
-            if (data === '[DONE]') continue;
-            
-            try {
-              const parsedData = JSON.parse(data);
-              
               // 获取内容增量
               if (parsedData.choices && 
-                  parsedData.choices[0] && 
-                  parsedData.choices[0].delta && 
+                parsedData.choices[0] && 
+                parsedData.choices[0].delta && 
                   parsedData.choices[0].delta.content) {
                 const content = parsedData.choices[0].delta.content;
                 fullContent += content;
@@ -1002,27 +982,27 @@ async function getDeepSeekResponse(apiKey, prompt, modelName, apiBaseURL, spinne
                 
                 // 直接输出内容增量到控制台
                 process.stdout.write(content);
-              }
-            } catch (err) {
-              // 忽略解析错误
             }
+          } catch (err) {
+            // 忽略解析错误
           }
-          
-          // 保留可能不完整的最后一部分
-          const lastIndex = buffer.lastIndexOf('\n\n');
-          if (lastIndex !== -1) {
-            buffer = buffer.substring(lastIndex + 2);
-          }
-        });
+        }
         
+        // 保留可能不完整的最后一部分
+        const lastIndex = buffer.lastIndexOf('\n\n');
+        if (lastIndex !== -1) {
+          buffer = buffer.substring(lastIndex + 2);
+        }
+      });
+      
         // 处理结束
-        res.on('end', () => {
-          if (spinner) spinner.stop('✅ DeepSeek响应已接收');
+      res.on('end', () => {
+          if (spinner) spinner.stop('✅ AI响应已接收');
           console.log(); // 添加换行符
           resolve(fullContent);
-        });
       });
-      
+    });
+    
       // 处理请求错误
       req.on('error', (error) => {
         if (spinner) spinner.fail(`❌ DeepSeek API网络错误: ${error.message}`);
@@ -1031,7 +1011,7 @@ async function getDeepSeekResponse(apiKey, prompt, modelName, apiBaseURL, spinne
       
       // 发送请求体
       req.write(JSON.stringify(data));
-      req.end();
+    req.end();
     } catch (error) {
       if (spinner) spinner.fail(`❌ DeepSeek API错误: ${error.message}`);
       reject(error);
@@ -1314,9 +1294,10 @@ async function setupConfigInteractive() {
 
     // 步骤1: 设置API提供商
     console.log(colorize('\n📡 步骤1: 设置API提供商', 'yellow'));
+    console.log(colorize('  (仅作为一个备注,示例：openai, deepseek, xxx)', 'cyan'));
     let apiProvider = config.api_provider || '';
     
-    const providerInput = await question(colorize(`  请选择API提供商 [${apiProvider ? apiProvider : 'OpenAI/DeepSeek'}]: `, 'green'));
+    const providerInput = await question(colorize(`  请选择API提供商 [${apiProvider ? apiProvider : 'openai'}]: `, 'green'));
     if (providerInput.trim() !== '') {
       apiProvider = providerInput.trim();
     } else if (apiProvider === '') {
@@ -1329,6 +1310,7 @@ async function setupConfigInteractive() {
 
     // 步骤2: 设置API基础URL
     console.log(colorize('\n🔗 步骤2: 设置API基础URL', 'yellow'));
+    console.log(colorize('  (示例: https://api.openai.com, https://api.deepseek.com 或其他API服务地址)', 'cyan'));
     
     // 根据提供商设置默认值
     let defaultBaseURL = config.api_base_url || '';
@@ -1347,6 +1329,12 @@ async function setupConfigInteractive() {
     // 步骤3: 设置AI模型
     console.log(colorize('\n🤖 步骤3: 设置AI模型', 'yellow'));
     
+    // 根据提供商显示不同的模型示例
+    const modelExamples = config.api_provider === 'openai' ? 
+      'gpt-3.5-turbo, gpt-4, gpt-4-turbo' : 
+      'deepseek-chat, deepseek-coder, deepseek-v3';
+    console.log(colorize(`  (常用模型示例: ${modelExamples})`, 'cyan'));
+    
     // 根据提供商设置默认模型
     let defaultModel = config.ai_model || '';
     if (!defaultModel) {
@@ -1363,6 +1351,7 @@ async function setupConfigInteractive() {
 
     // 步骤4: 设置API密钥
     console.log(colorize('\n🔑 步骤4: 设置API密钥', 'yellow'));
+    console.log(colorize('  (格式示例: sk-abcdefg123456789... 密钥会安全存储在本地配置文件中)', 'cyan'));
     const existingKey = config.api_key || '';
     const keyInput = await question(colorize(`  请输入API密钥${existingKey ? ' [已配置，按Enter保留]' : ''}: `, 'green'));
     if (keyInput.trim() !== '') {
@@ -1376,6 +1365,7 @@ async function setupConfigInteractive() {
 
     // 步骤5: 设置默认作者
     console.log(colorize('\n👤 步骤5: 设置默认作者', 'yellow'));
+    console.log(colorize('  (示例: 张三, user@example.com, 或Git提交时使用的用户名)', 'cyan'));
     const existingAuthor = config.default_author || '';
     const authorInput = await question(colorize(`  请输入默认作者名称 [${existingAuthor}]: `, 'green'));
     config.default_author = authorInput.trim() || existingAuthor;
@@ -1383,6 +1373,7 @@ async function setupConfigInteractive() {
 
     // 步骤6: 设置默认时间范围（可选）
     console.log(colorize('\n🕒 步骤6: 设置默认时间范围（可选）', 'yellow'));
+    console.log(colorize('  (支持格式: "7 days ago", "1 week ago", "yesterday", "2023-01-01", "last monday")', 'cyan'));
     
     // 获取当前的默认值
     const defaultSince = config.default_since || '7 days ago';
@@ -1398,6 +1389,13 @@ async function setupConfigInteractive() {
 
     // 步骤7: 仓库配置（可选）
     console.log(colorize('\n📂 步骤7: 仓库配置（可选）', 'yellow'));
+    console.log(colorize('  (仓库别名示例: frontend, backend, main-project)', 'cyan'));
+    
+    // 根据操作系统提供路径示例
+    const repoPathExample = process.platform === 'win32' ? 
+      'C:\\项目\\前端仓库' : 
+      '/Users/用户名/projects/前端仓库';
+    console.log(colorize(`  (仓库路径示例: ${repoPathExample})`, 'cyan'));
     
     // 显示当前配置的仓库
     const repos = config.repositories || {};
@@ -1423,7 +1421,8 @@ async function setupConfigInteractive() {
           continue;
         }
         
-        // 获取仓库路径
+        // 获取仓库路径，添加示例提示
+        console.log(colorize(`  (请输入Git仓库的绝对路径，示例: ${repoPathExample})`, 'cyan'));
         const repoPath = await question(colorize('  请输入仓库路径（绝对路径）: ', 'green'));
         if (!repoPath.trim()) {
           console.log(colorize('  ❌ 仓库路径不能为空', 'red'));
@@ -1468,15 +1467,35 @@ async function setupConfigInteractive() {
 
 // 主函数
 async function getGitLogs() {
+  const args = parseArgs();
+
+  // 显示帮助信息
+  if (args['help']) {
+    showHelp();
+    return;
+  }
+
+  // 显示版本信息
+  if (args['version']) {
+    const packageJson = require('./package.json');
+    console.log(`g2log version ${packageJson.version}`);
+    return;
+  }
+
+  // 删除配置文件
+  if (args['uninstall']) {
+    const spinner = ora('正在删除配置文件...').start();
+    const success = removeConfigFile();
+    if (success) {
+      spinner.succeed('配置文件已删除，如需完全卸载请运行: npm uninstall -g g2log');
+    } else {
+      spinner.fail('配置文件删除失败，可能文件不存在或无权限访问');
+    }
+    return;
+  }
+
   try {
     const spinner = createSpinner();
-    const args = parseArgs();
-    
-    // 显示帮助信息
-    if (args.help) {
-      showHelp();
-      return;
-    }
     
     // 检查是否要显示自定义配置向导
     if (args.config) {
@@ -1489,7 +1508,7 @@ async function getGitLogs() {
     if (!args['set-api-key'] && !args['set-default-author'] && !args['add-repo'] && 
         !args['fix-config'] && !args['remove-repo'] && !args['list-repos'] && 
         !args['set-prompt-template'] && !args['reset-prompt-template'] &&
-        !args['skip-config-check']) {
+        !args['skip-config-check'] && !args['uninstall']) {
       
       // 检查配置状态
       const configStatus = checkConfig();
@@ -1814,4 +1833,45 @@ getGitLogs();
 //   .then(() => console.log('配置测试已完成'));
 
 // 如果需要测试checkConfig（需要注释掉主函数调用）
-// console.log(checkConfig());
+// console.log(checkConfig());
+
+// 重置prompt模板为默认值
+function resetPromptTemplate() {
+  try {
+    const config = loadConfig();
+    if (config.prompt_template) {
+      delete config.prompt_template;
+      return saveConfig(config);
+    }
+    return true; // 如果没有设置自定义模板，则视为重置成功
+  } catch (error) {
+    console.error(`❌ 重置prompt模板失败: ${error.message}`);
+    return false;
+  }
+}
+
+// 删除配置文件
+function removeConfigFile() {
+  try {
+    if (fs.existsSync(CONFIG_PATH)) {
+      fs.unlinkSync(CONFIG_PATH);
+      return true;
+    }
+    return false; // 文件不存在
+  } catch (error) {
+    console.error(`❌ 删除配置文件失败: ${error.message}`);
+    return false;
+  }
+}
+
+// 设置API提供商
+function setAPIProvider(provider) {
+  try {
+    const config = loadConfig();
+    config.api_provider = provider;
+    return saveConfig(config);
+  } catch (error) {
+    console.error(`❌ 设置API提供商失败: ${error.message}`);
+    return false;
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "g2log",
-  "version": "1.3.0",
+  "version": "1.4.1",
   "description": "查询特定用户和时间范围的Git提交记录并通过AI进行总结，可通过npx直接运行",
   "main": "git-user-log.js",
   "bin": {
@@ -35,5 +35,7 @@
     "url": "https://github.com/chenxiangcai/git-user-log/issues"
   },
   "homepage": "https://github.com/chenxiangcai/git-user-log#readme",
-  "dependencies": {}
+  "dependencies": {
+    "ora": "^8.2.0"
+  }
 }