fe-build-cli 1.1.0

package/src/cli.js

@@ -0,0 +1,492 @@
+#!/usr/bin/env node
+
+import { createInterface } from 'node:readline';
+import { execSync } from 'node:child_process';
+import fs from 'node:fs';
+import path from 'node:path';
+import { fileURLToPath, pathToFileURL } from 'node:url';
+import { deployToServer, rollbackDeployment } from './deploy-core.js';
+import {
+  getCurrentBranch,
+  getGitSha,
+  executeMainBranchFlow,
+  executeCurrentBranchFlow,
+  restoreBranch
+} from './git-branch.js';
+import {
+  sendDeploySuccessNotification,
+  sendDeployFailureNotification,
+  sendRollbackNotification
+} from './dingtalk.js';
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+
+/**
+ * 交互式提示
+ */
+function prompt(question) {
+  const rl = createInterface({
+    input: process.stdin,
+    output: process.stdout
+  });
+  return new Promise(resolve => {
+    rl.question(question, answer => {
+      rl.close();
+      resolve(answer.trim());
+    });
+  });
+}
+
+/**
+ * 获取配置文件路径
+ * 优先级：命令行参数 > 当前目录 > 项目根目录
+ */
+function getConfigPath() {
+  // 命令行参数 --config 指定的路径
+  const configIndex = process.argv.indexOf('--config');
+  if (configIndex !== -1 && process.argv[configIndex + 1]) {
+    return path.resolve(process.argv[configIndex + 1]);
+  }
+
+  // 当前目录下的 fe-build.config.js
+  const localConfig = path.join(process.cwd(), 'fe-build.config.js');
+  if (fs.existsSync(localConfig)) {
+    return localConfig;
+  }
+
+  // scripts 目录下的 deploy.config.js（兼容旧项目）
+  const scriptsConfig = path.join(process.cwd(), 'scripts', 'deploy.config.js');
+  if (fs.existsSync(scriptsConfig)) {
+    return scriptsConfig;
+  }
+
+  return null;
+}
+
+/**
+ * 加载配置文件
+ */
+async function loadConfig() {
+  const configPath = getConfigPath();
+
+  if (!configPath) {
+    console.error('❌ 未找到配置文件!');
+    console.error('请创建 fe-build.config.js 或使用 --config 参数指定配置文件路径');
+    console.error('\n配置文件示例:');
+    console.error(`
+export default {
+  // 分支配置（可选，用于主分支发布模式）
+  branches: {
+    test: 'test',      // 测试分支名
+    main: 'main'       // 主分支名
+  },
+  // 发布模式: 'main' (主分支发布) 或 'current' (当前分支发布)
+  deployMode: 'main',
+  // 服务器配置
+  servers: {
+    production: {
+      sshHost: 'your-server.com',
+      sshUser: 'deployer',
+      sshKeyPath: '~/.ssh/id_rsa',
+      deployUrl: 'https://your-domain.com',
+      backupDir: '/www/backups/your-app',
+      deployDir: '/www/your-app',
+      backupPrefix: 'backup',
+      buildMode: 'production',
+      protectedDirs: ['webgl']
+    }
+  }
+};
+    `);
+    process.exit(1);
+  }
+
+  console.log(`📄 使用配置文件: ${configPath}`);
+
+  try {
+    // Windows 下需要将路径转换为 file:// URL
+    const configUrl = pathToFileURL(configPath).href;
+    const config = (await import(configUrl)).default;
+    return config;
+  } catch (error) {
+    console.error(`❌ 加载配置文件失败: ${error.message}`);
+    process.exit(1);
+  }
+}
+
+/**
+ * 从配置中获取服务器列表
+ */
+function getServerNames(config) {
+  // 新格式：servers 对象
+  if (config.servers) {
+    return Object.keys(config.servers).filter(k => config.servers[k].sshHost !== undefined);
+  }
+  // 旧格式兼容：直接在根对象配置服务器
+  return Object.keys(config).filter(k => config[k].sshHost !== undefined);
+}
+
+/**
+ * 获取服务器配置
+ */
+function getServerConfig(config, serverName) {
+  if (config.servers) {
+    return config.servers[serverName];
+  }
+  return config[serverName];
+}
+
+/**
+ * 生成构建版本号
+ */
+function generateBuildVersion() {
+  const timestamp = new Date().toISOString().replace(/[:.]/g, '').slice(0, 15);
+  let gitSha = 'local';
+  try {
+    gitSha = execSync('git rev-parse --short HEAD', { encoding: 'utf-8' }).trim();
+  } catch (e) {
+    // 忽略
+  }
+  return `build-${timestamp}-${gitSha}`;
+}
+
+/**
+ * 显示帮助信息
+ */
+function showHelp() {
+  console.log(`
+fe-build-cli - 前端项目打包部署工具
+
+用法:
+  fe-build [命令] [选项]
+
+命令:
+  deploy [环境]     部署到指定环境（默认命令）
+  rollback [环境]   回滚到上一版本
+  help              显示帮助信息
+
+选项:
+  --config <路径>    指定配置文件路径
+  --current-branch   使用当前分支发布（不切换分支）
+  --main-branch      使用主分支发布流程（合并到测试分支再合并到主分支）
+  --skip-build       跳过构建步骤
+  --no-push          主分支发布时不推送到远程
+
+示例:
+  fe-build                    # 交互式选择环境部署
+  fe-build deploy production  # 部署到生产环境
+  fe-build deploy all         # 部署到所有环境
+  fe-build --current-branch   # 当前分支发布
+  fe-build --main-branch      # 主分支发布流程
+  fe-build rollback production # 回滚生产环境
+
+配置文件 (fe-build.config.js):
+  export default {
+    // 分支配置
+    branches: {
+      test: 'test',      // 测试分支名
+      main: 'main'       // 主分支名
+    },
+    // 发布模式: 'main' 或 'current'
+    deployMode: 'main',
+    // 服务器配置
+    servers: {
+      production: {
+        sshHost: 'server.com',
+        sshUser: 'deployer',
+        sshKeyPath: '~/.ssh/id_rsa',
+        deployUrl: 'https://domain.com',
+        backupDir: '/www/backups/app',
+        deployDir: '/www/app',
+        backupPrefix: 'backup',
+        buildMode: 'production',
+        protectedDirs: ['webgl']
+      }
+    }
+  };
+`);
+}
+
+/**
+ * 主部署命令
+ */
+async function deployCommand(config) {
+  const serverNames = getServerNames(config);
+
+  if (serverNames.length === 0) {
+    console.error('❌ 配置文件中没有找到服务器配置');
+    process.exit(1);
+  }
+
+  // 解析命令行参数
+  const args = process.argv.slice(2);
+  const useCurrentBranch = args.includes('--current-branch');
+  const useMainBranch = args.includes('--main-branch');
+  const skipBuild = args.includes('--skip-build');
+  const noPush = args.includes('--no-push');
+
+  // 确定发布模式
+  let deployMode = config.deployMode || 'main'; // 默认主分支发布
+
+  if (useCurrentBranch) {
+    deployMode = 'current';
+  } else if (useMainBranch) {
+    deployMode = 'main';
+  }
+
+  // 获取目标环境（排除 deploy 命令本身）
+  const argEnv = args.find(arg => arg !== 'deploy' && !arg.startsWith('--'));
+  let selectedServers = [];
+
+  const validArgs = [...serverNames, 'all'];
+  if (argEnv && validArgs.includes(argEnv)) {
+    selectedServers = argEnv === 'all' ? serverNames : [argEnv];
+  } else {
+    // 交互式选择
+    console.log('\n========================================');
+    console.log('  🚀 请选择部署目标');
+    console.log('========================================');
+    serverNames.forEach((name, i) => {
+      const envConfig = getServerConfig(config, name);
+      const label = envConfig ? `${name} - ${envConfig.deployUrl || envConfig.sshHost}` : name;
+      console.log(`  ${i + 1}. ${label}`);
+    });
+    console.log(`  ${serverNames.length + 1}. 全部服务器`);
+    console.log('========================================');
+
+    const answer = await prompt(`请输入选项 (1-${serverNames.length + 1}): `);
+    const choiceIdx = parseInt(answer, 10);
+    if (choiceIdx >= 1 && choiceIdx <= serverNames.length) {
+      selectedServers = [serverNames[choiceIdx - 1]];
+    } else if (choiceIdx === serverNames.length + 1) {
+      selectedServers = serverNames;
+    } else {
+      console.error('❌ 无效选项');
+      process.exit(1);
+    }
+  }
+
+  // 执行分支发布流程
+  let branchResult = null;
+  let originalBranch = null;
+
+  if (deployMode === 'main' && !skipBuild) {
+    // 主分支发布模式
+    const branches = config.branches || { test: 'test', main: 'main' };
+    console.log('\n========================================');
+    console.log('  🌿 主分支发布模式');
+    console.log('========================================');
+    console.log(`测试分支: ${branches.test}`);
+    console.log(`主分支: ${branches.main}`);
+    console.log('========================================');
+
+    const confirmAnswer = await prompt('确认执行主分支发布流程? (y/n): ');
+    if (confirmAnswer.toLowerCase() !== 'y') {
+      console.log('已取消发布');
+      process.exit(0);
+    }
+
+    branchResult = executeMainBranchFlow({
+      testBranch: branches.test,
+      mainBranch: branches.main,
+      pushToRemote: !noPush
+    });
+    originalBranch = branchResult.originalBranch;
+  } else if (deployMode === 'current') {
+    // 当前分支发布模式
+    branchResult = executeCurrentBranchFlow();
+    originalBranch = branchResult.currentBranch;
+    console.log('📌 当前分支发布模式：不切换分支');
+  }
+
+  // 生成构建版本
+  const buildVersion = generateBuildVersion();
+  const startTime = Date.now();
+
+  // 部署到选中的服务器
+  for (let i = 0; i < selectedServers.length; i++) {
+    const serverName = selectedServers[i];
+    const envConfig = getServerConfig(config, serverName);
+
+    // 校验配置是否完整
+    if (!envConfig || !envConfig.sshHost) {
+      console.error(`❌ ${serverName} 配置不完整，请检查配置文件`);
+      process.exit(1);
+    }
+
+    const isFirst = i === 0;
+
+    console.log('\n========================================');
+    console.log(`开始部署到 ${serverName}`);
+    console.log(`服务器: ${envConfig.sshHost}`);
+    console.log(`构建版本: ${buildVersion}`);
+    if (selectedServers.length > 1) {
+      console.log(`进度: ${i + 1}/${selectedServers.length}`);
+    }
+    console.log('========================================');
+
+    try {
+      await deployToServer({
+        environment: serverName,
+        envConfig,
+        buildVersion,
+        skipBuild: skipBuild || !isFirst,
+        skipLocalCleanup: i < selectedServers.length - 1
+      });
+
+      // 部署成功，发送钉钉通知
+      const duration = Math.round((Date.now() - startTime) / 1000);
+      const currentBranch = getCurrentBranch();
+
+      if (config.dingtalk && config.dingtalk.enabled && config.dingtalk.webhook) {
+        console.log('\n发送钉钉通知...');
+        await sendDeploySuccessNotification(config.dingtalk.webhook, {
+          environment: serverName,
+          buildVersion,
+          serverHost: envConfig.sshHost,
+          deployUrl: envConfig.deployUrl,
+          branch: currentBranch,
+          deployMode,
+          duration: `${duration}秒`
+        });
+      }
+    } catch (error) {
+      console.error(`❌ 部署到 ${serverName} 失败:`, error.message);
+
+      // 部署失败，发送钉钉通知
+      const currentBranch = getCurrentBranch();
+      if (config.dingtalk && config.dingtalk.enabled && config.dingtalk.webhook) {
+        console.log('\n发送钉钉失败通知...');
+        await sendDeployFailureNotification(config.dingtalk.webhook, {
+          environment: serverName,
+          buildVersion,
+          serverHost: envConfig.sshHost,
+          branch: currentBranch,
+          error: error.message
+        });
+      }
+
+      // 如果是主分支发布模式，尝试切回原分支
+      if (originalBranch) {
+        restoreBranch(originalBranch);
+      }
+      process.exit(1);
+    }
+  }
+
+  // 主分支发布模式：部署完成后切回原分支
+  if (deployMode === 'main' && originalBranch) {
+    const returnAnswer = await prompt('\n是否切回原分支? (y/n): ');
+    if (returnAnswer.toLowerCase() === 'y') {
+      restoreBranch(originalBranch);
+    }
+  }
+}
+
+/**
+ * 回滚命令
+ */
+async function rollbackCommand(config) {
+  const serverNames = getServerNames(config);
+
+  if (serverNames.length === 0) {
+    console.error('❌ 配置文件中没有找到服务器配置');
+    process.exit(1);
+  }
+
+  // 获取目标环境（排除 rollback 命令本身）
+  const args = process.argv.slice(2);
+  const environment = args.find(arg => arg !== 'rollback' && !arg.startsWith('--'));
+  const versionIndex = args.indexOf('--version');
+  const specifiedVersion = versionIndex !== -1 ? args[versionIndex + 1] : undefined;
+
+  if (!environment || !serverNames.includes(environment)) {
+    console.error(`❌ 请指定服务器: ${serverNames.join(' 或 ')}`);
+    console.error(`用法: fe-build rollback [${serverNames.join('|')}] [--version <版本号>]`);
+    process.exit(1);
+  }
+
+  const envConfig = getServerConfig(config, environment);
+
+  if (!envConfig || !envConfig.sshHost) {
+    console.error(`❌ ${environment} 配置不完整`);
+    process.exit(1);
+  }
+
+  let backupFile = '';
+  let success = false;
+
+  try {
+    // 执行回滚，获取备份文件信息
+    backupFile = specifiedVersion
+      ? `${envConfig.backupDir}/${envConfig.backupPrefix}-${specifiedVersion}.tar.gz`
+      : '';
+
+    await rollbackDeployment({
+      environment,
+      envConfig,
+      specifiedVersion
+    });
+
+    success = true;
+
+    // 回滚成功，发送钉钉通知
+    if (config.dingtalk && config.dingtalk.enabled && config.dingtalk.webhook) {
+      console.log('\n发送钉钉通知...');
+      await sendRollbackNotification(config.dingtalk.webhook, {
+        environment,
+        backupFile: backupFile || '最新备份',
+        serverHost: envConfig.sshHost,
+        deployUrl: envConfig.deployUrl,
+        success: true
+      });
+    }
+  } catch (error) {
+    console.error('❌ 回滚失败:', error.message);
+    success = false;
+
+    // 回滚失败，发送钉钉通知
+    if (config.dingtalk && config.dingtalk.enabled && config.dingtalk.webhook) {
+      console.log('\n发送钉钉通知...');
+      await sendRollbackNotification(config.dingtalk.webhook, {
+        environment,
+        backupFile: backupFile || '未知',
+        serverHost: envConfig.sshHost,
+        deployUrl: envConfig.deployUrl,
+        success: false
+      });
+    }
+
+    process.exit(1);
+  }
+}
+
+/**
+ * 主入口
+ */
+async function main() {
+  const args = process.argv.slice(2);
+  const command = args[0];
+
+  // 显示帮助
+  if (command === 'help' || args.includes('--help') || args.includes('-h')) {
+    showHelp();
+    process.exit(0);
+  }
+
+  // 加载配置
+  const config = await loadConfig();
+
+  // 执行命令
+  if (command === 'rollback') {
+    await rollbackCommand(config);
+  } else {
+    // 默认执行 deploy
+    await deployCommand(config);
+  }
+}
+
+main().catch(error => {
+  console.error('执行失败:', error);
+  process.exit(1);
+});

