@harryisfish/gitt 1.3.0 → 1.4.0

package/README.md

@@ -19,12 +19,71 @@ pnpm add -g @harryisfish/gitt
 ## Usage
 
 ```bash
+# Default behavior (auto-clean)
 gitt
+
+# Interactive mode (select branches to delete)
+gitt -i
+# or
+gitt --interactive
+
+# Dry run (preview what would be deleted)
+gitt -d
+# or
+gitt --dry-run
 ```
 
 ## Configuration
 
-Gitt automatically uses your Git global configuration. No additional setup required.
+### Main Branch Detection
+
+Gitt automatically detects your main branch in the following order:
+1. **`.gitt` configuration file** (Project level)
+2. **Git config** `gitt.mainBranch` (User/System level)
+3. **Remote HEAD** (e.g., `origin/HEAD`)
+4. **Common names** (`main`, `master`)
+
+### Setting the Main Branch
+
+You can explicitly set the main branch for your project using the command:
+
+```bash
+gitt set-main <branch-name>
+```
+
+Example:
+```bash
+gitt set-main master
+```
+
+gitt set-main master
+```
+
+This will create a `.gitt` file in your project root with your preference.
+
+### Branch Protection
+
+You can prevent specific branches from being deleted by adding them to the ignore list.
+
+**Using command (Recommended):**
+```bash
+gitt ignore "release/*"
+gitt ignore "test-branch"
+```
+
+**Manual Configuration:**
+You can also manually edit the `.gitt` configuration file:
+```json
+{
+  "mainBranch": "main",
+  "ignoreBranches": [
+    "release/*",
+    "test-branch",
+    "feature/important-*"
+  ]
+}
+```
+Supports glob patterns (e.g., `*`).
 
 ## Documentation
 

package/dist/commands/clean.js

@@ -3,26 +3,32 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.cleanDeletedBranches = cleanDeletedBranches;
 const simple_git_1 = require("simple-git");
 const listr2_1 = require("listr2");
+const prompts_1 = require("@inquirer/prompts");
+const minimatch_1 = require("minimatch");
 const errors_1 = require("../errors");
 const errors_2 = require("../errors");
+const git_1 = require("../utils/git");
+const config_1 = require("../utils/config");
 const git = (0, simple_git_1.simpleGit)();
 /**
  * Clean up local branches that have been deleted on the remote
  * @throws {GitError} When cleaning operation fails
  */
-async function cleanDeletedBranches() {
+async function cleanDeletedBranches(options = {}) {
     try {
         const tasks = new listr2_1.Listr([
             {
                 title: 'Fetch main from remote',
-                task: async () => {
-                    await git.fetch(['origin', 'main']);
+                task: async (ctx) => {
+                    const mainBranch = await (0, git_1.getMainBranch)();
+                    ctx.mainBranch = mainBranch;
+                    await git.fetch(['origin', mainBranch]);
                 }
             },
             {
                 title: 'Switch to main branch',
-                task: async () => {
-                    await git.checkout('main');
+                task: async (ctx) => {
+                    await git.checkout(ctx.mainBranch);
                 }
             },
             {
@@ -36,13 +42,66 @@ async function cleanDeletedBranches() {
                 task: async (ctx) => {
                     await git.fetch(['--prune']);
                     const branchSummary = await git.branch(['-vv']);
-                    const deletedBranches = branchSummary.all.filter(branch => {
+                    const config = await (0, config_1.readConfigFile)();
+                    const ignorePatterns = config.ignoreBranches || [];
+                    let deletedBranches = branchSummary.all.filter(branch => {
                         const branchInfo = branchSummary.branches[branch];
                         return branchInfo.label && branchInfo.label.includes(': gone]');
                     });
+                    // Filter out ignored branches
+                    if (ignorePatterns.length > 0) {
+                        deletedBranches = deletedBranches.filter(branch => {
+                            const isIgnored = ignorePatterns.some(pattern => (0, minimatch_1.minimatch)(branch, pattern));
+                            return !isIgnored;
+                        });
+                    }
                     ctx.deletedBranches = deletedBranches;
                 }
             },
+            {
+                title: 'Select branches to delete',
+                enabled: (ctx) => !!options.interactive && Array.isArray(ctx.deletedBranches) && ctx.deletedBranches.length > 0,
+                task: async (ctx, task) => {
+                    const branches = ctx.deletedBranches;
+                    // Pause the listr task to show prompt
+                    // We need to stop the spinner to show the prompt clearly
+                    // But listr2 doesn't make it easy to pause/resume in the middle of a task flow easily without custom renderers
+                    // So we will do the prompt and then update the context
+                    // Actually, listr2 supports prompts but it's complex. 
+                    // Let's try to use the prompt directly.
+                    // We might need to handle the UI interference.
+                    // For now, let's just run the prompt.
+                    // In a real TTY, listr2 might fight for control.
+                    // A common pattern is to run the prompt outside listr or use listr's prompt adapter.
+                    // But here we are inside a task.
+                    // Let's try to use the prompt.
+                    try {
+                        const selected = await (0, prompts_1.checkbox)({
+                            message: 'Select branches to delete:',
+                            choices: branches.map(b => ({ name: b, value: b, checked: true })),
+                        });
+                        ctx.deletedBranches = selected;
+                    }
+                    catch (e) {
+                        // If user cancels, we might want to abort or just delete nothing
+                        ctx.deletedBranches = [];
+                    }
+                }
+            },
+            {
+                title: 'Dry Run: List branches to be deleted',
+                enabled: (ctx) => !!options.dryRun && Array.isArray(ctx.deletedBranches) && ctx.deletedBranches.length > 0,
+                task: (ctx, task) => {
+                    const branches = ctx.deletedBranches;
+                    task.output = `The following branches would be deleted:\n${branches.map(b => `  - ${b}`).join('\n')}`;
+                    // We don't want to fail, just show info. 
+                    // But listr output is transient.
+                    // We will print it at the end or use a separate log.
+                    console.log('\nDry Run: The following branches would be deleted:');
+                    branches.forEach(b => console.log(`  - ${b}`));
+                    ctx.deletedBranches = []; // Clear so next step does nothing
+                }
+            },
             {
                 title: 'Delete branches removed on remote',
                 enabled: (ctx) => Array.isArray(ctx.deletedBranches),

package/dist/commands/config.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.configMainBranch = configMainBranch;
+exports.configIgnoreBranch = configIgnoreBranch;
+const git_1 = require("../utils/git");
+const errors_1 = require("../errors");
+const config_1 = require("../utils/config");
+async function configMainBranch(branch) {
+    try {
+        await (0, git_1.setMainBranch)(branch);
+        (0, errors_1.printSuccess)(`Successfully set main branch to '${branch}'`);
+    }
+    catch (error) {
+        (0, errors_1.handleError)(error);
+    }
+}
+async function configIgnoreBranch(pattern) {
+    try {
+        const config = await (0, config_1.readConfigFile)();
+        const ignoreBranches = config.ignoreBranches || [];
+        if (!ignoreBranches.includes(pattern)) {
+            ignoreBranches.push(pattern);
+            await (0, config_1.writeConfigFile)({ ignoreBranches });
+            (0, errors_1.printSuccess)(`Successfully added '${pattern}' to ignore list`);
+        }
+        else {
+            (0, errors_1.printSuccess)(`'${pattern}' is already in the ignore list`);
+        }
+    }
+    catch (error) {
+        (0, errors_1.handleError)(error);
+    }
+}

package/dist/index.js

@@ -1,5 +1,38 @@
 #!/usr/bin/env node
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 const simple_git_1 = require("simple-git");
 const errors_1 = require("./errors");
@@ -41,12 +74,60 @@ async function checkGitRepo() {
         throw new errors_1.GitError('Cannot access remote repository, please check network connection or repository permissions');
     }
 }
+function printHelp() {
+    console.log(`
+Usage: gitt [command] [options]
+
+Commands:
+  (default)              Clean up local branches that have been deleted on remote
+  set-main <branch>      Set the main branch for the current project
+  ignore <pattern>       Add a branch pattern to the ignore list (e.g., "release/*")
+
+Options:
+  -i, --interactive      Interactive mode: Select branches to delete
+  -d, --dry-run          Dry run: Show what would be deleted without deleting
+  -h, --help             Show this help message
+
+Examples:
+  gitt                   # Auto-clean deleted branches
+  gitt -i                # Select branches to delete interactively
+  gitt -d                # Preview deletion
+  gitt ignore "temp/*"   # Ignore branches matching "temp/*"
+  gitt set-main master   # Set main branch to 'master'
+`);
+}
 async function main() {
     try {
+        const args = process.argv.slice(2);
+        const command = args[0];
+        // Check for help command
+        if (args.includes('-h') || args.includes('--help')) {
+            printHelp();
+            process.exit(0);
+        }
         // 检查 Git 仓库
         await checkGitRepo();
-        // 执行清理操作
-        await (0, clean_1.cleanDeletedBranches)();
+        if (command === 'set-main') {
+            const branch = args[1];
+            if (!branch) {
+                throw new Error('Please specify a branch name');
+            }
+            await Promise.resolve().then(() => __importStar(require('./commands/config'))).then(m => m.configMainBranch(branch));
+        }
+        else if (command === 'ignore') {
+            const pattern = args[1];
+            if (!pattern) {
+                throw new Error('Please specify a branch pattern to ignore');
+            }
+            await Promise.resolve().then(() => __importStar(require('./commands/config'))).then(m => m.configIgnoreBranch(pattern));
+        }
+        else {
+            // Parse options
+            const isInteractive = args.includes('-i') || args.includes('--interactive');
+            const isDryRun = args.includes('-d') || args.includes('--dry-run');
+            // 默认执行清理操作
+            await (0, clean_1.cleanDeletedBranches)({ interactive: isInteractive, dryRun: isDryRun });
+        }
         // 退出程序
         process.exit(0);
     }

package/dist/utils/config.js

@@ -0,0 +1,83 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getProjectRoot = getProjectRoot;
+exports.readConfigFile = readConfigFile;
+exports.writeConfigFile = writeConfigFile;
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
+const simple_git_1 = require("simple-git");
+const CONFIG_FILE_NAME = '.gitt';
+/**
+ * Get the project root directory (where .git is located).
+ */
+async function getProjectRoot() {
+    const git = (0, simple_git_1.simpleGit)();
+    try {
+        const root = await git.revparse(['--show-toplevel']);
+        return root.trim();
+    }
+    catch (e) {
+        return process.cwd();
+    }
+}
+/**
+ * Read the .gitt configuration file.
+ */
+async function readConfigFile() {
+    try {
+        const root = await getProjectRoot();
+        const configPath = path.join(root, CONFIG_FILE_NAME);
+        if (!fs.existsSync(configPath)) {
+            return {};
+        }
+        const content = fs.readFileSync(configPath, 'utf-8');
+        return JSON.parse(content);
+    }
+    catch (error) {
+        return {};
+    }
+}
+/**
+ * Write to the .gitt configuration file.
+ */
+async function writeConfigFile(config) {
+    const root = await getProjectRoot();
+    const configPath = path.join(root, CONFIG_FILE_NAME);
+    // Read existing config to merge
+    const currentConfig = await readConfigFile();
+    const newConfig = { ...currentConfig, ...config };
+    fs.writeFileSync(configPath, JSON.stringify(newConfig, null, 2));
+}

package/dist/utils/git.js

@@ -0,0 +1,76 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getMainBranch = getMainBranch;
+exports.setMainBranch = setMainBranch;
+const simple_git_1 = require("simple-git");
+const errors_1 = require("../errors");
+const config_1 = require("./config");
+const git = (0, simple_git_1.simpleGit)();
+/**
+ * Get the main branch name for the current repository.
+ * Priority:
+ * 1. User config (gitt.mainBranch)
+ * 2. Remote HEAD (origin/HEAD)
+ * 3. Common names (main, master)
+ */
+async function getMainBranch() {
+    try {
+        // 1. Check .gitt config file
+        const fileConfig = await (0, config_1.readConfigFile)();
+        if (fileConfig.mainBranch) {
+            return fileConfig.mainBranch;
+        }
+        // 2. Check user config (legacy/fallback)
+        const configMain = await git.getConfig('gitt.mainBranch');
+        if (configMain.value) {
+            return configMain.value;
+        }
+        // 3. Try to detect from remote HEAD
+        try {
+            const remotes = await git.listRemote(['--symref', 'origin', 'HEAD']);
+            // Output format example: "ref: refs/heads/main\tHEAD"
+            const match = remotes.match(/ref: refs\/heads\/([^\s]+)\s+HEAD/);
+            if (match && match[1]) {
+                return match[1];
+            }
+        }
+        catch (e) {
+            // Ignore network/remote errors during detection
+        }
+        // 4. Check for common local branches
+        const localBranches = await git.branchLocal();
+        if (localBranches.all.includes('main'))
+            return 'main';
+        if (localBranches.all.includes('master'))
+            return 'master';
+        // Default fallback
+        return 'main';
+    }
+    catch (error) {
+        throw new errors_1.GitError('Failed to detect main branch');
+    }
+}
+/**
+ * Set the preferred main branch for the current repository.
+ */
+async function setMainBranch(branch) {
+    try {
+        // Verify branch exists locally or remotely
+        const localBranches = await git.branchLocal();
+        if (!localBranches.all.includes(branch)) {
+            // If not local, check if we can fetch it
+            try {
+                await git.fetch(['origin', branch]);
+            }
+            catch (e) {
+                throw new errors_1.GitError(`Branch '${branch}' does not exist locally or on remote`);
+            }
+        }
+        await (0, config_1.writeConfigFile)({ mainBranch: branch });
+    }
+    catch (error) {
+        if (error instanceof errors_1.GitError)
+            throw error;
+        throw new errors_1.GitError('Failed to set main branch configuration');
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@harryisfish/gitt",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "A command-line tool to help you manage Git repositories and remote repositories, such as keeping in sync, pushing, pulling, etc.",
   "main": "dist/index.js",
   "bin": {
@@ -38,8 +38,10 @@
   },
   "dependencies": {
     "@inquirer/prompts": "^3.3.0",
-    "simple-git": "^3.22.0",
-    "listr2": "^8.0.0"
+    "@types/minimatch": "^6.0.0",
+    "listr2": "^8.0.0",
+    "minimatch": "^10.1.1",
+    "simple-git": "^3.22.0"
   },
   "engines": {
     "node": ">=14.0.0"
@@ -50,4 +52,4 @@
     "README.md",
     "LICENSE"
   ]
-}
+}