fe-build-cli 1.2.4 → 1.5.0

package/src/git-branch.js

@@ -1,8 +1,10 @@
 import { execSync } from 'node:child_process';
+import { DeployLogger } from './logger.js';
 
 /**
  * Git 分支管理模块
  * 支持当前分支发布和主分支发布两种模式
+ * 集成日志记录，记录每一步操作及状态
  */
 
 /**
@@ -30,6 +32,32 @@ export function getGitSha() {
   }
 }
 
+/**
+ * 获取最近一次 Git 提交信息
+ * @returns {string} 提交信息
+ */
+export function getGitCommitMessage() {
+  try {
+    return execSync('git log -1 --pretty=format:"%s"', { encoding: 'utf-8' }).trim();
+  } catch (error) {
+    return '';
+  }
+}
+
+/**
+ * 获取最近 N 次 Git 提交信息
+ * @param {number} count - 提交数量
+ * @returns {string} 提交信息列表
+ */
+export function getGitCommitMessages(count = 3) {
+  try {
+    const messages = execSync(`git log -${count} --pretty=format:"%s"`, { encoding: 'utf-8' }).trim();
+    return messages.split('\n').map(m => `- ${m}`).join('\n');
+  } catch (error) {
+    return '';
+  }
+}
+
 /**
  * 检查工作区是否干净
  * @returns {boolean} 是否干净
@@ -63,13 +91,25 @@ export function checkUncommittedChanges() {
 /**
  * 切换到指定分支
  * @param {string} branchName - 分支名
+ * @param {DeployLogger} logger - 日志记录器（可选）
  */
