@mindbase/deploy 1.0.0 → 1.1.0

package/src/init/app.ts

@@ -0,0 +1,406 @@
+import * as clack from '@clack/prompts';
+import pc from 'picocolors';
+import { resolve } from 'path';
+import { existsSync, readFileSync } from 'fs';
+import { noteBox } from '@mindbase/cli-ui';
+import { getConfig, saveProjectConfig } from '../config/manager.js';
+import type { Step, StepType, ProjectConfig } from '../config/schema.js';
+import { connectSftp } from '../ssh/client.js';
+
+/** 取消处理 */
+function handleCancel<T>(result: T | symbol): T {
+  if (typeof result === 'symbol' && clack.isCancel(result)) {
+    clack.cancel('操作已取消');
+    process.exit(0);
+  }
+  return result as T;
+}
+
+/** 格式化单个步骤为摘要行 */
+function formatStepSummary(step: Step): string {
+  switch (step.type) {
+    case 'log':
+      return `log: ${step.message}`;
+    case 'local':
+      return step.cwd
+        ? `local: ${step.cmd} (cwd: ${step.cwd})`
+        : `local: ${step.cmd}`;
+    case 'remote':
+      return `remote: ${step.cmd}`;
+    case 'uploadDir':
+      return `uploadDir: ${step.local} → ${step.remote}`;
+    case 'uploadFile':
+      return `uploadFile: ${step.local} → ${step.remote}`;
+    case 'downloadDir':
+      return `downloadDir: ${step.remote} → ${step.local}`;
+    case 'downloadFile':
+      return `downloadFile: ${step.remote} → ${step.local}`;
+  }
+}
+
+/** 展示当前所有已配置步骤 */
+function showStepsSummary(steps: Step[]): void {
+  const lines = steps.map((s, i) => `${i + 1}. ${formatStepSummary(s)}`).join('\n');
+  noteBox(lines, `已配置步骤 (${steps.length})`);
+}
+
+/** 可用变量参考文本 */
+const VARS_REFERENCE = [
+  '可用变量:',
+  '  ${localDir}    项目本地目录',
+  '  ${remoteDir}   项目远程目录',
+  '  ${projectName} 项目名称',
+].join('\n');
+
+/** 步骤类型示例 */
+const STEP_EXAMPLES: Record<StepType, string> = {
+  log: [
+    '示例:',
+    '  开始发布...',
+    '  编译完成',
+  ].join('\n'),
+  local: [
+    VARS_REFERENCE,
+    '',
+    '示例:',
+    '  npm run build',
+    '  pnpm install',
+    '',
+    'cwd: 工作目录，留空使用默认，可用 ${localDir}',
+  ].join('\n'),
+  remote: [
+    VARS_REFERENCE,
+    '',
+    '示例:',
+    '  cd ${remoteDir} && rm -rf ./*',
+    '  mkdir -p ${remoteDir}src',
+    '  pm2 restart myapp',
+  ].join('\n'),
+  uploadDir: [
+    VARS_REFERENCE,
+    '',
+    '示例:',
+    '  本地: ${localDir}/dist',
+    '  远端: ${remoteDir}',
+  ].join('\n'),
+  uploadFile: [
+    VARS_REFERENCE,
+    '',
+    '示例:',
+    '  本地: ${localDir}/package.json',
+    '  远端: ${remoteDir}package.json',
+  ].join('\n'),
+  downloadDir: [
+    VARS_REFERENCE,
+    '',
+    '示例:',
+    '  远端: ${remoteDir}backup/',
+    '  本地: ${localDir}/backup',
+  ].join('\n'),
+  downloadFile: [
+    VARS_REFERENCE,
+    '',
+    '示例:',
+    '  远端: ${remoteDir}config.json',
+    '  本地: ${localDir}/config.json.bak',
+  ].join('\n'),
+};
+
+/** 步骤类型选项 */
+const STEP_TYPE_OPTIONS = [
+  { value: 'log' as StepType, label: '日志输出', hint: '输出信息' },
+  { value: 'local' as StepType, label: '本地命令', hint: '在本地执行 shell 命令' },
+  { value: 'remote' as StepType, label: '远程命令', hint: '在服务器执行 shell 命令' },
+  { value: 'uploadDir' as StepType, label: '上传目录', hint: '上传整个目录到服务器' },
+  { value: 'uploadFile' as StepType, label: '上传文件', hint: '上传单个文件到服务器' },
+  { value: 'downloadDir' as StepType, label: '下载目录（备份）', hint: '从服务器下载整个目录' },
+  { value: 'downloadFile' as StepType, label: '下载文件（备份）', hint: '从服务器下载单个文件' },
+];
+
+/**
+ * 读取 package.json 的 name 字段作为默认项目名
+ */
+function getDefaultProjectName(cwd: string): string {
+  const pkgPath = resolve(cwd, 'package.json');
+  if (existsSync(pkgPath)) {
+    try {
+      const pkg = JSON.parse(readFileSync(pkgPath, 'utf-8'));
+      if (pkg.name) return pkg.name;
+    } catch { /* 忽略 */ }
+  }
+  return '';
+}
+
+/**
+ * 通过 SFTP 浏览远端目录
+ */
+async function browseRemoteDir(sftp: import('ssh2-sftp-client'), currentPath: string): Promise<string> {
+  while (true) {
+    let entries: import('ssh2-sftp-client').FileInfo[];
+    try {
+      entries = await sftp.list(currentPath);
+    } catch {
+      // 目录不存在，直接返回手动输入的路径
+      return currentPath;
+    }
+
+    const dirOptions = entries
+      .filter((e) => e.type === 'd')
+      .map((e) => ({ value: e.name, label: `📁 ${e.name}` }));
+
+    const choices = [
+      { value: '__confirm__', label: pc.green(`✓ 使用当前目录: ${currentPath}`) },
+      { value: '__manual__', label: pc.yellow('✎ 手动输入路径') },
+      ...dirOptions,
+    ];
+
+    const selected = handleCancel<string>(
+      await clack.select({
+        message: `浏览远端目录: ${currentPath}`,
+        options: choices,
+      })
+    );
+
+    if (selected === '__confirm__') {
+      return currentPath;
+    }
+
+    if (selected === '__manual__') {
+      const input = handleCancel<string>(
+        await clack.text({
+          message: '输入远端目录路径',
+          initialValue: currentPath,
+        })
+      );
+      currentPath = input;
+      continue;
+    }
+
+    // 进入子目录
+    currentPath = currentPath.endsWith('/') ? `${currentPath}${selected}` : `${currentPath}/${selected}`;
+  }
+}
+
+/**
+ * 收集单个步骤
+ */
+async function collectStep(): Promise<Step | null> {
+  const stepType = handleCancel<StepType>(
+    await clack.select({
+      message: '选择步骤类型',
+      options: STEP_TYPE_OPTIONS,
+    })
+  );
+
+  noteBox(STEP_EXAMPLES[stepType], '参考（可直接复制变量）');
+
+  switch (stepType) {
+    case 'log': {
+      const message = handleCancel<string>(
+        await clack.text({ message: '日志信息' })
+      );
+      return { type: 'log', message };
+    }
+    case 'local': {
+      const cmd = handleCancel<string>(
+        await clack.text({ message: '命令' })
+      );
+      const cwd = handleCancel<string>(
+        await clack.text({
+          message: '工作目录（可选，留空使用默认）',
+          placeholder: '${localDir}',
+        })
+      );
+      const step: Step = { type: 'local', cmd };
+      if (cwd) step.cwd = cwd;
+      return step;
+    }
+    case 'remote': {
+      const cmd = handleCancel<string>(
+        await clack.text({ message: '远程命令' })
+      );
+      return { type: 'remote', cmd };
+    }
+    case 'uploadDir': {
+      const local = handleCancel<string>(
+        await clack.text({ message: '本地目录', placeholder: '${localDir}/dist' })
+      );
+      const remote = handleCancel<string>(
+        await clack.text({ message: '远端目录', placeholder: '${remoteDir}' })
+      );
+      return { type: 'uploadDir', local, remote };
+    }
+    case 'uploadFile': {
+      const local = handleCancel<string>(
+        await clack.text({ message: '本地文件路径' })
+      );
+      const remote = handleCancel<string>(
+        await clack.text({ message: '远端文件路径' })
+      );
+      return { type: 'uploadFile', local, remote };
+    }
+    case 'downloadDir': {
+      const remote = handleCancel<string>(
+        await clack.text({ message: '远端目录' })
+      );
+      const local = handleCancel<string>(
+        await clack.text({ message: '本地保存目录' })
+      );
+      return { type: 'downloadDir', remote, local };
+    }
+    case 'downloadFile': {
+      const remote = handleCancel<string>(
+        await clack.text({ message: '远端文件路径' })
+      );
+      const local = handleCancel<string>(
+        await clack.text({ message: '本地保存路径' })
+      );
+      return { type: 'downloadFile', remote, local };
+    }
+  }
+}
+
+/**
+ * 运行 deploy init 主流程
+ * @param targetPath 项目目录（缺省 cwd），生成的 deploy.config.json 写入此目录
+ */
+export async function runInit(targetPath?: string): Promise<void> {
+  clack.intro('deploy init');
+
+  const cwd = resolve(targetPath ?? '.');
+
+  const deployConfig = getConfig();
+
+  // 1. 项目名称
+  const defaultName = getDefaultProjectName(cwd);
+  const name = handleCancel<string>(
+    await clack.text({
+      message: '项目显示名称',
+      initialValue: defaultName,
+    })
+  );
+
+  // 2. 检查是否有可用服务器
+  const serverIds = Object.keys(deployConfig.servers);
+  if (serverIds.length === 0) {
+    clack.log.error('没有已配置的服务器，请先运行 deploy server add 添加服务器');
+    clack.outro('请先配置服务器');
+    return;
+  }
+
+  // 3. 选择目标服务器
+  const serverId = handleCancel<string>(
+    await clack.select({
+      message: '选择目标服务器',
+      options: serverIds.map((id) => ({
+        value: id,
+        label: `${id} (${deployConfig.servers[id].host})`,
+      })),
+    })
+  );
+
+  // 4. 本地目录（用相对路径 ./，便于跨设备/入库）
+  const localDir = handleCancel<string>(
+    await clack.text({
+      message: '本地目录（相对 deploy.config.json，默认 ./）',
+      initialValue: './',
+    })
+  );
+
+  // 5. 远端目录
+  const spinner = clack.spinner();
+  spinner.start('连接服务器...');
+  let sftp: import('ssh2-sftp-client');
+  try {
+    sftp = await connectSftp('init', deployConfig.servers[serverId]);
+    spinner.stop('已连接');
+  } catch (err) {
+    spinner.stop('连接失败');
+    clack.log.error(`无法连接服务器: ${err}`);
+    clack.outro('连接失败');
+    return;
+  }
+
+  let remoteDir: string;
+  try {
+    const browseChoice = handleCancel<'browse' | 'manual'>(
+      await clack.select({
+        message: '远端目录设置方式',
+        options: [
+          { value: 'browse', label: '浏览服务器目录' },
+          { value: 'manual', label: '手动输入路径' },
+        ],
+      })
+    );
+
+    if (browseChoice === 'browse') {
+      remoteDir = await browseRemoteDir(sftp, '/');
+    } else {
+      remoteDir = handleCancel<string>(
+        await clack.text({
+          message: '远端目录路径',
+          placeholder: '/appliction/my-app/',
+        })
+      );
+      // 确保目录存在（循环创建）
+      const confirmMkdir = handleCancel<boolean>(
+        await clack.confirm({ message: `是否自动创建目录 ${remoteDir}（如果不存在）？` })
+      );
+      if (confirmMkdir) {
+        await sftp.mkdir(remoteDir, true);
+        clack.log.success(`目录已创建: ${remoteDir}`);
+      }
+    }
+  } finally {
+    await sftp.end();
+  }
+
+  // 6. 收集步骤
+  const steps: Step[] = [];
+  clack.log.info('开始配置部署步骤（每个步骤会展示参考和可用变量）');
+
+  while (true) {
+    if (steps.length > 0) {
+      const action = handleCancel<'add' | 'done'>(
+        await clack.select({
+          message: `已配置 ${steps.length} 个步骤`,
+          options: [
+            { value: 'add', label: '添加步骤' },
+            { value: 'done', label: '完成配置' },
+          ],
+        })
+      );
+      if (action === 'done') break;
+    }
+
+    const step = await collectStep();
+    if (step) {
+      steps.push(step);
+      showStepsSummary(steps);
+    }
+  }
+
+  // 7. 预览配置
+  const projectConfig: ProjectConfig = {
+    name,
+    localDir,
+    server: serverId,
+    remoteDir,
+    steps,
+  };
+
+  noteBox(JSON.stringify(projectConfig, null, 2), '项目配置预览');
+
+  const confirmSave = handleCancel<boolean>(
+    await clack.confirm({ message: '确认保存此配置？' })
+  );
+
+  if (confirmSave) {
+    saveProjectConfig(projectConfig, cwd);
+    clack.log.success(`配置已写入 ${resolve(cwd, 'deploy.config.json')}`);
+  } else {
+    clack.log.info('已取消保存');
+  }
+
+  clack.outro('完成');
+}

