daodou-command 1.4.7 → 1.4.9

package/.daodourc

@@ -0,0 +1,85 @@
+{
+  // build 命令配置
+  build: {
+    // Jenkins 基础配置
+    // jenkinsUrl: "https://jenkins.example.com/",
+    // jenkinsBase: "https://jenkins.example.com/job",
+    // jenkinsToken: "your-jenkins-token",
+    // jenkinsUsername: "your-username",
+    // jenkinsPassword: "your-password",
+    
+    // 构建任务配置（必须配置）
+    // jobName: "your-job-name",  // 必须配置的任务名称
+    
+    // 构建参数配置
+    // buildParams: {
+    //   token: "your-jenkins-token",
+    //   BUILD_ENV: "test",
+    //   version: "0.0.1"
+    // }
+  },
+  
+  // lang 命令配置
+  lang: {
+    defaultLang: "en",
+    defaultDir: "./public/locales",
+    fileName: "common.json",
+    
+    // 翻译引擎配置
+    translation: {
+      // 默认翻译引擎 (microsoft, google, baidu, ali, youdao, deepl, openai)
+      defaultEngine: "microsoft",
+      
+      // 引擎优先级列表（按顺序尝试）
+      enginePriority: ["microsoft", "google", "baidu", "ali", "youdao", "deepl", "openai"],
+      
+      // 各引擎API配置
+      engines: {
+        // 微软翻译（免费，无需配置）
+        microsoft: {
+          enabled: true
+        },
+        
+        // Google翻译（免费，无需配置）
+        google: {
+          enabled: true
+        },
+        
+        // 百度翻译（需要API密钥）
+        baidu: {
+          enabled: false,
+          appId: "",        // 百度翻译API App ID
+          appKey: ""        // 百度翻译API App Key
+        },
+        
+        // 阿里云翻译（需要API密钥）
+        ali: {
+          enabled: false,
+          accessKeyId: "",     // 阿里云AccessKey ID
+          accessKeySecret: ""  // 阿里云AccessKey Secret
+        },
+        
+        // 有道翻译（需要API密钥）
+        youdao: {
+          enabled: false,
+          appId: "",        // 有道翻译API App ID
+          appKey: ""        // 有道翻译API App Key
+        },
+        
+        // DeepL翻译（需要API密钥）
+        deepl: {
+          enabled: false,
+          apiKey: ""        // DeepL API Key
+        },
+        
+        // OpenAI翻译（需要API密钥）
+        openai: {
+          enabled: false,
+          apiKey: "",       // OpenAI API Key
+          model: "gpt-3.5-turbo",  // 使用的模型
+          baseUrl: "https://api.openai.com/v1"  // API基础URL
+        }
+      }
+    }
+  }
+}

package/README.md

@@ -1,220 +1,237 @@
 # 刀豆命令行工具 (Daodou CLI)
 
-一个功能强大的命令行工具，支持自动化构建和多语言管理。
+用于 Jenkins 构建触发、多语言文案维护、版本检查升级与配置管理的命令行工具。
 
 ## 安装
 
+全局安装：
+
 ```bash
 npm install -g daodou-command
 ```
 
-## 功能特性
+本地开发：
 
-### 🚀 构建功能
-- 自动检测Git分支
-- 一键触发Jenkins构建
-- 实时监听构建进度
+```bash
+git clone <repository-url>
+cd daodou-command
+npm install
+npm link
+```
 
-### 🌐 多语言管理
-- 支持多语言文件管理
-- 多引擎翻译支持（微软、Google、百度、阿里云、有道、DeepL、OpenAI）
-- HTML文档翻译支持，保持标签结构
-- 智能引擎调度和故障转移
-- 灵活的引擎配置和优先级设置
+## 快速开始
 
-### 🔄 自动更新
-- 智能版本检查和更新
-- 一键升级到最新版本
-- 支持强制更新和仅检查模式
+1. 初始化全局配置：
 
-### ⚙️ 配置管理
-- 全局配置和项目配置支持
-- 交互式配置向导
-- 配置文件编辑和管理
+```bash
+dao config init
+```
 
-## 快速开始
+2. 执行常用命令：
 
-### 构建项目
 ```bash
-# 在项目根目录下执行
-cd your-project
 dao build
+dao lang add "hello.world" "Hello World"
+dao upgrade --check
 ```
 