-export function checkoutBranch(branchName) {
+export function checkoutBranch(branchName, logger = null) {
+  const fromBranch = getCurrentBranch();
   try {
     console.log(`\n📌 切换到分支: ${branchName}`);
     execSync(`git checkout ${branchName}`, { stdio: 'inherit' });
     console.log(`✅ 已切换到 ${branchName}`);
+    
+    // 记录日志
+    if (logger) {
+      logger.logBranch('切换分支', fromBranch, branchName, true);
+    }
+    return true;
   } catch (error) {
+    // 记录失败日志
+    if (logger) {
+      logger.logBranch('切换分支', fromBranch, branchName, false, error.message);
+    }
     throw new Error(`切换到分支 ${branchName} 失败: ${error.message}`);
   }
 }
@@ -92,16 +132,28 @@ export function pullBranch(branchName) {
  * 合并分支
  * @param {string} sourceBranch - 源分支
  * @param {string} targetBranch - 目标分支（当前所在分支）
+ * @param {DeployLogger} logger - 日志记录器（可选）
  * @returns {boolean} 是否成功
  */
-export function mergeBranch(sourceBranch, targetBranch) {
+export function mergeBranch(sourceBranch, targetBranch, logger = null) {
   try {
     console.log(`\n🔀 合并 ${sourceBranch} 到 ${targetBranch}...`);
     execSync(`git merge ${sourceBranch} --no-edit`, { stdio: 'inherit' });
     console.log(`✅ 合并成功`);
+    
+    // 记录日志
+    if (logger) {
+      logger.logMerge(sourceBranch, targetBranch, true);
+    }
     return true;
   } catch (error) {
     console.error(`❌ 合并失败: ${error.message}`);
+    
+    // 记录失败日志
+    if (logger) {
+      logger.logMerge(sourceBranch, targetBranch, false, true);
+    }
+    
     // 尝试中止合并
     try {
       execSync('git merge --abort', { stdio: 'inherit' });
@@ -130,9 +182,10 @@ export function pushBranch(branchName) {
 /**
  * 储藏本地改动（stash）
  * @param {string} branchName - 当前分支名（用于备注）
+ * @param {DeployLogger} logger - 日志记录器（可选）
  * @returns {boolean} 是否成功
  */
-export function stashChanges(branchName = '') {
+export function stashChanges(branchName = '', logger = null) {
   try {
     console.log('\n📦 储藏本地改动...');
     const stashMessage = branchName
@@ -140,26 +193,47 @@ export function stashChanges(branchName = '') {
       : 'fe-build-cli-auto-stash';
     execSync(`git stash push -m "${stashMessage}"`, { stdio: 'inherit' });
     console.log('✅ 本地改动已储藏');
+    
+    // 记录日志
+    if (logger) {
+      logger.logStash('储藏改动', true, `分支: ${branchName || getCurrentBranch()}`);
+    }
     return true;
   } catch (error) {
     console.error('❌ 储藏失败:', error.message);
+    
+    // 记录失败日志
+    if (logger) {
+      logger.logStash('储藏改动', false, error.message);
+    }
     return false;
   }
 }
 
 /**
  * 恢复储藏的改动（stash pop）
+ * @param {DeployLogger} logger - 日志记录器（可选）
  * @returns {boolean} 是否成功
  */
-export function stashPop() {
+export function stashPop(logger = null) {
   try {
     console.log('\n📦 恢复储藏的改动...');
     execSync('git stash pop', { stdio: 'inherit' });
     console.log('✅ 本地改动已恢复');
+    
+    // 记录日志
+    if (logger) {
+      logger.logStash('恢复改动', true);
+    }
     return true;
   } catch (error) {
     console.error('❌ 恢复失败:', error.message);
     console.log('💡 提示: 可能存在冲突，请手动执行 git stash pop 解决');
+    
+    // 记录失败日志
+    if (logger) {
+      logger.logStash('恢复改动', false, error.message);
+    }
     return false;
   }
 }
@@ -167,9 +241,11 @@ export function stashPop() {
 /**
  * 自动提交当前分支的所有改动
  * @param {string} message - 提交信息
+ * @param {DeployLogger} logger - 日志记录器（可选）
  * @returns {boolean} 是否成功
  */
-export function autoCommit(message) {
+export function autoCommit(message, logger = null) {
+  const currentBranch = getCurrentBranch();
   try {
     console.log('\n📝 自动提交改动...');
     // 添加所有改动
@@ -177,9 +253,19 @@ export function autoCommit(message) {
     // 提交
     execSync(`git commit -m "${message}"`, { stdio: 'inherit' });
     console.log('✅ 改动已提交');
+    
+    // 记录日志
+    if (logger) {
+      logger.log('SUCCESS', '自动提交', `分支: ${currentBranch}, 提交信息: ${message}`);
+    }
     return true;
   } catch (error) {
     console.error('❌ 提交失败:', error.message);
+    
+    // 记录失败日志
+    if (logger) {
+      logger.log('ERROR', '自动提交', `分支: ${currentBranch}, 错误: ${error.message}`);
+    }
     return false;
   }
 }
@@ -191,10 +277,11 @@ export function autoCommit(message) {
  * @param {string} config.testBranch - 测试分支名
  * @param {string} config.mainBranch - 主分支名
  * @param {boolean} config.pushToRemote - 是否推送到远程
+ * @param {DeployLogger} config.logger - 日志记录器（可选）
  * @returns {object} 执行结果
  */
 export function executeMainBranchFlow(config) {
-  const { testBranch, mainBranch, pushToRemote = true } = config;
+  const { testBranch, mainBranch, pushToRemote = true, logger = null } = config;
   const originalBranch = getCurrentBranch();
 
   console.log('\n========================================');
@@ -205,21 +292,29 @@ export function executeMainBranchFlow(config) {
   console.log(`主分支: ${mainBranch}`);
   console.log('========================================');
 
+  // 记录开始日志
+  if (logger) {
+    logger.log('INFO', '主分支发布流程', `当前分支: ${originalBranch}, 测试分支: ${testBranch}, 主分支: ${mainBranch}`);
+  }
+
   // 检查工作区状态
   const { clean, changes } = checkUncommittedChanges();
   if (!clean) {
     console.error('❌ 工作区有未提交的更改:');
     changes.forEach(change => console.log(`  ${change}`));
+    if (logger) {
+      logger.log('ERROR', '工作区检查', '存在未提交的更改');
+    }
     throw new Error('请先提交或暂存更改后再执行发布');
   }
 
   try {
     // 步骤1: 切换到测试分支并拉取最新代码
-    checkoutBranch(testBranch);
+    checkoutBranch(testBranch, logger);
     pullBranch(testBranch);
 
     // 步骤2: 合并当前分支到测试分支
-    if (!mergeBranch(originalBranch, testBranch)) {
+    if (!mergeBranch(originalBranch, testBranch, logger)) {
       throw new Error(`合并 ${originalBranch} 到 ${testBranch} 失败`);
     }
 
@@ -229,11 +324,11 @@ export function executeMainBranchFlow(config) {
     }
 
     // 步骤4: 切换到主分支并拉取最新代码
-    checkoutBranch(mainBranch);
+    checkoutBranch(mainBranch, logger);
     pullBranch(mainBranch);
 
     // 步骤5: 合并测试分支到主分支
-    if (!mergeBranch(testBranch, mainBranch)) {
+    if (!mergeBranch(testBranch, mainBranch, logger)) {
       throw new Error(`合并 ${testBranch} 到 ${mainBranch} 失败`);
     }
 
@@ -247,6 +342,10 @@ export function executeMainBranchFlow(config) {
     console.log(`当前分支: ${mainBranch}`);
     console.log('========================================');
 
+    if (logger) {
+      logger.log('SUCCESS', '主分支发布流程', `完成，当前分支: ${mainBranch}`);
+    }
+
     return {
       success: true,
       originalBranch,
@@ -257,7 +356,7 @@ export function executeMainBranchFlow(config) {
   } catch (error) {
     // 出错时尝试切回原分支
     try {
-      checkoutBranch(originalBranch);
+      checkoutBranch(originalBranch, logger);
     } catch (e) {
       // 忽略
     }
@@ -268,9 +367,10 @@ export function executeMainBranchFlow(config) {
 /**
  * 执行当前分支发布流程
  * 不切换分支，直接在当前分支发布
+ * @param {DeployLogger} logger - 日志记录器（可选）
  * @returns {object} 执行结果
  */
-export function executeCurrentBranchFlow() {
+export function executeCurrentBranchFlow(logger = null) {
   const currentBranch = getCurrentBranch();
   const gitSha = getGitSha();
 
@@ -281,6 +381,11 @@ export function executeCurrentBranchFlow() {
   console.log(`提交 SHA: ${gitSha}`);
   console.log('========================================');
 
+  // 记录日志
+  if (logger) {
+    logger.log('INFO', '当前分支发布', `分支: ${currentBranch}, SHA: ${gitSha}`);
+  }
+
   return {
     success: true,
     originalBranch: currentBranch,
@@ -296,10 +401,11 @@ export function executeCurrentBranchFlow() {
  * @param {boolean} config.mergeChanges - 是否合并本地改动
  * @param {boolean} config.pushToRemote - 是否推送到远程
  * @param {function} config.prompt - 交互提示函数
+ * @param {DeployLogger} config.logger - 日志记录器（可选）
  * @returns {object} 执行结果
  */
 export async function executeTestBranchFlow(config) {
-  const { testBranch, mergeChanges, pushToRemote = true, prompt } = config;
+  const { testBranch, mergeChanges, pushToRemote = true, prompt, logger = null } = config;
   const originalBranch = getCurrentBranch();
   const { clean, changes } = checkUncommittedChanges();
 
@@ -311,10 +417,18 @@ export async function executeTestBranchFlow(config) {
   console.log(`工作区状态: ${clean ? '干净' : '有未提交改动'}`);
   console.log('========================================');
 
+  // 记录开始日志
+  if (logger) {
+    logger.log('INFO', 'Test 环境发布', `当前分支: ${originalBranch}, Test 分支: ${testBranch}, 工作区状态: ${clean ? '干净' : '有改动'}`);
+  }
+
   // 情况1：当前分支本身就是 test
   if (originalBranch === testBranch) {
     console.log('\n✓ 当前已在 test 分支');
     pullBranch(testBranch);
+    if (logger) {
+      logger.log('INFO', 'Test 发布', '当前已在 test 分支，拉取最新代码');
+    }
     return {
       success: true,
       originalBranch,
@@ -327,7 +441,7 @@ export async function executeTestBranchFlow(config) {
   // 情况2：当前分支 ≠ test，无本地改动
   if (clean) {
     console.log('\n✓ 无本地改动，直接切换发布');
-    checkoutBranch(testBranch);
+    checkoutBranch(testBranch, logger);
     pullBranch(testBranch);
     return {
       success: true,
@@ -343,11 +457,15 @@ export async function executeTestBranchFlow(config) {
   console.log('\n⚠️ 存在未提交的改动:');
   changes.forEach(change => console.log(`  ${change}`));
 
+  if (logger) {
+    logger.log('WARN', '工作区检查', `存在未提交改动: ${changes.length} 个文件`);
+  }
+
   // 如果已确定合并选项，直接执行
   if (mergeChanges === true) {
-    return await executeTestMergeFlow(originalBranch, testBranch, pushToRemote);
+    return await executeTestMergeFlow(originalBranch, testBranch, pushToRemote, logger);
   } else if (mergeChanges === false) {
-    return await executeTestStashFlow(originalBranch, testBranch);
+    return await executeTestStashFlow(originalBranch, testBranch, logger);
   }
 
   // 否则交互询问
@@ -359,9 +477,9 @@ export async function executeTestBranchFlow(config) {
     const answer = await prompt('请输入选项 (1/2): ');
 
     if (answer === '1') {
-      return await executeTestMergeFlow(originalBranch, testBranch, pushToRemote);
+      return await executeTestMergeFlow(originalBranch, testBranch, pushToRemote, logger);
     } else if (answer === '2') {
-      return await executeTestStashFlow(originalBranch, testBranch);
+      return await executeTestStashFlow(originalBranch, testBranch, logger);
     } else {
       throw new Error('无效选项，已取消发布');
     }
@@ -372,38 +490,52 @@ export async function executeTestBranchFlow(config) {
 
 /**
  * 执行合并流程（提交当前分支，合并到 test）
+ * @param {string} originalBranch - 原分支名
+ * @param {string} testBranch - test 分支名
+ * @param {boolean} pushToRemote - 是否推送到远程
+ * @param {DeployLogger} logger - 日志记录器（可选）
  */
-async function executeTestMergeFlow(originalBranch, testBranch, pushToRemote) {
+async function executeTestMergeFlow(originalBranch, testBranch, pushToRemote, logger = null) {
   console.log('\n========================================');
   console.log('  🔀 合并改动发布模式');
   console.log('========================================');
 
+  if (logger) {
+    logger.log('INFO', '合并发布模式', `原分支: ${originalBranch}, Test 分支: ${testBranch}`);
+  }
+
   try {
     // 1. 自动提交当前分支改动（备注包含原分支名）
     const commitMessage = `auto commit: deploy test from ${originalBranch}`;
-    if (!autoCommit(commitMessage)) {
+    if (!autoCommit(commitMessage, logger)) {
       throw new Error('自动提交失败');
     }
 
     // 2. 推送当前分支到远程
     if (pushToRemote) {
       pushBranch(originalBranch);
+      if (logger) {
+        logger.log('SUCCESS', '推送分支', `推送 ${originalBranch} 到远程成功`);
+      }
     }
 
     // 3. 切换到 test 分支
-    checkoutBranch(testBranch);
+    checkoutBranch(testBranch, logger);
     pullBranch(testBranch);
 
     // 4. 合并当前分支到 test
-    if (!mergeBranch(originalBranch, testBranch)) {
+    if (!mergeBranch(originalBranch, testBranch, logger)) {
       // 合并冲突，切回原分支
-      checkoutBranch(originalBranch);
+      checkoutBranch(originalBranch, logger);
       throw new Error(`合并冲突: ${originalBranch} 到 ${testBranch}，请手动解决冲突后重新发布`);
     }
 
     // 5. 推送 test 分支
     if (pushToRemote) {
       pushBranch(testBranch);
+      if (logger) {
+        logger.log('SUCCESS', '推送分支', `推送 ${testBranch} 到远程成功`);
+      }
     }
 
     console.log('\n========================================');
@@ -411,6 +543,10 @@ async function executeTestMergeFlow(originalBranch, testBranch, pushToRemote) {
     console.log(`当前分支: ${testBranch}`);
     console.log('========================================');
 
+    if (logger) {
+      logger.log('SUCCESS', '合并发布流程', `完成，当前分支: ${testBranch}`);
+    }
+
     return {
       success: true,
       originalBranch,
@@ -421,9 +557,14 @@ async function executeTestMergeFlow(originalBranch, testBranch, pushToRemote) {
       autoRestore: true  // 合并模式自动切回
     };
   } catch (error) {
+    // 记录错误日志
+    if (logger) {
+      logger.log('ERROR', '合并发布流程', error.message);
+    }
+    
     // 出错时切回原分支
     try {
-      checkoutBranch(originalBranch);
+      checkoutBranch(originalBranch, logger);
     } catch (e) {
       // 忽略
     }
@@ -433,20 +574,27 @@ async function executeTestMergeFlow(originalBranch, testBranch, pushToRemote) {
 
 /**
  * 执行暂存流程（stash 储藏，用纯净 test 发布）
+ * @param {string} originalBranch - 原分支名
+ * @param {string} testBranch - test 分支名
+ * @param {DeployLogger} logger - 日志记录器（可选）
  */
-async function executeTestStashFlow(originalBranch, testBranch) {
+async function executeTestStashFlow(originalBranch, testBranch, logger = null) {
   console.log('\n========================================');
   console.log('  📦 暂存改动发布模式');
   console.log('========================================');
 
+  if (logger) {
+    logger.log('INFO', '暂存发布模式', `原分支: ${originalBranch}, Test 分支: ${testBranch}`);
+  }
+
   try {
     // 1. 储藏本地改动（备注包含原分支名）
-    if (!stashChanges(originalBranch)) {
+    if (!stashChanges(originalBranch, logger)) {
       throw new Error('储藏改动失败');
     }
 
     // 2. 切换到 test 分支
-    checkoutBranch(testBranch);
+    checkoutBranch(testBranch, logger);
     pullBranch(testBranch);
 
     console.log('\n========================================');
@@ -454,6 +602,10 @@ async function executeTestStashFlow(originalBranch, testBranch) {
     console.log(`当前分支: ${testBranch}`);
     console.log('========================================');
 
+    if (logger) {
+      logger.log('SUCCESS', '暂存发布流程', `完成，当前分支: ${testBranch}`);
+    }
+
     return {
       success: true,
       originalBranch,
@@ -463,10 +615,15 @@ async function executeTestStashFlow(originalBranch, testBranch) {
       autoRestore: false  // stash 模式询问是否切回
     };
   } catch (error) {
+    // 记录错误日志
+    if (logger) {
+      logger.log('ERROR', '暂存发布流程', error.message);
+    }
+    
     // 出错时切回原分支并恢复 stash
     try {
-      checkoutBranch(originalBranch);
-      stashPop();
+      checkoutBranch(originalBranch, logger);
+      stashPop(logger);
     } catch (e) {
       // 忽略
     }
@@ -478,18 +635,18 @@ async function executeTestStashFlow(originalBranch, testBranch) {
  * 发布后切回原分支
  * @param {string} originalBranch - 原分支名
  * @param {boolean} hasStash - 是否有储藏的改动
+ * @param {DeployLogger} logger - 日志记录器（可选）
  */
-export function restoreBranch(originalBranch, hasStash = false) {
+export function restoreBranch(originalBranch, hasStash = false, logger = null) {
   const currentBranch = getCurrentBranch();
   if (currentBranch !== originalBranch) {
     console.log(`\n📌 切回原分支: ${originalBranch}`);
-    checkoutBranch(originalBranch);
+    checkoutBranch(originalBranch, logger);
   }
 
-  // 如果有储藏的改动，提示恢复
+  // 如果有储藏的改动，恢复
   if (hasStash) {
-    console.log('\n💡 提示: 本地改动已储藏，执行以下命令恢复:');
-    console.log('   git stash pop');
+    stashPop(logger);
   }
 }
 

package/src/index.js

@@ -11,6 +11,8 @@ export { SSHClient } from './ssh-client.js';
 export {
   getCurrentBranch,
   getGitSha,
+  getGitCommitMessage,
+  getGitCommitMessages,
   isWorkingTreeClean,
   checkUncommittedChanges,
   checkoutBranch,
@@ -35,8 +37,12 @@ export {
   uploadBuild,
   deployAndExtract,
   cleanupFiles,
+  downloadBackup,
   deployToServer,
-  rollbackDeployment
+  rollbackDeployment,
+  getServerBackupList,
+  getLocalBackupList,
+  rollbackFromLocal
 } from './deploy-core.js';
 
 // 钉钉通知
@@ -47,5 +53,11 @@ export {
   sendRollbackNotification
 } from './dingtalk.js';
 
+// 日志记录
+export {
+  DeployLogger,
+  cleanLocalBackups
+} from './logger.js';
+
 // 配置模板
 export { default as configTemplate } from './config-template.js';