package/src/script/parser.ts

@@ -0,0 +1,28 @@
+import type { ProjectConfig } from '../config/schema.js';
+
+/**
+ * 内置变量名
+ */
+const BUILT_IN_VARS = ['localDir', 'remoteDir', 'projectName'] as const;
+
+/**
+ * 替换字符串中的 ${varName} 占位符
+ */
+export function resolveVariables(template: string, project: ProjectConfig): string {
+  const vars: Record<string, string> = {
+    localDir: project.localDir,
+    remoteDir: project.remoteDir,
+    projectName: project.name,
+  };
+
+  return template.replace(/\$\{(\w+)\}/g, (match, key: string) => {
+    return vars[key] !== undefined ? vars[key] : match;
+  });
+}
+
+/**
+ * 获取可用变量列表（用于提示）
+ */
+export function getAvailableVariables(): string[] {
+  return [...BUILT_IN_VARS];
+}

package/src/script/runner.ts

@@ -0,0 +1,88 @@
+import type SftpClient from 'ssh2-sftp-client';
+import spawn from 'cross-spawn';
+import type { Step, ProjectConfig } from '../config/schema.js';
+import { resolveVariables } from './parser.js';
+import { execRemote } from '../ssh/executor.js';
+
+/**
+ * 在本地执行命令
+ */
+function runLocal(cmd: string, cwd?: string): Promise<void> {
+  return new Promise((resolve, reject) => {
+    const cp = spawn(cmd, [], {
+      cwd,
+      detached: false,
+      shell: true,
+    });
+    if (cp.stdout) cp.stdout.pipe(process.stdout);
+    if (cp.stderr) cp.stderr.pipe(process.stderr);
+    cp.on('close', (code) => {
+      if (code === 0) {
+        resolve();
+      } else {
+        reject(new Error(`本地命令执行失败 (code=${code}): ${cmd}`));
+      }
+    });
+    cp.on('error', (err) => {
+      reject(err);
+    });
+  });
+}
+
+/**
+ * 执行单个步骤
+ */
+async function runStep(step: Step, project: ProjectConfig, sftp: SftpClient): Promise<void> {
+  switch (step.type) {
+    case 'log': {
+      const msg = resolveVariables(step.message, project);
+      console.log(msg);
+      break;
+    }
+    case 'local': {
+      const cmd = resolveVariables(step.cmd, project);
+      const cwd = step.cwd ? resolveVariables(step.cwd, project) : undefined;
+      await runLocal(cmd, cwd);
+      break;
+    }
+    case 'remote': {
+      const cmd = resolveVariables(step.cmd, project);
+      await execRemote(sftp, cmd);
+      break;
+    }
+    case 'uploadDir': {
+      const local = resolveVariables(step.local, project);
+      const remote = resolveVariables(step.remote, project);
+      await sftp.mkdir(remote, true);
+      await sftp.uploadDir(local, remote, { useFastput: true });
+      break;
+    }
+    case 'uploadFile': {
+      const local = resolveVariables(step.local, project);
+      const remote = resolveVariables(step.remote, project);
+      await sftp.fastPut(local, remote);
+      break;
+    }
+    case 'downloadDir': {
+      const remote = resolveVariables(step.remote, project);
+      const local = resolveVariables(step.local, project);
+      await sftp.downloadDir(remote, local);
+      break;
+    }
+    case 'downloadFile': {
+      const remote = resolveVariables(step.remote, project);
+      const local = resolveVariables(step.local, project);
+      await sftp.fastGet(remote, local);
+      break;
+    }
+  }
+}
+
+/**
+ * 执行项目的所有步骤
+ */
+export async function runSteps(steps: Step[], project: ProjectConfig, sftp: SftpClient): Promise<void> {
+  for (const step of steps) {
+    await runStep(step, project, sftp);
+  }
+}