@harryisfish/gitt 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Harry Wong
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE. 

package/README.md

@@ -0,0 +1,63 @@
+# Gitt
+
+这是一个命令行工具，用于帮助你管理 Git 仓库与远端仓库，如保持同步、推送、拉取等。
+
+## 技术
+1. 使用 Node.js 开发
+2. 使用 TypeScript 开发
+3. 使用 pnpm 包管理器
+
+## 功能
+1. 清理远程已删除的分支 - 自动清理那些在远程仓库已经被删除的本地分支
+
+## 安装
+
+使用 pnpm 安装（推荐）：
+```bash
+pnpm add -g gitt
+```
+
+或者使用 npm 安装：
+```bash
+npm install -g gitt
+```
+
+## 开发
+
+1. 安装依赖
+```bash
+pnpm install
+```
+
+2. 开发模式运行
+```bash
+# 1. 构建并创建全局链接
+pnpm dev:link
+
+# 2. 创建一个测试用的 Git 仓库
+mkdir test-repo
+cd test-repo
+git init
+git remote add origin <你的测试仓库地址>
+
+# 3. 现在你可以在这个测试仓库中运行
+gitt
+
+# 4. 测试完成后，取消全局链接
+pnpm dev:unlink
+```
+
+3. 构建
+```bash
+pnpm build
+```
+
+## 使用
+
+在任何 Git 仓库目录下，运行：
+
+```bash
+gitt
+```
+
+然后使用方向键选择要执行的操作，按回车确认。

package/dist/display.js

@@ -0,0 +1,77 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.display = void 0;
+const readline_1 = require("readline");
+// ANSI 转义序列
+const CLEAR_SCREEN = '\x1b[2J';
+const MOVE_TO_TOP = '\x1b[H';
+const SAVE_CURSOR = '\x1b[s';
+const RESTORE_CURSOR = '\x1b[u';
+const HIDE_CURSOR = '\x1b[?25l';
+const SHOW_CURSOR = '\x1b[?25h';
+class DisplayManager {
+    constructor() {
+        this.statusSection = [];
+        this.menuSection = [];
+        this.dividerLine = '';
+        this.isLoading = true;
+        // 获取终端大小
+        const { rows, columns } = process.stdout;
+        // 创建分隔线
+        this.dividerLine = '─'.repeat(columns);
+        // 计算上下区域的大小
+        this.statusHeight = Math.floor(rows / 2) - 1;
+        this.menuHeight = rows - this.statusHeight - 1;
+    }
+    // 清屏并初始化显示区域
+    initDisplay() {
+        process.stdout.write(CLEAR_SCREEN + MOVE_TO_TOP);
+        this.drawDivider();
+        this.showLoadingStatus();
+    }
+    // 绘制分隔线
+    drawDivider() {
+        process.stdout.write(SAVE_CURSOR);
+        process.stdout.write(`\x1b[${this.statusHeight}H${this.dividerLine}`);
+        process.stdout.write(RESTORE_CURSOR);
+    }
+    // 显示加载状态
+    showLoadingStatus() {
+        if (this.isLoading) {
+            process.stdout.write(MOVE_TO_TOP);
+            process.stdout.write('正在获取仓库信息...\n');
+        }
+    }
+    // 更新状态区域内容
+    updateStatus(lines) {
+        this.isLoading = false;
+        this.statusSection = lines;
+        this.refreshStatus();
+    }
+    // 刷新状态区域显示
+    refreshStatus() {
+        process.stdout.write(SAVE_CURSOR);
+        process.stdout.write(MOVE_TO_TOP);
+        // 清空状态区域
+        for (let i = 0; i < this.statusHeight; i++) {
+            (0, readline_1.clearLine)(process.stdout, 0);
+            process.stdout.write('\n');
+        }
+        // 重新显示状态信息
+        process.stdout.write(MOVE_TO_TOP);
+        this.statusSection.forEach(line => {
+            process.stdout.write(line + '\n');
+        });
+        process.stdout.write(RESTORE_CURSOR);
+    }
+    // 准备菜单区域
+    prepareForMenu() {
+        process.stdout.write(`\x1b[${this.statusHeight + 1}H\n`);
+    }
+    // 显示错误信息
+    showError(message) {
+        const currentPos = process.stdout.rows;
+        process.stdout.write(`\x1b[${currentPos}H\x1b[31m${message}\x1b[0m\n`);
+    }
+}
+exports.display = new DisplayManager();

