@mindbase/deploy 1.2.0 → 1.2.1

package/README.md

@@ -0,0 +1,229 @@
+# deploy CLI
+
+多项目部署工具，支持批量部署到多台服务器。
+
+## 功能特点
+
+- **交互式部署**：通过友好的命令行界面选择目标服务器和项目
+- **笛卡尔组合部署**：选中的每个服务器都会部署全部选中的项目（N 个服务器 × M 个项目 = N×M 次部署）
+- **灵活配置**：项目部署步骤完全自定义，支持本地命令、远程命令、文件上传/下载等
+- **多环境支持**：部署时现场选择目标服务器，不再写死在配置中
+
+## 命令结构
+
+```bash
+deploy              # 部署：选择服务器 → 选择项目 → 开始部署
+deploy init [path]  # 初始化项目配置（path 缺省为当前目录）
+deploy server ...   # 服务器管理
+```
+
+## 快速开始
+
+### 1. 配置服务器
+
+首次使用需要先添加目标服务器：
+
+```bash
+# 添加服务器
+deploy server add
+
+# 列出所有服务器
+deploy server list
+
+# 测试连接
+deploy server test
+```
+
+服务器配置保存在 `~/.mindbase/deploy.json`，支持密码和私钥两种认证方式。
+
+### 2. 初始化项目
+
+在项目目录下运行：
+
+```bash
+cd /path/to/your/project
+deploy init
+```
+
+交互式引导会询问：
+- 项目名称
+- 目标服务器（选择已配置的服务器，用于 SFTP 连接浏览远端目录）
+- 本地目录（默认 `./`）
+- 远端目录（可浏览服务器目录或手动输入）
+- 部署步骤（添加构建、上传、重启等步骤）
+
+完成后会在当前目录生成 `deploy.config.json` 配置文件。
+
+### 3. 部署
+
+在包含多个 `deploy.config.json` 的目录（如 monorepo 根目录）运行：
+
+```bash
+deploy
+```
+
+交互流程：
+1. **选择服务器**（多选，空格切换，a 全选）
+2. **选择项目**（多选）
+3. **确认摘要**（显示 N×M=K 次部署）
+4. **开始部署**（依次连接每个服务器，部署所有选中项目）
+
+## 配置文件结构
+
+`deploy.config.json` 示例：
+
+```json
+{
+  "name": "photo",
+  "localDir": "./",
+  "remoteDir": "/application/lightUp-web/photo/",
+  "steps": [
+    { "type": "log", "message": "构建相册" },
+    { "type": "local", "cmd": "pnpm run build", "cwd": "${localDir}" },
+    { "type": "remote", "cmd": "mkdir -p ${remoteDir}" },
+    { "type": "uploadDir", "local": "${localDir}/dist", "remote": "${remoteDir}" }
+  ]
+}
+```
+
+### 配置字段说明
+
+| 字段 | 类型 | 说明 |
+|---|---|---|
+| `name` | string | 项目显示名称 |
+| `localDir` | string | 本地目录（相对或绝对路径） |
+| `remoteDir` | string | 远端部署目录 |
+| `steps` | Step[] | 部署步骤数组 |
+
+### 步骤类型（Step）
+
+| 类型 | 说明 | 示例 |
+|---|---|---|
+| `log` | 输出日志信息 | `{ "type": "log", "message": "开始构建" }` |
+| `local` | 本地执行命令 | `{ "type": "local", "cmd": "npm run build", "cwd": "${localDir}" }` |
+| `remote` | 远程执行命令 | `{ "type": "remote", "cmd": "pm2 restart myapp" }` |
+| `uploadDir` | 上传整个目录 | `{ "type": "uploadDir", "local": "./dist", "remote": "/app/dist" }` |
+| `uploadFile` | 上传单个文件 | `{ "type": "uploadFile", "local": "./package.json", "remote": "/app/package.json" }` |
+| `downloadDir` | 下载目录（备份） | `{ "type": "downloadDir", "remote": "/app/data", "local": "./backup" }` |
+| `downloadFile` | 下载文件（备份） | `{ "type": "downloadFile", "remote": "/app/config.json", "local": "./backup.json" }` |
+
+### 变量替换
+
+步骤中支持以下变量，运行时自动替换：
+
+| 变量 | 说明 | 示例值 |
+|---|---|---|
+| `${localDir}` | 项目本地目录 | `/path/to/project` |
+| `${remoteDir}` | 项目远端目录 | `/app/photo/` |
+| `${projectName}` | 项目名称 | `photo` |
+| `${date}` | 当前日期 | `2026-06-17` |
+| `${datetime}` | 当前日期时间 | `2026-06-17_14-30-52` |
+| `${timestamp}` | Unix 毫秒时间戳 | `1718621452000` |
+
+日期变量可用 `${name:格式}` 自定义格式，如 `${datetime:YYYYMMDD-HHmmss}` → `20260617-143052`。
+
+备份示例：
+
+```json
+{
+  "type": "downloadDir",
+  "remote": "${remoteDir}",
+  "local": "${localDir}/backup_${datetime}"
+}
+```
+
+## 服务器管理
+
+```bash
+# 添加服务器
+deploy server add
+
+# 编辑服务器
+deploy server edit
+
+# 删除服务器
+deploy server delete
+
+# 测试连接
+deploy server test
+
+# 列出所有服务器
+deploy server list
+```
+
+### 全局配置文件
+
+服务器配置保存在 `~/.mindbase/deploy.json`：
+
+```json
+{
+  "servers": {
+    "own": {
+      "host": "192.168.1.100",
+      "port": 22,
+      "username": "root",
+      "password": "***"
+    },
+    "backup": {
+      "host": "192.168.1.101",
+      "port": 22,
+      "username": "root",
+      "privateKeyPath": "~/.ssh/id_rsa",
+      "passphrase": "***"
+    }
+  }
+}
+```
+
+## 使用场景
+
+### Monorepo 批量部署
+
+```bash
+cd /path/to/monorepo  # 包含多个子项目，每个都有 deploy.config.json
+deploy                # 选择服务器和项目，一键部署所有
+```
+
+### 单项目部署
+
+```bash
+cd /path/to/project
+deploy                # 单选本项目，部署到选中服务器
+```
+
+### 多环境部署
+
+```bash
+deploy                # 多选 staging、production 两台服务器
+                      # 选择所有项目，一次性部署到所有环境
+```
+
+## 边界情况处理
+
+- **服务器连接失败**：询问是否跳过并继续下一个服务器
+- **项目部署失败**：询问是否继续部署下一个项目（当前服务器连接保持）
+- **无可用服务器**：提示先运行 `deploy server add`
+- **无可用项目**：提示先运行 `deploy init`
+- **用户取消**：任何交互步骤按 Ctrl+C 均可安全退出
+
+## 技术实现
+
+- **依赖**：`@clack/prompts`（交互）、`ssh2-sftp-client`（SFTP）、`commander.js`（命令框架）
+- **变量解析**：步骤中的变量在运行时替换
+- **错误处理**：失败时询问用户决策，支持跳过/中止
+- **日志输出**：统一使用 `@clack/prompts` 格式，逐行显示命令输出
+
+## 开发
+
+```bash
+# 直接运行（无需构建）
+cd cli/apps/deploy
+tsx bin/index.ts
+
+# 或在项目根目录
+tsx cli/apps/deploy/bin/index.ts
+```
+
+## License
+
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mindbase/deploy",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "description": "MindBase 部署工具",
   "type": "module",
   "bin": {
@@ -21,6 +21,7 @@
     "@clack/prompts": "^0.9.1",
     "commander": "^12.0.0",
     "cross-spawn": "^7.0.6",
+    "dayjs": "^1.11.13",
     "picocolors": "^1.1.1",
     "ssh2-sftp-client": "^9.1.0",
     "tsx": "^4.19.0",

package/src/app.ts

@@ -80,7 +80,6 @@ export async function runApp(): Promise<void> {
   const summaryLines = [
     `服务器: ${selectedServers.map((s) => `${s} (${globalConfig.servers[s].host})`).join(', ')}`,
     `项目:   ${selectedProjects.map((p) => p.config.name).join(', ')}`,
-    `组合:   ${selectedServers.length} × ${selectedProjects.length} = ${selectedServers.length * selectedProjects.length} 次部署`,
   ].join('\n');
   noteBox(summaryLines, '即将部署');
 

package/src/init/app.ts

@@ -50,6 +50,11 @@ const VARS_REFERENCE = [
   '  ${localDir}    项目本地目录',
   '  ${remoteDir}   项目远程目录',
   '  ${projectName} 项目名称',
+  '  ${date}        日期 (YYYY-MM-DD)',
+  '  ${datetime}    日期时间 (YYYY-MM-DD_HH-mm-ss)',
+  '  ${timestamp}   Unix 毫秒时间戳',
+  '',
+  '  可用 ${name:格式} 自定义，如 ${datetime:YYYYMMDD-HHmmss}',
 ].join('\n');
 
 /** 步骤类型示例 */
@@ -94,15 +99,15 @@ const STEP_EXAMPLES: Record<StepType, string> = {
     VARS_REFERENCE,
     '',
     '示例:',
-    '  远端: ${remoteDir}backup/',
-    '  本地: ${localDir}/backup',
+    '  远端: ${remoteDir}',
+    '  本地: ${localDir}/backup_${datetime}',
   ].join('\n'),
   downloadFile: [
     VARS_REFERENCE,
     '',
     '示例:',
     '  远端: ${remoteDir}config.json',
-    '  本地: ${localDir}/config.json.bak',
+    '  本地: ${localDir}/config.json.bak_${date}',
   ].join('\n'),
 };
 

package/src/script/parser.ts

@@ -1,22 +1,62 @@
+import dayjs from 'dayjs';
 import type { ProjectConfig } from '../config/schema.js';
 
-/**
- * 内置变量名
- */
-const BUILT_IN_VARS = ['localDir', 'remoteDir', 'projectName'] as const;
+/** 内置变量名（含日期时间变量） */
+const BUILT_IN_VARS = ['localDir', 'remoteDir', 'projectName', 'date', 'datetime', 'timestamp'] as const;
+
+/** 日期变量预设及其默认格式（timestamp 固定为毫秒，无 format） */
+const DATE_VAR_DEFAULTS: Record<string, string | null> = {
+  date: 'YYYY-MM-DD',
+  datetime: 'YYYY-MM-DD_HH-mm-ss',
+  timestamp: null, // 特殊：输出毫秒
+};
+
+/** 变量解析上下文（运行时动态变量） */
+export interface ResolveContext {
+  /** 时间锚点；缺省取当前时间。同一次部署应传同一个 Date 保证一致性 */
+  now?: Date;
+}
 
 /**
- * 替换字符串中的 ${varName} 占位符
+ * 替换字符串中的 ${varName} 或 ${name:format} 占位符
+ * - 静态变量：${localDir}、${remoteDir}、${projectName}
+ * - 日期变量：${date}、${datetime}、${timestamp}，可加 :format 自定义格式，如 ${datetime:YYYYMMDD-HHmmss}
+ * - 未知变量：原样保留（向后兼容）
  */
-export function resolveVariables(template: string, project: ProjectConfig): string {
-  const vars: Record<string, string> = {
+export function resolveVariables(
+  template: string,
+  project: ProjectConfig,
+  ctx: ResolveContext = {},
+): string {
+  const staticVars: Record<string, string> = {
     localDir: project.localDir,
     remoteDir: project.remoteDir,
     projectName: project.name,
   };
+  const now = ctx.now ?? new Date();
+
+  return template.replace(/\$\{([^}]+)\}/g, (match, expr: string) => {
+    // 按第一个冒号分割 name 和 format（format 内部可能含冒号，如 HH:mm:ss）
+    const colon = expr.indexOf(':');
+    const name = colon === -1 ? expr : expr.slice(0, colon);
+    const format = colon === -1 ? '' : expr.slice(colon + 1);
+
+    // 1. 静态变量优先
+    if (staticVars[name] !== undefined) {
+      return staticVars[name];
+    }
+
+    // 2. 日期变量
+    if (name in DATE_VAR_DEFAULTS) {
+      if (name === 'timestamp') {
+        return String(dayjs(now).valueOf());
+      }
+      // date/datetime 用默认格式或自定义格式
+      return dayjs(now).format(format || (DATE_VAR_DEFAULTS[name] as string));
+    }
 
-  return template.replace(/\$\{(\w+)\}/g, (match, key: string) => {
-    return vars[key] !== undefined ? vars[key] : match;
+    // 3. 未知变量原样保留（向后兼容）
+    return match;
   });
 }
 

package/src/script/runner.ts

@@ -38,27 +38,27 @@ function runLocal(cmd: string, cwd?: string): Promise<void> {
 /**
  * 执行单个步骤
  */
-async function runStep(step: Step, project: ProjectConfig, sftp: SftpClient): Promise<void> {
+async function runStep(step: Step, project: ProjectConfig, sftp: SftpClient, now: Date): Promise<void> {
   switch (step.type) {
     case 'log': {
-      const msg = resolveVariables(step.message, project);
+      const msg = resolveVariables(step.message, project, { now });
       clack.log.message(msg);
       break;
     }
     case 'local': {
-      const cmd = resolveVariables(step.cmd, project);
-      const cwd = step.cwd ? resolveVariables(step.cwd, project) : undefined;
+      const cmd = resolveVariables(step.cmd, project, { now });
+      const cwd = step.cwd ? resolveVariables(step.cwd, project, { now }) : undefined;
       await runLocal(cmd, cwd);
       break;
     }
     case 'remote': {
-      const cmd = resolveVariables(step.cmd, project);
+      const cmd = resolveVariables(step.cmd, project, { now });
       await execRemote(sftp, cmd);
       break;
     }
     case 'uploadDir': {
-      const local = resolveVariables(step.local, project);
-      const remote = resolveVariables(step.remote, project);
+      const local = resolveVariables(step.local, project, { now });
+      const remote = resolveVariables(step.remote, project, { now });
       clack.log.step(`上传目录: ${local} → ${remote}`);
       await sftp.mkdir(remote, true);
       await sftp.uploadDir(local, remote, { useFastput: true });
@@ -66,24 +66,24 @@ async function runStep(step: Step, project: ProjectConfig, sftp: SftpClient): Pr
       break;
     }
     case 'uploadFile': {
-      const local = resolveVariables(step.local, project);
-      const remote = resolveVariables(step.remote, project);
+      const local = resolveVariables(step.local, project, { now });
+      const remote = resolveVariables(step.remote, project, { now });
       clack.log.step(`上传文件: ${local} → ${remote}`);
       await sftp.fastPut(local, remote);
       clack.log.success('上传文件完成');
       break;
     }
     case 'downloadDir': {
-      const remote = resolveVariables(step.remote, project);
-      const local = resolveVariables(step.local, project);
+      const remote = resolveVariables(step.remote, project, { now });
+      const local = resolveVariables(step.local, project, { now });
       clack.log.step(`下载目录: ${remote} → ${local}`);
       await sftp.downloadDir(remote, local);
       clack.log.success('下载目录完成');
       break;
     }
     case 'downloadFile': {
-      const remote = resolveVariables(step.remote, project);
-      const local = resolveVariables(step.local, project);
+      const remote = resolveVariables(step.remote, project, { now });
+      const local = resolveVariables(step.local, project, { now });
       clack.log.step(`下载文件: ${remote} → ${local}`);
       await sftp.fastGet(remote, local);
       clack.log.success('下载文件完成');
@@ -96,7 +96,8 @@ async function runStep(step: Step, project: ProjectConfig, sftp: SftpClient): Pr
  * 执行项目的所有步骤
  */
 export async function runSteps(steps: Step[], project: ProjectConfig, sftp: SftpClient): Promise<void> {
+  const now = new Date(); // 整个项目部署共用同一时间戳
   for (const step of steps) {
-    await runStep(step, project, sftp);
+    await runStep(step, project, sftp, now);
   }
 }