@shiplens/cli 1.3.0 → 1.4.0

package/lib/injector.js

@@ -95,7 +95,7 @@ function detectProject(dir = process.cwd()) {
     }
   }
 
-  // Extract description fallback from README if missing
+  // 若无 description，尝试从 README.md 提取第一段有效文本
   if (!result.description) {
     const readmeCandidates = ['README.md', 'readme.md', 'README.MD'];
     for (const r of readmeCandidates) {
@@ -113,7 +113,7 @@ function detectProject(dir = process.cwd()) {
     }
   }
 
-  // 4-level taxonomy inference
+  // 4 级分类自动推断
   const taxonomy = inferTaxonomy({
     name: result.project_name,
     description: result.description,
@@ -286,7 +286,7 @@ function injectCRA(dir, appId) {
       if (content.includes('@shiplens/sdk') || content.includes('initShiplens') || content.includes(appId)) {
         return cand;
       }
-      const injection = `\n// Shiplens SDK - User Analytics\nconst { initShiplens } = require('@shiplens/sdk');\ninitShiplens({ appId: '${appId}' });\n`;
+      const injection = `\n// Shiplens SDK - 用户行为数据采集\nconst { initShiplens } = require('@shiplens/sdk');\ninitShiplens({ appId: '${appId}' });\n`;
       fs.writeFileSync(p, content + injection, 'utf8');
       return cand;
     }
@@ -351,7 +351,7 @@ async function installSDKDependency(dir, pkgManager = 'npm') {
   const sources = [
     {
       id: 'npmjs',
-      name: 'npm registry',
+      name: 'NPM 官方源 (npm registry)',
       getCommand: (pm) => {
         if (pm === 'pnpm') return `pnpm${ext} add @shiplens/sdk`;
         if (pm === 'yarn') return `yarn${ext} add @shiplens/sdk`;
@@ -361,7 +361,7 @@ async function installSDKDependency(dir, pkgManager = 'npm') {
     },
     {
       id: 'npmmirror',
-      name: 'Alibaba Cloud mirror (npmmirror)',
+      name: '阿里云/淘宝镜像源 (npmmirror)',
       getCommand: (pm) => {
         const mirror = '--registry=https://registry.npmmirror.com';
         if (pm === 'pnpm') return `pnpm${ext} add @shiplens/sdk ${mirror}`;
@@ -372,7 +372,7 @@ async function installSDKDependency(dir, pkgManager = 'npm') {
     },
     {
       id: 'github',
-      name: 'GitHub mirror',
+      name: 'GitHub 源码镜像',
       getCommand: (pm) => {
         const repoUrl = 'https://github.com/Hyperlong/shiplens-sdk.git';
         if (pm === 'pnpm') return `pnpm${ext} add ${repoUrl}`;
@@ -383,7 +383,7 @@ async function installSDKDependency(dir, pkgManager = 'npm') {
     },
     {
       id: 'cdn',
-      name: 'Shiplens CDN mirror',
+      name: 'Shiplens 官方 CDN 镜像',
       getCommand: (pm) => {
         const cdnUrl = 'https://cdn.shiplens.dev/packages/shiplens-sdk.tgz';
         if (pm === 'pnpm') return `pnpm${ext} add ${cdnUrl}`;
@@ -394,8 +394,8 @@ async function installSDKDependency(dir, pkgManager = 'npm') {
     },
   ];
 
-  const TIER1_DELAY_MS = 20 * 1000; // 20s
-  const TOTAL_TIMEOUT_MS = 5 * 60 * 1000; // 5min
+  const TIER1_DELAY_MS = 20 * 1000; // 20秒阶梯
+  const TOTAL_TIMEOUT_MS = 5 * 60 * 1000; // 5分钟总超时
 
   return new Promise((resolve) => {
     let isDone = false;
@@ -473,25 +473,25 @@ async function installSDKDependency(dir, pkgManager = 'npm') {
         cleanupAndFinish({
           success: false,
           manager: pkgManager,
-          error: 'All 4 download sources failed or timed out',
+          error: '4 个下载源均已失败或超时',
         });
       }
     };
 
-    // t = 0s: Start Tier 1 (npmjs)
+    // t = 0s: 启动 Tier 1 (npmjs)
     runSource(sources[0]);
 
-    // t = 20s: If still running, keep npmjs alive and start npmmirror + GitHub + CDN
+    // t = 20s: 若仍未完成，保持 npmjs 并发启动 npmmirror + GitHub + CDN
     tier2Timer = setTimeout(() => {
       startBackupSources();
     }, TIER1_DELAY_MS);
 
-    // t = 5min: Total timeout across all sources
+    // t = 5min: 全部源总超时
     totalTimer = setTimeout(() => {
       cleanupAndFinish({
         success: false,
         manager: pkgManager,
-        error: 'SDK installation timed out after 5 minutes across all download sources',
+        error: '所有下载源在 5 分钟后均已超时',
       });
     }, TOTAL_TIMEOUT_MS);
   });
@@ -508,14 +508,14 @@ function getGitEmail() {
 function injectSkill(dir = process.cwd()) {
   const { SKILL_CONTENT } = require('./assets/skill');
   
-  // 1. Generate generic Agent Skill (.agents/skills/shiplens/SKILL.md)
+  // 1. 生成通用 Agent Skill 目录 (.agents/skills/shiplens/SKILL.md)
   const agentSkillDir = path.join(dir, '.agents', 'skills', 'shiplens');
   try {
     fs.mkdirSync(agentSkillDir, { recursive: true });
     fs.writeFileSync(path.join(agentSkillDir, 'SKILL.md'), SKILL_CONTENT, 'utf8');
   } catch (e) {}
 
-  // 2. Generate Cursor rule (.cursor/rules/shiplens.mdc)
+  // 2. 生成 Cursor 专属规则 (.cursor/rules/shiplens.mdc)
   const cursorRulesDir = path.join(dir, '.cursor', 'rules');
   try {
     fs.mkdirSync(cursorRulesDir, { recursive: true });
@@ -526,7 +526,7 @@ function injectSkill(dir = process.cwd()) {
 }
 
 function detectExistingApp(dir = process.cwd()) {
-  // 1. Check local .shiplens.json state machine
+  // 1. 检查本地 .shiplens.json 状态机
   const cfgPath = path.join(dir, '.shiplens.json');
   if (fs.existsSync(cfgPath)) {
     try {
@@ -543,7 +543,7 @@ function detectExistingApp(dir = process.cwd()) {
     } catch (e) {}
   }
 
-  // 2. Check code files for existing instrumentation
+  // 2. 检查代码入口中的插桩
   const checkFiles = [
     'src/app/layout.tsx', 'app/layout.tsx',
     'src/app/layout.jsx', 'app/layout.jsx',
@@ -567,6 +567,7 @@ function detectExistingApp(dir = process.cwd()) {
     if (fs.existsSync(p)) {
       try {
         const content = fs.readFileSync(p, 'utf8');
+        // 匹配 appId: 'sl_live_...' 或 data-app-id="sl_live_..."
         const matchAppId = content.match(/appId\s*:\s*['"]([^'"]+)['"]/);
         if (matchAppId && matchAppId[1]) {
           return {
@@ -583,6 +584,7 @@ function detectExistingApp(dir = process.cwd()) {
             source_file: rel,
           };
         }
+        // 如果包含 @shiplens/sdk 或 cdn.shiplens.dev 但未提取到具体 ID
         if (content.includes('@shiplens/sdk') || content.includes('cdn.shiplens.dev/sdk.js') || content.includes('initShiplens')) {
           return {
             has_existing: true,
@@ -594,7 +596,7 @@ function detectExistingApp(dir = process.cwd()) {
     }
   }
 
-  // 3. Check package.json dependencies
+  // 3. 检查 package.json 依赖
   const pkgPath = path.join(dir, 'package.json');
   if (fs.existsSync(pkgPath)) {
     try {
@@ -613,22 +615,6 @@ function detectExistingApp(dir = process.cwd()) {
   return { has_existing: false };
 }
 
-function autoGitCommit(dir = process.cwd(), message = 'feat: Integrate Shiplens SDK and generate configuration & dashboards') {
-  try {
-    execSync('git rev-parse --is-inside-work-tree', { cwd: dir, stdio: 'ignore' });
-    const status = execSync('git status --porcelain', { cwd: dir, encoding: 'utf8' }).trim();
-    if (status) {
-      execSync('git add .', { cwd: dir, stdio: 'ignore' });
-      execSync(`git commit -m "${message}"`, { cwd: dir, stdio: 'ignore' });
-      const hash = execSync('git rev-parse --short HEAD', { cwd: dir, encoding: 'utf8' }).trim();
-      return { committed: true, hash, message };
-    }
-  } catch (e) {
-    return { committed: false, error: e.message };
-  }
-  return { committed: false, reason: 'no_changes' };
-}
-
 module.exports = {
   FRAMEWORKS,
   detectPackageManager,
@@ -638,5 +624,5 @@ module.exports = {
   injectSkill,
   installSDKDependency,
   getGitEmail,
-  autoGitCommit,
 };
+

package/lib/mcp-config.js

@@ -38,7 +38,7 @@ function getMcpServer(client, url) {
 }
 
 function getMcpConfig(client, url) {
-  if (!CLIENTS.includes(client)) throw makeError(`Unsupported MCP client: ${client}`, 'UNSUPPORTED_MCP_CLIENT');
+  if (!CLIENTS.includes(client)) throw makeError(`不支持的 MCP 客户端: ${client}`, 'UNSUPPORTED_MCP_CLIENT');
   return { mcpServers: { shiplens: getMcpServer(client, url) } };
 }
 
@@ -49,7 +49,7 @@ function readJsonConfig(filePath) {
     if (!value || Array.isArray(value) || typeof value !== 'object') throw new Error('root must be object');
     return value;
   } catch (error) {
-    throw makeError(`Failed to read MCP config at ${filePath}: invalid JSON`, 'INVALID_MCP_CONFIG');
+    throw makeError(`无法读取 MCP 配置 ${filePath}：请先修复 JSON 后重试`, 'INVALID_MCP_CONFIG');
   }
 }
 
@@ -70,8 +70,8 @@ function mergeJsonMcpConfig(client, url, filePath) {
 }
 
 function configureMcpClient(client, url, options = {}) {
-  if (!CLIENTS.includes(client)) throw makeError(`Unsupported MCP client: ${client}`, 'UNSUPPORTED_MCP_CLIENT');
-  if (!url) throw makeError('MCP URL is required', 'MCP_URL_REQUIRED');
+  if (!CLIENTS.includes(client)) throw makeError(`不支持的 MCP 客户端: ${client}`, 'UNSUPPORTED_MCP_CLIENT');
+  if (!url) throw makeError('MCP 地址不能为空', 'MCP_URL_REQUIRED');
 
   if (client === 'manual') {
     return { written: false, already_configured: false, path: null, config: getMcpConfig('manual', url) };
@@ -88,7 +88,7 @@ function configureMcpClient(client, url, options = {}) {
   try {
     exec(codexCommand, ['mcp', 'add', 'shiplens', '--', process.platform === 'win32' ? 'npx.cmd' : 'npx', '--yes', 'shiplens-cli', 'mcp', 'serve'], { stdio: 'ignore' });
   } catch (error) {
-    throw makeError('Failed to configure Codex MCP. Ensure Codex Desktop is installed and codex CLI is available in PATH.', 'CODEX_MCP_CONFIG_FAILED');
+    throw makeError('无法调用 Codex MCP 配置命令，请确认 Codex Desktop 已安装并可在终端中运行 codex。', 'CODEX_MCP_CONFIG_FAILED');
   }
   return { written: true, already_configured: false, path: configPath, config: getMcpConfig('codex', url) };
 }

package/lib/taxonomy.js

@@ -11,6 +11,7 @@ function loadTaxonomy() {
     if (fs.existsSync(filePath)) {
       taxonomyCache = JSON.parse(fs.readFileSync(filePath, 'utf8'));
     } else {
+      // 容错兜底
       taxonomyCache = { genres: [] };
     }
   } catch (e) {
@@ -73,15 +74,15 @@ function buildIndex() {
 }
 
 const CATEGORY_DISPLAY_NAMES = {
-  core_features: 'Core Features',
-  monetization: 'Monetization',
-  social_engagement: 'Social & Growth',
-  technical_platform: 'Technical Platform',
-  content_theme: 'Content & Compliance',
+  core_features: '核心功能',
+  monetization: '变现模式',
+  social_engagement: '社交促活',
+  technical_platform: '技术平台',
+  content_theme: '内容与合规',
 };
 
 /**
- * Automatically infer 4-level taxonomy and feature tags from project context
+ * 根据项目的名称、简介、依赖、目录特征自动推断最契合的 4 级分类与特性标签
  */
 function inferTaxonomy(projectContext = {}) {
   const { genresMap, subgenresMap, tagsMap } = buildIndex();
@@ -102,7 +103,7 @@ function inferTaxonomy(projectContext = {}) {
   let matchedSubgenreId = 'developer_tools';
   const matchedTags = new Set();
 
-  // 1. Game detection
+  // 1. 判断是否为 Game
   const isGame =
     depKeys.some((d) => ['phaser', 'pixi.js', 'three', 'kaboom', 'melonjs'].includes(d)) ||
     /\b(game|arcade|rpg|puzzle|casual|roguelike|fps|chess|cards)\b/.test(combinedText);
@@ -111,7 +112,7 @@ function inferTaxonomy(projectContext = {}) {
     matchedGenreId = 'game_casual_puzzle';
     matchedSubgenreId = 'merge_mechanic_puzzle';
   } else {
-    // App branch inference
+    // App 分支推断
     if (/\b(vpn|proxy|shadowsocks|v2ray|wireguard|clash)\b/.test(combinedText)) {
       matchedGenreId = 'utilities';
       matchedSubgenreId = 'net_vpn_proxy';
@@ -119,6 +120,7 @@ function inferTaxonomy(projectContext = {}) {
       matchedGenreId = 'utilities';
       matchedSubgenreId = 'system_cleaner_optimizer';
     } else if (/\b(calc|turnip|price|profit|currency|converter|calculator|finance|financial|stock|crypto|accounting|tax|invoice|budget)\b/.test(combinedText)) {
+      // 计算器 / 金融理财 / 价格收益预测
       matchedGenreId = 'finance_fintech';
       if (/\b(stock|trading|invest)\b/.test(combinedText)) {
         matchedSubgenreId = 'stock_trading_investment';
@@ -148,7 +150,7 @@ function inferTaxonomy(projectContext = {}) {
     }
   }
 
-  // Ensure valid genre and subgenre
+  // 确保 genre 和 subgenre 真实有效
   if (!genresMap.has(matchedGenreId)) {
     matchedGenreId = genresMap.keys().next().value || 'utilities';
   }
@@ -159,11 +161,11 @@ function inferTaxonomy(projectContext = {}) {
 
   const currentSubObj = currentGenreObj.subgenres.get(matchedSubgenreId) || subgenresMap.get(matchedSubgenreId);
 
-  // 2. Pick feature tags from categories
+  // 2. 从当前 Sub-genre 的 5 大类别中智能挑选特性标签 (Feature Tags)
   if (currentSubObj && currentSubObj.tag_categories) {
     const cats = currentSubObj.tag_categories;
 
-    // A. Core Features (select 2~3)
+    // A. 核心功能 (Core Features) - 选 2~3 个
     const coreList = cats.core_features || [];
     if (coreList.length > 0) {
       let added = 0;
@@ -182,7 +184,7 @@ function inferTaxonomy(projectContext = {}) {
       }
     }
 
-    // B. Monetization (select 1)
+    // B. 变现模式 (Monetization) - 选 1 个
     const monList = cats.monetization || [];
     if (monList.length > 0) {
       let monTag = null;
@@ -196,7 +198,7 @@ function inferTaxonomy(projectContext = {}) {
       if (monTag) matchedTags.add(monTag.tag_id);
     }
 
-    // C. Technical Platform (select 1)
+    // C. 技术平台 (Technical Platform) - 选 1 个
     const techList = cats.technical_platform || [];
     if (techList.length > 0) {
       let techTag = techList[0];
@@ -210,14 +212,14 @@ function inferTaxonomy(projectContext = {}) {
       if (techTag) matchedTags.add(techTag.tag_id);
     }
 
-    // D. Social Engagement (select 1)
+    // D. 社交与促活 (Social Engagement) - 选 1 个
     const socList = cats.social_engagement || [];
     if (socList.length > 0) {
       matchedTags.add(socList[0].tag_id);
     }
   }
 
-  // Assemble tag details
+  // 最终组装结构化对象
   const tagDetails = [];
   for (const tagId of matchedTags) {
     const info = tagsMap.get(tagId);
@@ -229,11 +231,12 @@ function inferTaxonomy(projectContext = {}) {
         category_name: CATEGORY_DISPLAY_NAMES[info.category] || info.category,
       });
     } else {
+      // 兜底虚拟 tag
       tagDetails.push({
         tag_id: tagId,
         name: tagId.replace(/_/g, ' '),
         category: 'core_features',
-        category_name: 'Core Features',
+        category_name: '核心功能',
       });
     }
   }
@@ -254,7 +257,7 @@ function inferTaxonomy(projectContext = {}) {
 }
 
 /**
- * Format taxonomy summary into 4-Level structure
+ * 格式化输出为 4-Level 汇报格式
  */
 function formatTaxonomySummary(taxonomy) {
   if (!taxonomy || !taxonomy.genre) return '';
@@ -270,9 +273,9 @@ function formatTaxonomySummary(taxonomy) {
   }
 
   const lines = [
-    `  • Genre (L1): ${genreStr}`,
-    `  • Sub-genre (L2): ${subgenreStr}`,
-    `  • Feature Tags:`,
+    `  • 一级大类 (Genre): ${genreStr}`,
+    `  • 二级子类 (Sub-genre): ${subgenreStr}`,
+    `  • 特性标签 (Feature Tags):`,
   ];
 
   for (const [catKey, items] of Object.entries(categorized)) {
@@ -284,7 +287,7 @@ function formatTaxonomySummary(taxonomy) {
 }
 
 /**
- * Resolve taxonomy from genreId, subgenreId, and tagIdList
+ * 校验或通过 ID 组合反查
  */
 function resolveTaxonomyFromIDs(genreId, subgenreId, tagIdList = []) {
   const { genresMap, subgenresMap, tagsMap } = buildIndex();
@@ -324,7 +327,7 @@ function resolveTaxonomyFromIDs(genreId, subgenreId, tagIdList = []) {
         tag_id: tid,
         name: tid.replace(/_/g, ' '),
         category: 'core_features',
-        category_name: 'Core Features',
+        category_name: '核心功能',
       });
     }
   }

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@shiplens/cli",
-  "version": "1.3.0",
-  "description": "Shiplens CLI (In Development) - 15-second zero-config analytics initialization and full telemetry analysis engine",
+  "version": "1.4.0",
+  "description": "Shiplens CLI — Web 用户行为数据统计与 AI Agent 智能分析引擎",
   "main": "lib/index.js",
   "bin": {
-    "shiplens-cli": "bin/shiplens.js",
-    "shiplens": "bin/shiplens.js"
+    "shiplens-cli": "./bin/shiplens.js",
+    "shiplens": "./bin/shiplens.js"
   },
   "keywords": [
     "shiplens",
@@ -33,6 +33,7 @@
     "bin",
     "lib",
     "prompts",
+    "docs",
     "README.md",
     "LICENSE"
   ],

package/prompts/README.md

@@ -1,4 +1,4 @@
-# Shiplens Prompt Libraries
+# Shiplens Prompt Libraries
 
 This directory hosts the deterministic CLI scenario-based prompt libraries for Shiplens.
 
@@ -9,13 +9,19 @@ This directory hosts the deterministic CLI scenario-based prompt libraries for S
 ```text
 prompts/
 ├── README.md                 # Multilingual architecture overview
-├── prompts_cli_en.md         # [English - Official] Deterministic CLI execution presets (42 Scenarios)
-└── ...                       # Future language extensions (ja, ko, de, fr, es, etc.)
+├── prompts_cli_en.md         # [English] 42 deterministic CLI analysis scenarios
+└── prompts_cli_zh.md         # [中文] 42 个确定性 CLI 分析场景
 ```
 
 ---
 
 ## ⚡ Execution & Dynamic Overrides
 
-1. **Deterministic Execution**: Every scenario in `prompts_cli_en.md` provides explicit, reproducible CLI commands and SQL queries paired with textbook analytical foundations.
-2. **Dynamic Overrides**: Local rules defined in `.shiplens/learnings.md` override default parameters (such as `--range`, `--grain`, or target funnel routes) during AI Agent execution.
+1. **Deterministic Execution**: Every scenario provides explicit, reproducible CLI commands and SQL queries paired with textbook analytical foundations.
+2. **Dynamic Overrides**: Local rules defined in `.shiplens/learnings.md` override default parameters (such as `--range`, `--grain`, or target funnel routes) during AI Agent execution.
+3. **Scenario Outline**: Each file includes a categorized outline at the top for quick scenario discovery. Agent should read the outline first, then jump to the matching scenario.
+
+## 🌐 Multilingual Architecture
+
+- Scenario IDs, titles, and structure are **1:1 aligned** across languages.
+- Add new languages by creating `prompts_cli_<lang>.md` with the same outline structure and scenario ordering.