package/dist/errors.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UserCancelError = exports.GitError = void 0;
+exports.handleError = handleError;
+exports.printSuccess = printSuccess;
+exports.printError = printError;
+// 自定义错误类型
+class GitError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = 'GitError';
+    }
+}
+exports.GitError = GitError;
+class UserCancelError extends Error {
+    constructor(message = '操作已取消') {
+        super(message);
+        this.name = 'UserCancelError';
+    }
+}
+exports.UserCancelError = UserCancelError;
+// 错误消息颜色
+const ERROR_COLOR = '\x1b[31m';
+const SUCCESS_COLOR = '\x1b[32m';
+const RESET_COLOR = '\x1b[0m';
+// 统一错误处理函数
+function handleError(error) {
+    if (error instanceof UserCancelError) {
+        console.log(error.message);
+        process.exit(0);
+    }
+    if (error instanceof GitError) {
+        console.error(`${ERROR_COLOR}错误：${RESET_COLOR}${error.message}`);
+        process.exit(1);
+    }
+    if (error instanceof Error) {
+        console.error(`${ERROR_COLOR}程序错误：${RESET_COLOR}${error.message}`);
+        process.exit(1);
+    }
+    console.error(`${ERROR_COLOR}发生未知错误${RESET_COLOR}`);
+    process.exit(1);
+}
+// 成功消息处理
+function printSuccess(message) {
+    console.log(`${SUCCESS_COLOR}✓ ${message}${RESET_COLOR}`);
+}
+// 错误消息处理
+function printError(message) {
+    console.error(`${ERROR_COLOR}${message}${RESET_COLOR}`);
+}

package/dist/index.js