package/src/config-template.js

@@ -0,0 +1,83 @@
+import process from 'node:process';
+
+/**
+ * fe-build-cli 配置文件模板
+ * 将此文件复制到项目根目录并重命名为 fe-build.config.js
+ */
+
+export default {
+  /**
+   * 分支配置（用于主分支发布模式）
+   * 当 deployMode 为 'main' 时，会执行以下流程：
+   * 1. 当前分支 -> testBranch（测试分支）
+   * 2. testBranch -> mainBranch（主分支）
+   */
+  branches: {
+    test: 'test',      // 测试分支名，根据项目实际情况修改
+    main: 'main'       // 主分支名，根据项目实际情况修改
+  },
+
+  /**
+   * 发布模式
+   * - 'main': 主分支发布模式（默认）
+   *   流程：当前分支 -> 测试分支 -> 主分支，然后从主分支发布
+   * - 'current': 当前分支发布模式
+   *   直接从当前分支发布，不切换分支
+   */
+  deployMode: 'main',
+
+  /**
+   * 服务器配置
+   * 可以配置多个服务器环境
+   */
+  servers: {
+    // 生产环境示例
+    production: {
+      // SSH 连接配置
+      sshHost: 'your-server-ip-or-domain',  // 服务器 IP 或域名
+      sshUser: 'deployer',                   // SSH 用户名
+      sshKeyPath: `${process.env.USERPROFILE || process.env.HOME}/.ssh/id_rsa`, // SSH 私钥路径
+
+      // 部署配置
+      deployUrl: 'https://your-domain.com',  // 部署后的访问地址
+      backupDir: '/www/wwwroot/backups/your-app',  // 备份目录
+      deployDir: '/www/wwwroot/your-app',    // 部署目录
+      backupPrefix: 'backup-production',     // 备份文件前缀
+
+      // 构建配置
+      buildMode: 'production',               // 构建模式：production 或 test
+      buildCommand: 'yarn build',            // 自定义构建命令（可选，默认根据 buildMode 自动选择）
+
+      // 需要保护的目录（部署时不会被删除）
+      protectedDirs: ['webgl', 'uploads']    // 例如：webgl、uploads 等静态资源目录
+    },
+
+    // 测试环境示例
+    test: {
+      sshHost: 'test-server-ip',
+      sshUser: 'deployer',
+      sshKeyPath: `${process.env.USERPROFILE || process.env.HOME}/.ssh/id_rsa`,
+      deployUrl: 'https://test.your-domain.com',
+      backupDir: '/www/wwwroot/backups/test-app',
+      deployDir: '/www/wwwroot/test-app',
+      backupPrefix: 'backup-test',
+      buildMode: 'test',
+      protectedDirs: ['webgl']
+    }
+  },
+
+  /**
+   * 备份保留数量（可选）
+   * 默认保留最新的 1 个备份
+   */
+  backupRetentionCount: 1,
+
+  /**
+   * 钉钉通知配置（可选）
+   * 部署完成后自动发送钉钉消息通知
+   */
+  dingtalk: {
+    webhook: 'https://oapi.dingtalk.com/robot/send?access_token=your-token', // 钉钉机器人 webhook URL
+    enabled: true  // 是否启用钉钉通知，默认 true
+  }
+};