-### 检查更新
-```bash
-# 检查是否有新版本
-dao upgrade --check
+说明：
 
-# 更新到最新版本
-dao upgrade
+- 当全局配置和项目配置都不存在时，首次执行 `dao build` 会自动生成默认项目配置 `./.daodourc`。
 
-# 强制更新
-dao upgrade --force
-```
+## 配置说明
 
-### 配置管理
-```bash
-# 初始化全局配置
-dao config init
+配置来源：
 
-# 查看当前配置
-dao config show
+- 全局配置：`~/.daodou/config.json`
+- 项目配置：`./.daodourc`
+- 合并规则：项目配置覆盖全局配置
 
-# 编辑配置文件
-dao config edit
+建议：
 
-# 清除配置文件
-dao config clear
-```
+- `build.jobName` 放在项目配置中（不同项目通常不同）。
+- Jenkins 账号和 Token 放在全局配置中（减少重复）。
 
-### 翻译引擎配置
-支持7种翻译引擎，可在lang命令配置中灵活配置：
+最小配置示例（JSON5）：
 
-```json
+```json5
 {
-  "lang": {
-    "defaultLang": "en",
-    "defaultDir": "./public/locales",
-    "fileName": "common.json",
-    "translation": {
-      "defaultEngine": "microsoft",
-      "enginePriority": ["microsoft", "google", "baidu", "ali", "youdao", "deepl", "openai"],
-      "engines": {
-        "microsoft": { "enabled": true },
-        "google": { "enabled": true },
-        "baidu": { "enabled": false, "appId": "", "appKey": "" },
-        "ali": { "enabled": false, "accessKeyId": "", "accessKeySecret": "" },
-        "youdao": { "enabled": false, "appId": "", "appKey": "" },
-        "deepl": { "enabled": false, "apiKey": "" },
-        "openai": { "enabled": false, "apiKey": "", "model": "gpt-3.5-turbo" }
-      }
+  build: {
+    jenkinsUrl: "https://jenkins.example.com/",
+    jenkinsBase: "https://jenkins.example.com/job",
+    jenkinsToken: "your-token",
+    jenkinsUsername: "your-username",
+    jenkinsPassword: "your-password",
+    jobName: "your-job-name",
+    buildParams: {
+      token: "your-token",
+      BUILD_ENV: "test"
+    }
+  },
+  lang: {
+    defaultLang: "en",
+    defaultDir: "./public/locales",
+    fileName: "common.json",
+    translation: {
+      defaultEngine: "microsoft",
+      enginePriority: ["microsoft", "google", "baidu", "ali", "youdao", "deepl", "openai"]
     }
   }
 }
 ```
 
-**支持的翻译引擎：**
-- **微软翻译**: 免费，无需配置，支持HTML翻译
-- **Google翻译**: 免费，无需配置，支持HTML翻译
-- **百度翻译**: 需要App ID和App Key
-- **阿里云翻译**: 需要AccessKey ID和AccessKey Secret，支持HTML翻译
-- **有道翻译**: 需要App ID和App Key
-- **DeepL翻译**: 需要API Key
-- **OpenAI翻译**: 需要API Key和模型配置，支持HTML翻译
-
-**HTML翻译支持：**
-- 微软翻译：原生支持HTML格式，保持标签结构
-- Google翻译：支持HTML格式翻译
-- 阿里云翻译：支持HTML格式翻译
-- OpenAI翻译：智能识别HTML标签，保持结构完整
-
-### 多语言管理
+## 命令详解
+
+### `dao build`
+
+用途：
+
+- 读取配置并触发 Jenkins 构建。
+- 默认自动检测当前 Git 分支。
+- 构建后轮询 Jenkins 队列与构建状态，输出进度日志。
+
+常用写法：
+
 ```bash
-# 添加多语言项（自动翻译）
-dao lang add "hello world"
+# 自动读取当前分支并构建
+dao build
 
-# 添加多语言项（指定值）
-dao lang add "welcome" "欢迎"
+# 指定分支构建
+dao build -b feature/new-login
 
-# 删除多语言项
-dao lang remove "hello world"
+# 显式传入 Jenkins 地址与任务名（推荐仍在配置文件中维护）
+dao build -j https://jenkins.example.com -n web-build
 ```
 
-## 配置
+参数含义：
 
-首次运行会自动生成 `.daodourc` 配置文件：
+- `-b, --branch <branch>`：指定构建分支；不传时自动读取当前 Git 分支。
+- `-j, --jenkins-url <url>`：Jenkins 服务器地址。
+- `-n, --job-name <name>`：Jenkins 任务名称。
+- `-u, --username <username>`：Jenkins 用户名。
+- `-t, --token <token>`：Jenkins API Token。
+- `-p, --parameters <json>`：额外构建参数（JSON 字符串）。
 
-```json5
-{
-  build: {
-    jenkinsUrl: 'your-jenkins-url',
-    jenkinsBase: 'your-jenkins-base',
-    jenkinsToken: 'your-jenkins-token',
-    jenkinsUsername: 'your-username',
-    jenkinsPassword: 'your-password',
-    jobName: 'your-job-name',
+前置条件：
 
-    buildParams: {
-      token: 'your-jenkins-token',
-      BUILD_ENV: 'test',
-      version: '0.0.1'
-    }
-  },
-  
-  lang: {
-    defaultLang: 'en',
-    defaultDir: './public/locales',
-    fileName: 'common.json'
-  }
-}
-```
+- 当前目录是 Git 仓库（未传 `--branch` 时）。
+- Jenkins 配置已填写且不是模板值。
+- 首次构建前建议先运行 `dao config show` 检查合并配置是否正确。
+
+### `dao config`
+
+用途：
+
+- 管理全局配置与项目配置。
+- 查看“全局 / 项目 / 合并结果”三类配置视图。
+- 直接执行 `dao config` 可进入交互式配置向导。
+
+交互模式：
 
-## 命令用法
+- 命令：`dao config`
+- 作用：以菜单方式引导你选择 `init / show / edit / clear`，适合不记子命令时使用。
+
+子命令：
+
+- `dao config init`：初始化全局配置文件 `~/.daodou/config.json`。
+- `dao config show`：显示当前配置与合并结果。
+- `dao config edit`：打开编辑器修改配置。
+- `dao config clear`：删除指定配置（全局/项目/全部）。
+
+常用写法：
 
-### 构建命令
 ```bash
-dao build                    # 自动检测分支并构建
-dao build --branch feature   # 指定分支构建
-dao build --help            # 查看帮助
+dao config
+dao config init
+dao config show
+dao config edit
+dao config clear
 ```
 
-### 更新命令
-```bash
-dao upgrade                  # 检查并更新到最新版本
-dao upgrade --check         # 仅检查是否有新版本
-dao upgrade --force         # 强制更新到最新版本
-dao upgrade --help          # 查看帮助
+### `dao lang`
+
+用途：
+
+- 在多语言 JSON 文件中批量新增或删除 key。
+- 新增时会以默认语言为源文，其他语言自动翻译。
+
+目录约定：
+
+```text
+public/locales/{lang}/common.json
 ```
 
-### 配置命令
-```bash
-dao config                   # 配置管理向导
-dao config init             # 初始化全局配置
-dao config show             # 显示当前配置
-dao config edit             # 编辑配置文件
-dao config clear            # 清除配置文件
-dao config --help           # 查看帮助
+例如：
+
+```text
+public/locales/en/common.json
+public/locales/zh/common.json
+public/locales/ja/common.json
 ```
 
-### 多语言命令
+子命令：
+
+- `dao lang add <key> [value]`：添加 key。
+- `dao lang remove <key>`：删除 key。
+
+参数含义：
+
+- `-l, --lang <language>`：只处理指定语言（如 `en`、`zh`、`ja`）。
+- `-d, --dir <directory>`：指定语言目录，默认读取 `lang.defaultDir`。
+
+常用写法：
+
 ```bash
-dao lang add "key" "value"   # 添加多语言项
-dao lang remove "key"        # 删除多语言项
-dao lang add "key" --lang zh # 只处理特定语言
-dao lang --help             # 查看帮助
-```
+# 默认以 key 作为默认语言文案，并自动翻译到其他语言
+dao lang add "user.profile.title"
 
-## 多语言文件结构
+# 手动指定默认语言文案
+dao lang add "user.profile.title" "Profile"
 
-工具会自动扫描 `/public/locales/[lang]/common.json` 文件：
+# 只处理 zh（默认 defaultLang=en 时，会先翻译再写入 zh）
+dao lang add "user.profile.title" "Profile" --lang zh
 
-```
-public/
-└── locales/
-    ├── en/
-    │   └── common.json
-    ├── zh/
-    │   └── common.json
-    └── ja/
-        └── common.json
+# 删除 key
+dao lang remove "user.profile.title"
 ```
 
-## 常见问题
+说明：
+
+- `lang` 命令不会自动创建 `public/locales` 目录结构。
+- 若某语言文件不存在或 key 已存在，会跳过并给出提示。
+- `add` 的 `value` 按 `defaultLang` 语义处理（默认通常是 `en`）。
+- 当 `--lang` 指定语言不等于 `defaultLang` 时，会“翻译后写入”目标语言文件。
+- 只有目标语言等于 `defaultLang` 时，才会“直接写入”你传入的 `value`。
+
+### `dao upgrade`
+
+用途：
+
+- 检查 npm 上的最新版本并执行升级。
+
+子命令参数：
 
-- **Jenkins配置**: 请编辑 `.daodourc` 文件，填写真实的Jenkins配置
-- **多语言目录**: 工具会提示目录不存在，不会自动创建
-- **翻译失败**: 工具会自动重试和切换代理
+- `--check`：仅检查是否有新版本，不安装。
+- `--force`：即使当前版本已是最新，也强制重装最新版本。
 
-## 开发
+常用写法：
 
 ```bash
-git clone <repository-url>
-cd daodou-command
-npm install
-npm link
+dao upgrade --check
+dao upgrade
+dao upgrade --force
 ```
 
----
+## 常见问题
+
+- 提示缺少配置：先执行 `dao config init`，并补全 Jenkins 参数。
+- 提示配置仍是模板值：将 `your-jenkins-*` 等占位值替换为真实值。
+- 提示不是 Git 仓库：在仓库根目录执行，或显式传 `-b/--branch`。
+- `lang` 扫描不到语言目录：确认 `public/locales/{lang}/common.json` 路径存在。
+
+## 安全说明
+
+配置中可能包含 Jenkins 凭据，请勿将以下文件提交到仓库：
 
-**刀豆团队** - 让开发更简单 🚀
+- `~/.daodou/config.json`
+- `./.daodourc`

package/bin/daodou.js

@@ -10,21 +10,17 @@ const updateChecker = require('../lib/utils/update-checker');
 
 const program = new Command();
 
-// 异步启动后台更新检查，不阻塞主程序
-setImmediate(() => {
-  updateChecker.startBackgroundCheck();
-});
-
-// 检查并显示更新提醒（upgrade命令除外）
+// 只在实际子命令时检查更新（排除 --help、--version、upgrade）
 const args = process.argv.slice(2);
-const isUpgradeCommand = args[0] === 'upgrade';
+const firstArg = args[0];
+const isSubCommand = firstArg && !firstArg.startsWith('-') && firstArg !== 'upgrade';
 
-if (!isUpgradeCommand && updateChecker.shouldRemindUpdate()) {
+if (isSubCommand) {
+  updateChecker.startBackgroundCheck();
   const reminder = updateChecker.getUpdateReminder();
   if (reminder) {
-    console.log(chalk.yellow(reminder));
-    console.log(); // 空行
-    // 不标记为已提醒，允许重复提醒
+    console.log(reminder);
+    console.log('');
   }
 }
 
@@ -41,7 +37,7 @@ program
   .option('-j, --jenkins-url <url>', 'Jenkins服务器地址')
   .option('-u, --username <username>', 'Jenkins用户名')
   .option('-t, --token <token>', 'Jenkins API Token')
-  .option('-j, --job-name <name>', 'Jenkins任务名称')
+  .option('-n, --job-name <name>', 'Jenkins任务名称')
   .option('-b, --branch <branch>', '指定分支名称（默认从Git自动检测）')
   .option('-p, --parameters <params>', '额外的构建参数 (JSON格式)')
   .action(async (options) => {
@@ -213,4 +209,4 @@ program.addHelpText('after', `
 `);
 
 // 解析命令行参数
-program.parse(); 
+program.parse();