@jojonax/codex-copilot 1.0.1 → 1.0.3

package/src/utils/detect-prd.js

@@ -1,13 +1,13 @@
 /**
- * PRD 自动检测模块
- * 在项目目录中自动查找 PRD 文档
+ * PRD auto-detection module
+ * Automatically finds PRD documents in the project directory
  */
 
 import { readdirSync, readFileSync, statSync } from 'fs';
-import { resolve, extname } from 'path';
+import { resolve, extname, relative } from 'path';
 import { log } from './logger.js';
 
-// PRD 文件名匹配模式（优先级由高到低）
+// PRD filename patterns (ordered by priority, highest first)
 const PRD_PATTERNS = [
   /prd/i,
   /product.?requirement/i,
@@ -18,9 +18,9 @@ const PRD_PATTERNS = [
   /spec/i,
 ];
 
-// 搜索目录（按优先级）
+// Directories to search (ordered by priority)
 const SEARCH_DIRS = [
-  '.',           // 项目根目录
+  '.',           // Project root
   'docs',
   'doc',
   'PRD',
@@ -30,16 +30,16 @@ const SEARCH_DIRS = [
   '文档',
 ];
 
-// 忽略目录
+// Directories to ignore
 const IGNORE_DIRS = new Set([
   'node_modules', '.git', '.next', 'dist', 'build', 'vendor',
   '.codex-copilot', '.vscode', '.idea', '__pycache__', 'coverage',
 ]);
 
 /**
- * 自动检测当前项目中的 PRD 文件
- * @param {string} projectDir - 项目根目录
- * @returns {Array<{path: string, score: number, name: string}>} 候选 PRD 文件列表（按匹配度排序）
+ * Auto-detect PRD files in the project
+ * @param {string} projectDir - Project root directory
+ * @returns {Array<{path: string, score: number, name: string}>} Candidate PRD files sorted by match score
  */
 export function detectPRD(projectDir) {
   const candidates = [];
@@ -55,14 +55,14 @@ export function detectPRD(projectDir) {
     scanDir(searchPath, projectDir, candidates, 0);
   }
 
-  // 按匹配度排序
+  // Sort by match score (descending)
   candidates.sort((a, b) => b.score - a.score);
 
   return candidates;
 }
 
 function scanDir(dir, projectDir, candidates, depth) {
-  if (depth > 3) return; // 最多搜索 3 层
+  if (depth > 3) return; // Max 3 levels deep
 
   let entries;
   try {
@@ -81,15 +81,15 @@ function scanDir(dir, projectDir, candidates, depth) {
       continue;
     }
 
-    // 只搜索 markdown 文件
+    // Only scan markdown files
     if (extname(entry.name).toLowerCase() !== '.md') continue;
 
-    // 计算匹配分数
+    // Calculate match score
     const score = scorePRDMatch(entry.name, fullPath);
     if (score > 0) {
       candidates.push({
         path: fullPath,
-        relativePath: fullPath.replace(projectDir + '/', ''),
+        relativePath: relative(projectDir, fullPath),
         name: entry.name,
         score,
       });
@@ -101,21 +101,21 @@ function scorePRDMatch(filename, fullPath) {
   let score = 0;
   const lower = filename.toLowerCase();
 
-  // 文件名匹配
+  // Filename pattern matching
   for (let i = 0; i < PRD_PATTERNS.length; i++) {
     if (PRD_PATTERNS[i].test(filename)) {
-      score += (PRD_PATTERNS.length - i) * 10; // 越靠前的模式分数越高
+      score += (PRD_PATTERNS.length - i) * 10; // Higher priority patterns get higher scores
     }
   }
 
-  // 文件大小加分（PRD 通常内容较多）
+  // File size bonus (PRDs are typically longer)
   try {
     const stat = statSync(fullPath);
     if (stat.size > 5000) score += 5;   // > 5KB
     if (stat.size > 20000) score += 5;  // > 20KB
   } catch {}
 
-  // 内容采样检测（读前 2000 字符）
+  // Content sampling (read first 2000 chars)
   if (score > 0) {
     try {
       const content = readFileSync(fullPath, 'utf-8').slice(0, 2000);
@@ -130,7 +130,7 @@ function scorePRDMatch(filename, fullPath) {
 }
 
 /**
- * 读取 PRD 文件内容
+ * Read PRD file content
  */
 export function readPRD(prdPath) {
   return readFileSync(prdPath, 'utf-8');

package/src/utils/git.js

@@ -1,5 +1,5 @@
 /**
- * Git 操作工具模块
+ * Git operations utility module
  */
 
 import { execSync } from 'child_process';
@@ -17,8 +17,17 @@ function execSafe(cmd, cwd) {
   }
 }
 
+// Validate branch name to prevent shell injection
+function validateBranch(name) {
+  if (!name || typeof name !== 'string') throw new Error('Branch name cannot be empty');
+  if (/[;&|`$(){}[\]!\\<>"'\s]/.test(name)) {
+    throw new Error(`Branch name contains unsafe characters: ${name}`);
+  }
+  return name;
+}
+
 /**
- * 检查 git 仓库是否干净
+ * Check if the git working tree is clean
  */
 export function isClean(cwd) {
   const result = exec('git status --porcelain', cwd);
@@ -26,35 +35,37 @@ export function isClean(cwd) {
 }
 
 /**
- * 获取当前分支名
+ * Get current branch name
  */
 export function currentBranch(cwd) {
   return exec('git branch --show-current', cwd);
 }
 
 /**
- * 获取 remote 的 owner/repo
+ * Get remote owner/repo info
  */
 export function getRepoInfo(cwd) {
   const url = exec('git remote get-url origin', cwd);
-  // 支持 https://github.com/owner/repo.git 和 git@github.com:owner/repo.git
+  // Supports https://github.com/owner/repo.git and git@github.com:owner/repo.git
   const match = url.match(/github\.com[:/](.+?)\/(.+?)(?:\.git)?$/);
-  if (!match) throw new Error(`无法解析 GitHub 仓库地址: ${url}`);
+  if (!match) throw new Error(`Cannot parse GitHub repository URL: ${url}`);
   return { owner: match[1], repo: match[2] };
 }
 
 /**
- * 切换到目标分支（如不存在则创建）
+ * Switch to target branch (create if not exists)
  */
 export function checkoutBranch(cwd, branch, baseBranch = 'main') {
+  validateBranch(branch);
+  validateBranch(baseBranch);
   const current = currentBranch(cwd);
   if (current === branch) return;
 
-  // 先切到 base 并拉取最新
+  // Switch to base and pull latest
   execSafe(`git checkout ${baseBranch}`, cwd);
   execSafe(`git pull origin ${baseBranch}`, cwd);
 
-  // 尝试切换，不存在则创建
+  // Try to switch, create if not exists
   const result = execSafe(`git checkout ${branch}`, cwd);
   if (!result.ok) {
     exec(`git checkout -b ${branch}`, cwd);
@@ -62,13 +73,13 @@ export function checkoutBranch(cwd, branch, baseBranch = 'main') {
 }
 
 /**
- * 提交所有变更
+ * Commit all changes
  */
 export function commitAll(cwd, message) {
   exec('git add -A', cwd);
   const result = execSafe(`git diff --cached --quiet`, cwd);
   if (result.ok) {
-    log.dim('没有变更需要提交');
+    log.dim('No changes to commit');
     return false;
   }
   exec(`git commit -m ${shellEscape(message)}`, cwd);
@@ -80,16 +91,18 @@ function shellEscape(str) {
 }
 
 /**
- * 推送分支
+ * Push branch to remote
  */
 export function pushBranch(cwd, branch) {
+  validateBranch(branch);
   exec(`git push origin ${branch} --force-with-lease`, cwd);
 }
 
 /**
- * 切回主分支
+ * Switch back to main branch
  */
 export function checkoutMain(cwd, baseBranch = 'main') {
+  validateBranch(baseBranch);
   execSafe(`git checkout ${baseBranch}`, cwd);
 }
 

package/src/utils/github.js

@@ -1,5 +1,5 @@
 /**
- * GitHub 操作模块 - 通过 gh CLI 操作 PR 和 Review
+ * GitHub operations module - PR and Review management via gh CLI
  */
 
 import { execSync } from 'child_process';
@@ -11,7 +11,12 @@ function gh(cmd, cwd) {
 
 function ghJSON(cmd, cwd) {
   const output = gh(cmd, cwd);
-  return output ? JSON.parse(output) : null;
+  if (!output) return null;
+  try {
+    return JSON.parse(output);
+  } catch {
+    return null;
+  }
 }
 
 function shellEscape(str) {
@@ -19,7 +24,7 @@ function shellEscape(str) {
 }
 
 /**
- * 检查 gh CLI 是否登录
+ * Check if gh CLI is authenticated
  */
 export function checkGhAuth() {
   try {
@@ -31,68 +36,71 @@ export function checkGhAuth() {
 }
 
 /**
- * 创建 PR
+ * Create a pull request
  */
 export function createPR(cwd, { title, body, base = 'main', head }) {
   const output = gh(
-    `pr create --title ${shellEscape(title)} --body ${shellEscape(body)} --base ${base} --head ${head}`,
+    `pr create --title ${shellEscape(title)} --body ${shellEscape(body)} --base ${shellEscape(base)} --head ${shellEscape(head)}`,
     cwd
   );
-  // 从输出中提取 PR URL 和编号
+  // Extract PR URL and number from output
   const urlMatch = output.match(/https:\/\/github\.com\/.+\/pull\/(\d+)/);
   if (urlMatch) {
     return { url: urlMatch[0], number: parseInt(urlMatch[1]) };
   }
-  // 如果已存在
+  // May already exist
   const existingMatch = output.match(/already exists.+\/pull\/(\d+)/);
   if (existingMatch) {
     return { url: output, number: parseInt(existingMatch[1]) };
   }
-  throw new Error(`创建 PR 失败: ${output}`);
+  throw new Error(`Failed to create PR: ${output}`);
 }
 
 /**
- * 获取 PR 的 Review 列表
+ * Get PR review list
  */
 export function getReviews(cwd, prNumber) {
   try {
-    return ghJSON(`api repos/{owner}/{repo}/pulls/${prNumber}/reviews`, cwd) || [];
+    const num = validatePRNumber(prNumber);
+    return ghJSON(`api repos/{owner}/{repo}/pulls/${num}/reviews`, cwd) || [];
   } catch {
     return [];
   }
 }
 
 /**
- * 获取 PR 的 Review 评论
+ * Get PR review comments
  */
 export function getReviewComments(cwd, prNumber) {
   try {
-    return ghJSON(`api repos/{owner}/{repo}/pulls/${prNumber}/comments`, cwd) || [];
+    const num = validatePRNumber(prNumber);
+    return ghJSON(`api repos/{owner}/{repo}/pulls/${num}/comments`, cwd) || [];
   } catch {
     return [];
   }
 }
 
 /**
- * 获取 PR 的 issue 评论（包含 bot 评论）
+ * Get PR issue comments (including bot comments)
  */
 export function getIssueComments(cwd, prNumber) {
   try {
-    return ghJSON(`api repos/{owner}/{repo}/issues/${prNumber}/comments`, cwd) || [];
+    const num = validatePRNumber(prNumber);
+    return ghJSON(`api repos/{owner}/{repo}/issues/${num}/comments`, cwd) || [];
   } catch {
     return [];
   }
 }
 
 /**
- * 检查最新 Review 状态
+ * Check the latest review state
  * @returns {'APPROVED' | 'CHANGES_REQUESTED' | 'COMMENTED' | 'PENDING' | null}
  */
 export function getLatestReviewState(cwd, prNumber) {
   const reviews = getReviews(cwd, prNumber);
   if (!reviews || reviews.length === 0) return null;
 
-  // 过滤掉 PENDING 和 DISMISSED
+  // Filter out PENDING and DISMISSED
   const active = reviews.filter(r => r.state !== 'PENDING' && r.state !== 'DISMISSED');
   if (active.length === 0) return null;
 
@@ -100,14 +108,25 @@ export function getLatestReviewState(cwd, prNumber) {
 }
 
 /**
- * 合并 PR
+ * Merge a pull request
  */
 export function mergePR(cwd, prNumber, method = 'squash') {
-  gh(`pr merge ${prNumber} --${method} --delete-branch`, cwd);
+  const num = validatePRNumber(prNumber);
+  const validMethods = ['squash', 'merge', 'rebase'];
+  if (!validMethods.includes(method)) {
+    throw new Error(`Invalid merge method: ${method}`);
+  }
+  gh(`pr merge ${num} --${method} --delete-branch`, cwd);
+}
+
+function validatePRNumber(prNumber) {
+  const num = parseInt(prNumber, 10);
+  if (isNaN(num) || num <= 0) throw new Error(`Invalid PR number: ${prNumber}`);
+  return num;
 }
 
 /**
- * 收集所有 Review 意见为结构化文本
+ * Collect all review feedback as structured text
  */
 export function collectReviewFeedback(cwd, prNumber) {
   const reviews = getReviews(cwd, prNumber);
@@ -116,19 +135,19 @@ export function collectReviewFeedback(cwd, prNumber) {
 
   let feedback = '';
 
-  // Review 总评
+  // Review summary
   for (const r of reviews) {
     if (r.body && r.body.trim()) {
       feedback += `### Review (${r.state})\n${r.body}\n\n`;
     }
   }
 
-  // 行内评论
+  // Inline comments
   for (const c of comments) {
     feedback += `### ${c.path}:L${c.line || c.original_line}\n${c.body}\n\n`;
   }
 
-  // Bot 评论（Gemini Code Assist 等）
+  // Bot comments (Gemini Code Assist, etc.)
   for (const c of issueComments) {
     if (c.user?.type === 'Bot' || c.user?.login?.includes('bot')) {
       feedback += `### Bot Review (${c.user.login})\n${c.body}\n\n`;

package/src/utils/logger.js

@@ -1,35 +1,41 @@
 /**
- * Logger utility - 统一终端输出样式
+ * Logger utility - Unified terminal output styles
  */
 
 const COLORS = {
-  reset: '\x1b[0m',
   green: '\x1b[32m',
   yellow: '\x1b[33m',
   red: '\x1b[31m',
-  blue: '\x1b[34m',
   cyan: '\x1b[36m',
   dim: '\x1b[2m',
   bold: '\x1b[1m',
+  reset: '\x1b[0m',
 };
 
 export const log = {
-  info:  (msg) => console.log(`  ${COLORS.green}✔${COLORS.reset}  ${msg}`),
-  warn:  (msg) => console.log(`  ${COLORS.yellow}⚠${COLORS.reset}  ${msg}`),
-  error: (msg) => console.log(`  ${COLORS.red}✖${COLORS.reset}  ${msg}`),
-  step:  (msg) => console.log(`  ${COLORS.blue}▶${COLORS.reset}  ${msg}`),
-  dim:   (msg) => console.log(`  ${COLORS.dim}${msg}${COLORS.reset}`),
-  title: (msg) => console.log(`  ${COLORS.bold}${COLORS.cyan}${msg}${COLORS.reset}`),
-  blank: ()    => console.log(''),
+  info: (msg) => console.log(`  ${COLORS.green}✔${COLORS.reset}  ${msg}`),
+  warn: (msg) => console.log(`  ${COLORS.yellow}⚠${COLORS.reset}  ${msg}`),
+  error: (msg) => console.log(`  ${COLORS.red}✗${COLORS.reset}  ${msg}`),
+  step: (msg) => console.log(`  ${COLORS.cyan}▶${COLORS.reset}  ${msg}`),
+  dim: (msg) => console.log(`  ${COLORS.dim}${msg}${COLORS.reset}`),
+  title: (msg) => console.log(`  ${COLORS.bold}${msg}${COLORS.reset}`),
+  blank: () => console.log(''),
 };
 
 /**
- * 进度条显示
+ * Display a progress bar
  */
 export function progressBar(current, total, label = '') {
   const width = 30;
-  const filled = Math.round((current / total) * width);
+  if (total <= 0) {
+    const bar = '░'.repeat(width);
+    console.log(`  ${COLORS.cyan}[${bar}]${COLORS.reset} 0% ${label}`);
+    return;
+  }
+  const rawRatio = current / total;
+  const ratio = Number.isNaN(rawRatio) ? 0 : Math.max(0, Math.min(1, rawRatio));
+  const filled = Math.round(ratio * width);
   const bar = '█'.repeat(filled) + '░'.repeat(width - filled);
-  const pct = Math.round((current / total) * 100);
+  const pct = Math.round(ratio * 100);
   console.log(`  ${COLORS.cyan}[${bar}]${COLORS.reset} ${pct}% ${label}`);
 }

package/src/utils/prompt.js

@@ -1,5 +1,5 @@
 /**
- * 交互式终端工具
+ * Interactive terminal utilities
  */
 
 import { createInterface } from 'readline';
@@ -7,7 +7,7 @@ import { createInterface } from 'readline';
 const rl = createInterface({ input: process.stdin, output: process.stdout });
 
 /**
- * 提问并等待用户输入
+ * Ask a question and wait for user input
  */
 export function ask(question) {
   return new Promise((resolve) => {
@@ -18,7 +18,7 @@ export function ask(question) {
 }
 
 /**
- * 是/否确认
+ * Yes/No confirmation
  */
 export async function confirm(question, defaultYes = true) {
   const hint = defaultYes ? '(Y/n)' : '(y/N)';
@@ -28,21 +28,21 @@ export async function confirm(question, defaultYes = true) {
 }
 
 /**
- * 从列表中选择
+ * Select from a list
  */
 export async function select(question, choices) {
   console.log(`  ${question}`);
   for (let i = 0; i < choices.length; i++) {
     console.log(`    ${i + 1}. ${choices[i].label}`);
   }
-  const answer = await ask('请输入编号:');
+  const answer = await ask('Enter number:');
   const idx = parseInt(answer) - 1;
   if (idx >= 0 && idx < choices.length) return choices[idx];
-  return choices[0]; // 默认第一个
+  return choices[0]; // Default to first
 }
 
 /**
- * 关闭 readline
+ * Close readline interface
  */
 export function closePrompt() {
   rl.close();

package/src/utils/update-check.js

@@ -0,0 +1,103 @@
+/**
+ * Version update checker
+ * 
+ * - Checks npm registry for latest version on startup
+ * - 24h cache to avoid frequent network requests
+ * - Prints update prompt if a newer version is available
+ */
+
+import { execSync } from 'child_process';
+import { readFileSync, writeFileSync, mkdirSync } from 'fs';
+import { resolve } from 'path';
+import { homedir } from 'os';
+import { log } from './logger.js';
+
+const PACKAGE_NAME = '@jojonax/codex-copilot';
+const CACHE_FILE = resolve(homedir(), '.codex-copilot-update-cache.json');
+const CACHE_TTL = 24 * 60 * 60 * 1000; // 24 hours
+
+/**
+ * Read cached version info
+ */
+function readCache() {
+  try {
+    const data = JSON.parse(readFileSync(CACHE_FILE, 'utf-8'));
+    if (Date.now() - data.timestamp < CACHE_TTL) {
+      return data.latestVersion;
+    }
+  } catch {
+    // Cache miss or corrupt — ignore
+  }
+  return null;
+}
+
+/**
+ * Write version info to cache
+ */
+function writeCache(latestVersion) {
+  try {
+    writeFileSync(CACHE_FILE, JSON.stringify({
+      latestVersion,
+      timestamp: Date.now(),
+    }));
+  } catch {
+    // Permission error — ignore silently
+  }
+}
+
+/**
+ * Fetch latest version from npm registry
+ */
+function fetchLatestVersion() {
+  try {
+    const output = execSync(`npm view ${PACKAGE_NAME} version`, {
+      encoding: 'utf-8',
+      stdio: ['pipe', 'pipe', 'pipe'],
+      timeout: 5000, // 5s timeout
+    }).trim();
+    return output || null;
+  } catch {
+    // Network error, npm not available — ignore
+    return null;
+  }
+}
+
+/**
+ * Compare semantic version strings
+ * @returns {boolean} true if latest > current
+ */
+function isNewer(current, latest) {
+  if (!current || !latest) return false;
+  const c = current.split('.').map(Number);
+  const l = latest.split('.').map(Number);
+  for (let i = 0; i < 3; i++) {
+    if ((l[i] || 0) > (c[i] || 0)) return true;
+    if ((l[i] || 0) < (c[i] || 0)) return false;
+  }
+  return false;
+}
+
+/**
+ * Check for updates and print notification
+ * @param {string} currentVersion - Current installed version
+ */
+export function checkForUpdates(currentVersion) {
+  // 1. Check cache first
+  let latest = readCache();
+
+  // 2. Cache miss → fetch from npm
+  if (!latest) {
+    latest = fetchLatestVersion();
+    if (latest) {
+      writeCache(latest);
+    }
+  }
+
+  // 3. Compare and notify
+  if (latest && isNewer(currentVersion, latest)) {
+    log.blank();
+    log.warn(`Update available: v${currentVersion} → v${latest}`);
+    log.dim(`  Run the following command to update:`);
+    log.dim(`  npm install -g ${PACKAGE_NAME}@${latest}`);
+  }
+}