glab-tool 1.0.4 → 1.0.5

package/README.md

@@ -10,6 +10,7 @@
 - **按状态分组** - 分支按 "已合并" 和 "已关闭" 分组展示
 - **干运行模式** - 预览将删除的分支而不实际执行
 - **强制删除** - 支持强制删除受保护分支
+- **本地分支清理** - 可选同时删除本地对应的 Git 分支
 - **通配符支持** - 目标分支支持通配符匹配（如 `release/*`）
 
 ## 安装
@@ -74,21 +75,25 @@ glabx clean [options]
 ```
 
 **选项**:
-- `--target <branch>`: 目标分支（默认: `main`），支持通配符如 `release/*`
-- `--force`: 强制删除受保护分支
+- `-t, --target <branch>`: 目标分支（默认: `main`），支持通配符如 `release/*`
+- `-f, --force`: 强制删除受保护分支（远程）和未合并分支（本地）
 - `-d, --dry-run`: 预览模式，显示将删除的分支但不实际删除
+- `-l, --local`: 同时删除本地对应的 Git 分支
 
 **使用示例**:
 
 ```bash
-# 清理 targeting main 分支的分支
+# 清理 targeting main 分支的分支（仅远程）
 glabx clean --target main
 
-# 预览将删除的分支
-glabx clean --target main --dry-run
+# 同时删除远程和本地分支
+glabx clean --target main --local
 
-# 强制删除（包括受保护分支）
-glabx clean --target main --force
+# 预览将删除的分支（包括本地分支检查）
+glabx clean --target main --local --dry-run
+
+# 强制删除（包括受保护的远程分支和未合并的本地分支）
+glabx clean --target main --local --force
 
 # 使用通配符匹配多个目标分支
 glabx clean --target release/*
@@ -97,6 +102,12 @@ glabx clean --target release/*
 glabx clean
 ```
 
+**关于 --local 说明**:
+- 仅在当前目录是 Git 仓库且分支存在时才会删除本地分支
+- 默认使用 `git branch -d` 安全删除（仅删除已合并的分支）
+- 配合 `--force` 使用 `git branch -D` 强制删除（即使分支未合并）
+- dry-run 模式下会显示 `[local exists]` 标识表示本地有对应分支
+
 ## 配置
 
 支持三种配置方式（优先级从高到低）:

package/index.js

@@ -15,9 +15,10 @@ program
 program
   .command('clean')
   .description('Clean up GitLab branches from merge requests targeting main branch')
-  .option('--target <branch>', 'Target branch to filter merge requests (default: main)', 'main')
-  .option('--force', 'Force delete protected branches')
+  .option('-t, --target <branch>', 'Target branch to filter merge requests (default: main)', 'main')
+  .option('-f, --force', 'Force delete protected branches')
   .option('-d, --dry-run', 'Show what would be deleted without actually deleting')
+  .option('-l, --local', 'Also delete local Git branches')
   .action(async (options) => {
     await cleanup(options);
   });

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "glab-tool",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "description": "GitLab Extended CLI Tool - A multi-purpose GitLab utility CLI",
   "type": "module",
   "main": "index.js",
   "bin": {
-    "glabx": "./index.js"
+    "glabx": "index.js"
   },
   "files": [
     "src/*",

package/src/cleanup.js

@@ -1,6 +1,10 @@
 import axios from 'axios';
 import fs from 'fs';
 import inquirer from 'inquirer';
+import { exec } from 'child_process';
+import { promisify } from 'util';
+
+const execAsync = promisify(exec);
 
 // 从配置文件读取配置
 function readConfig(configPath) {
@@ -113,11 +117,11 @@ function matchesPattern(branchName, pattern) {
   return regex.test(branchName);
 }
 
-// 删除分支
+// 删除远程分支
 async function deleteBranch(apiClient, projectId, branchName, force = false) {
   try {
     const deleteUrl = `/projects/${projectId}/repository/branches/${encodeURIComponent(branchName)}`;
-    
+
     // 如果是强制删除，需要使用不同的API端点
     if (force) {
       // 使用强制删除的API端点
@@ -130,8 +134,8 @@ async function deleteBranch(apiClient, projectId, branchName, force = false) {
       // 正常删除
       await apiClient.delete(deleteUrl);
     }
-    
-    console.log(`Successfully deleted branch: ${branchName}`);
+
+    console.log(`Successfully deleted remote branch: ${branchName}`);
     return true;
   } catch (error) {
     if (error.response?.status === 403) {
@@ -145,6 +149,51 @@ async function deleteBranch(apiClient, projectId, branchName, force = false) {
   }
 }
 
+// 检查本地分支是否存在
+async function localBranchExists(branchName) {
+  try {
+    await execAsync(`git rev-parse --verify ${branchName} 2>/dev/null`);
+    return true;
+  } catch (error) {
+    return false;
+  }
+}
+
+// 获取所有本地分支
+async function getLocalBranches() {
+  try {
+    const { stdout } = await execAsync('git branch --format="%(refname:short)"');
+    return stdout.trim().split('\n').filter(Boolean);
+  } catch (error) {
+    console.warn('Warning: Could not get local branches:', error.message);
+    return [];
+  }
+}
+
+// 删除本地分支
+async function deleteLocalBranch(branchName, force = false) {
+  try {
+    // 先检查分支是否存在
+    const exists = await localBranchExists(branchName);
+    if (!exists) {
+      console.log(`Local branch "${branchName}" does not exist, skipping.`);
+      return true;
+    }
+
+    // 根据 force 参数决定使用 -d 还是 -D
+    const deleteFlag = force ? '-D' : '-d';
+    await execAsync(`git branch ${deleteFlag} ${branchName}`);
+    console.log(`Successfully deleted local branch: ${branchName}`);
+    return true;
+  } catch (error) {
+    console.error(`Error deleting local branch "${branchName}":`, error.message);
+    if (!force) {
+      console.error(`  Try using --force to force delete unmerged local branches.`);
+    }
+    return false;
+  }
+}
+
 // 获取项目中的所有分支名称
 async function getAllBranches(apiClient, projectId) {
   const branches = [];
@@ -306,14 +355,31 @@ async function cleanup(options) {
     // 询问用户是否确认删除
     if (options.dryRun) {
       console.log('Dry run mode: No branches will be deleted.');
+
+      // 如果启用了 --local，获取本地分支列表
+      let localBranches = [];
+      if (options.local) {
+        localBranches = await getLocalBranches();
+      }
+
       // 显示分组统计信息
       if (mergedBranches.length > 0) {
         console.log(`\nMerged branches (${mergedBranches.length}):`);
-        mergedBranches.forEach(mr => console.log(`  - MR !${mr.iid}: ${mr.source_branch}`));
+        mergedBranches.forEach(mr => {
+          const localExists = options.local && localBranches.includes(mr.source_branch) ? ' [local exists]' : '';
+          console.log(`  - MR !${mr.iid}: ${mr.source_branch}${localExists}`);
+        });
       }
       if (closedBranches.length > 0) {
         console.log(`\nClosed branches (${closedBranches.length}):`);
-        closedBranches.forEach(mr => console.log(`  - MR !${mr.iid}: ${mr.source_branch}`));
+        closedBranches.forEach(mr => {
+          const localExists = options.local && localBranches.includes(mr.source_branch) ? ' [local exists]' : '';
+          console.log(`  - MR !${mr.iid}: ${mr.source_branch}${localExists}`);
+        });
+      }
+
+      if (options.local) {
+        console.log('\n--local flag enabled: Local branches will also be deleted.');
       }
       return;
     }
@@ -322,8 +388,20 @@ async function cleanup(options) {
     if (options.force) {
       console.log('Force mode enabled: Deleting all branches without confirmation...');
       const allBranchesToDelete = [...mergedBranches, ...closedBranches];
+
+      // 如果启用了 --local，先获取本地分支列表
+      let localBranches = [];
+      if (options.local) {
+        localBranches = await getLocalBranches();
+      }
+
       for (const mr of allBranchesToDelete) {
+        // 删除远程分支
         await deleteBranch(apiClient, encodedProjectId, mr.source_branch, true);
+        // 如果启用了 --local 且该分支存在于本地，也删除本地分支
+        if (options.local && localBranches.includes(mr.source_branch)) {
+          await deleteLocalBranch(mr.source_branch, true);
+        }
       }
       return;
     }
@@ -429,8 +507,20 @@ async function cleanup(options) {
     
     if (confirmAnswers.confirmDelete) {
       console.log('\nDeleting branches...');
+
+      // 如果启用了 --local，先获取本地分支列表
+      let localBranches = [];
+      if (options.local) {
+        localBranches = await getLocalBranches();
+      }
+
       for (const branch of selectedBranches) {
+        // 删除远程分支
         await deleteBranch(apiClient, encodedProjectId, branch.sourceBranch, options.force);
+        // 如果启用了 --local 且该分支存在于本地，也删除本地分支
+        if (options.local && localBranches.includes(branch.sourceBranch)) {
+          await deleteLocalBranch(branch.sourceBranch, options.force);
+        }
       }
     } else {
       console.log('\nOperation cancelled by user.');