@@ -0,0 +1,183 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const prompts_1 = require("@inquirer/prompts");
+const simple_git_1 = require("simple-git");
+const errors_1 = require("./errors");
+const display_1 = require("./display");
+const git = (0, simple_git_1.simpleGit)();
+// 处理 Ctrl+C 和其他终止信号
+process.on('SIGINT', () => {
+    throw new errors_1.UserCancelError('\n操作已取消');
+});
+process.on('SIGTERM', () => {
+    throw new errors_1.UserCancelError('\n程序被终止');
+});
+// 初始化 Git 仓库
+async function initGitRepo() {
+    try {
+        await git.init();
+        (0, errors_1.printSuccess)('Git 仓库初始化成功');
+    }
+    catch (error) {
+        throw new errors_1.GitError('Git 仓库初始化失败');
+    }
+}
+// 检查当前目录是否是 Git 仓库
+async function checkGitRepo() {
+    const isRepo = await git.checkIsRepo();
+    if (!isRepo) {
+        const shouldInit = await (0, prompts_1.confirm)({
+            message: '当前目录不是 Git 仓库，是否要创建？',
+            default: true
+        });
+        if (shouldInit) {
+            await initGitRepo();
+        }
+        else {
+            throw new errors_1.UserCancelError();
+        }
+    }
+    // 检查是否有远程仓库配置
+    const remotes = await git.getRemotes();
+    if (remotes.length === 0) {
+        throw new errors_1.GitError('当前 Git 仓库未配置远程仓库');
+    }
+    // 检查是否能访问远程仓库
+    try {
+        await git.fetch(['--dry-run']);
+    }
+    catch (error) {
+        throw new errors_1.GitError('无法访问远程仓库，请检查网络连接或仓库权限');
+    }
+}
+// 异步获取并展示仓库状态信息
+async function showRepoStatus() {
+    try {
+        const statusLines = [];
+        // 获取当前分支信息
+        const currentBranch = await git.branch();
+        const currentBranchName = currentBranch.current;
+        statusLines.push(`当前分支: ${currentBranchName}\n`);
+        // 获取最新的远程分支信息
+        await git.fetch(['--all']);
+        // 获取本地与远程的差异统计
+        const status = await git.status();
+        statusLines.push('📊 本地仓库状态:');
+        statusLines.push(`- 未提交的修改: ${status.modified.length + status.not_added.length + status.deleted.length} 个文件`);
+        if (status.ahead > 0) {
+            statusLines.push(`- 领先远程分支: ${status.ahead} 个提交`);
+        }
+        if (status.behind > 0) {
+            statusLines.push(`- 落后远程分支: ${status.behind} 个提交`);
+        }
+        statusLines.push('');
+        // 获取最近的提交信息
+        const recentCommits = await git.log(['--max-count=5']);
+        statusLines.push('📝 最近提交记录:');
+        recentCommits.all.forEach(commit => {
+            statusLines.push(`- ${commit.date.split('T')[0]} ${commit.hash.substring(0, 7)} ${commit.message}`);
+        });
+        statusLines.push('');
+        // 获取所有分支信息
+        const branchSummary = await git.branch(['-vv']);
+        const localBranches = branchSummary.all.length;
+        const remoteBranches = Object.keys(branchSummary.branches).filter(b => { var _a; return (_a = branchSummary.branches[b].label) === null || _a === void 0 ? void 0 : _a.includes('/'); }).length;
+        statusLines.push('🌳 分支信息:');
+        statusLines.push(`- 本地分支数: ${localBranches}`);
+        statusLines.push(`- 远程分支数: ${remoteBranches}`);
+        // 更新显示
+        display_1.display.updateStatus(statusLines);
+    }
+    catch (error) {
+        const errorMessage = error instanceof Error ? error.message : '未知错误';
+        display_1.display.showError(`获取仓库状态信息时发生错误: ${errorMessage}`);
+    }
+}
+async function cleanDeletedBranches() {
+    try {
+        console.log('正在切换到 main 分支...');
+        await git.checkout('main');
+        console.log('正在拉取最新代码...');
+        await git.pull();
+        console.log('正在清理远程已删除的分支...');
+        // 获取最新的远程分支信息
+        await git.fetch(['--prune']);
+        // 获取所有分支信息
+        const branchSummary = await git.branch(['-vv']);
+        // 找出已经在远程被删除的分支
+        const deletedBranches = branchSummary.all.filter(branch => {
+            const branchInfo = branchSummary.branches[branch];
+            return branchInfo.label && branchInfo.label.includes(': gone]');
+        });
+        if (deletedBranches.length === 0) {
+            console.log('没有需要清理的分支。');
+            return;
+        }
+        console.log('以下分支将被删除：', deletedBranches.join(', '));
+        // 删除这些分支
+        for (const branch of deletedBranches) {
+            await git.branch(['-D', branch]);
+            console.log(`已删除分支: ${branch}`);
+        }
+        (0, errors_1.printSuccess)('分支清理完成');
+    }
+    catch (error) {
+        throw new errors_1.GitError(error instanceof Error ? error.message : '清理分支时发生未知错误');
+    }
+}
+async function showMenu() {
+    try {
+        // 准备菜单区域
+        display_1.display.prepareForMenu();
+        const action = await (0, prompts_1.select)({
+            message: '请选择要执行的操作：',
+            choices: [
+                {
+                    name: '清理远程已删除的分支',
+                    value: 'clean',
+                    description: '清理那些在远程仓库已经被删除的本地分支'
+                },
+                {
+                    name: '退出',
+                    value: 'exit',
+                    description: '退出程序'
+                }
+            ]
+        });
+        return action;
+    }
+    catch (error) {
+        (0, errors_1.printError)('菜单选择出错');
+        return 'exit';
+    }
+}
+async function main() {
+    try {
+        // 初始化显示
+        display_1.display.initDisplay();
+        // 在程序启动时只进行基本的 Git 仓库检查
+        await checkGitRepo();
+        // 在后台异步获取仓库状态
+        showRepoStatus().catch(error => {
+            const errorMessage = error instanceof Error ? error.message : '未知错误';
+            display_1.display.showError(`获取仓库状态时发生错误: ${errorMessage}`);
+        });
+        while (true) {
+            const action = await showMenu();
+            if (action === 'exit') {
+                console.log('再见！');
+                process.exit(0);
+            }
+            if (action === 'clean') {
+                await cleanDeletedBranches();
+            }
+            console.log('\n');
+        }
+    }
+    catch (error) {
+        (0, errors_1.handleError)(error);
+    }
+}
+// 启动程序
+main().catch(errors_1.handleError);

package/dist/prompts.js

@@ -0,0 +1,56 @@
+import { select, confirm } from '@inquirer/prompts';
+import { theme } from './theme';
+// 菜单选项
+const menuChoices = [
+    {
+        name: '清理远程已删除的分支',
+        value: 'clean',
+        description: '清理那些在远程仓库已经被删除的本地分支'
+    },
+    {
+        name: '退出',
+        value: 'exit',
+        description: '退出程序'
+    }
+];
+// 显示主菜单
+export async function showMainMenu() {
+    try {
+        const options = {
+            message: '请选择要执行的操作：',
+            choices: menuChoices,
+            pageSize: 10, // 一次显示的选项数量
+            loop: true, // 循环滚动
+            theme, // 使用自定义主题
+        };
+        return await select(options);
+    }
+    catch (error) {
+        return 'exit';
+    }
+}
+// 确认提示
+export async function confirmAction(message) {
+    try {
+        const options = {
+            message,
+            default: true,
+            theme, // 使用自定义主题
+        };
+        return await confirm(options);
+    }
+    catch (error) {
+        return false;
+    }
+}
+// 初始化 Git 仓库确认
+export async function confirmInitRepo() {
+    return await confirmAction('当前目录不是 Git 仓库，是否要创建？');
+}
+// 删除分支确认
+export async function confirmDeleteBranches(branches) {
+    if (branches.length === 0)
+        return false;
+    const branchList = branches.join('\n  - ');
+    return await confirmAction(`是否删除以下分支？\n  - ${branchList}`);
+}

package/dist/theme.js

@@ -0,0 +1,59 @@
+import chalk from 'chalk';
+// 自定义颜色
+const colors = {
+    primary: chalk.cyan,
+    success: chalk.green,
+    warning: chalk.yellow,
+    error: chalk.red,
+    muted: chalk.gray,
+    highlight: chalk.blue,
+    info: chalk.white,
+};
+// 自定义图标
+const icons = {
+    pointer: '❯',
+    done: '✔',
+    error: '✖',
+    waiting: '○',
+};
+// 定义主题
+export const theme = {
+    prefix: {
+        idle: colors.primary('?'),
+        done: colors.success(icons.done),
+    },
+    spinner: {
+        interval: 100,
+        frames: ['⠋', '⠙', '⠹', '⠸', '⠼', '⠴', '⠦', '⠧', '⠇', '⠏'],
+    },
+    icon: {
+        cursor: colors.primary(icons.pointer),
+    },
+    style: {
+        // 答案样式
+        answer: (text) => colors.success(text),
+        // 问题样式
+        message: (text, status) => {
+            switch (status) {
+                case 'loading':
+                    return colors.muted(text);
+                case 'done':
+                    return colors.success(text);
+                default:
+                    return colors.primary(text);
+            }
+        },
+        // 错误信息样式
+        error: (text) => colors.error(icons.error + ' ' + text),
+        // 帮助信息样式
+        help: (text) => colors.muted(text),
+        // 高亮样式
+        highlight: (text) => colors.highlight(text),
+        // 选项描述样式
+        description: (text) => colors.muted(`\n     ${text}`),
+        // 禁用选项样式
+        disabled: (text) => colors.muted(`${icons.waiting} ${text}`),
+    },
+    // 帮助提示显示模式：'always' | 'never' | 'auto'
+    helpMode: 'auto',
+};

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@harryisfish/gitt",
+  "version": "1.0.0",
+  "description": "这是一个命令行工具，用于帮助你管理 Git 仓库与远端仓库，如保持同步、推送、拉取等。",
+  "main": "dist/index.js",
+  "bin": {
+    "gitt": "./dist/index.js"
+  },
+  "scripts": {
+    "build": "tsc",
+    "start": "tsx src/index.ts",
+    "dev": "tsx watch src/index.ts",
+    "prepare": "pnpm run build",
+    "dev:link": "pnpm build && pnpm link --global",
+    "dev:unlink": "pnpm unlink --global"
+  },
+  "keywords": ["git", "cli", "git-tools", "git-automation"],
+  "author": "harryisfish",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/harryisfish/gitt.git"
+  },
+  "bugs": {
+    "url": "https://github.com/harryisfish/gitt/issues"
+  },
+  "homepage": "https://github.com/harryisfish/gitt#readme",
+  "devDependencies": {
+    "@types/node": "^20.11.24",
+    "ts-node": "^10.9.2",
+    "tsx": "^4.7.1",
+    "typescript": "^5.3.3"
+  },
+  "dependencies": {
+    "@inquirer/prompts": "^3.3.0",
+    "simple-git": "^3.22.0"
+  },
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "packageManager": "pnpm@9.14.2",
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ]
+}