long-git-cli 1.0.0 → 1.0.2

package/README.md

@@ -1,72 +1,90 @@
 # Long CLI
 
-一个用于 Git tag 管理的命令行工具。
+一个支持 Bitbucket/GitHub/GitLab 的 Git tag/commit 自动化命令行工具，基于 TypeScript，结构高度可扩展。
 
 ## 安装
 
+```bash
+npm install -g long-git-cli
+```
+
+或本地开发：
 ```bash
 npm install
 npm run build
 npm link
 ```
 
-## 功能特性
-
-- 只会对格式为 `test-v00.00.0000` 的有效 tag 进行版本叠加和推送，无效 tag 会自动跳过。
-- 找不到有效 tag 时会输出提示并终止操作，不会创建新 tag。
-- 生成新 tag 后会先输出新 tag 号，要求用户输入 `y/n` 确认，确认后才会创建和推送。
-- 支持 `-p` 或 `--pass` 参数，跳过确认，直接创建并推送新 tag。
-- 完全兼容 Bitbucket 仓库，拉取 tag 时自动处理 bitbucket 远程。
-
-## 使用方法
-
-### 自动打 tag（推荐）
+## 支持命令
 
+### 自动打 tag
 ```bash
 long tag
 ```
+- 拉取最新 tag，自动递增（格式：`test-v00.00.0000`）
+- 检查分支（禁止在 master/main/release 上打 tag）
+- 自动推送到远程仓库（Bitbucket/GitHub/GitLab 均支持）
+- 友好提示 tag 结果
 
-- 会自动拉取远程 tag，筛选最新有效 tag，自动叠加版本号。
-- 生成新 tag 后会要求你输入 `y/n` 进行确认。
-- 输入 `y` 后才会创建并推送新 tag。
-- 输入 `n` 或其他内容则取消操作。
-
-### 跳过确认，直接推送
-
+### 规范化 commit 并 push
 ```bash
-long tag -p
-# 或
-long tag --pass
+long commit
 ```
+- 自动 git add .
+- 打印所有将要提交的文件，需用户确认
+- 交互式收集 commit 信息（类型、范围、说明、描述、脚注，参考 Angular/commitizen 规范）
+- 生成规范化 commit message
+- commit 后再次确认，自动 push
+- 支持 Bitbucket/GitHub/GitLab，push 后友好提示
 
-- 适用于对 tag 号非常了解、无需人工确认的场景。
-- 直接创建并推送新 tag。
-
-### Tag 格式
 
-支持格式：`test-v00.00.0000`
 
-例如：
-- 最新 tag：`test-v00.00.0001`
-- 新 tag：`test-v00.00.0002`
+## 交互流程示例
 
-## 兼容性
-
-- 支持 GitHub、Bitbucket、GitLab 等主流远程仓库。
-- Bitbucket 仓库下会自动采用兼容的拉取方式。
+#### long tag
+```
+🚀 开始自动打 tag...
+📥 拉取最新的远程信息...
+📋 当前最新 tag: test-v00.00.0001
+🆕 新 tag: test-v00.00.0002
+🏷️  创建 tag: test-v00.00.0002
+✅ Tag test-v00.00.0002 创建成功
+📤 推送 tag 到远程仓库...
+✅ Tag 推送成功
+🔗 你可以在 Bitbucket 上查看新创建的 tag
+💡 提示：在 Bitbucket 中，你可以在 "Tags" 页面查看所有 tag
+✅ Tag 创建并推送成功！
+```
 
-## 开发
+#### long commit
+```
+📝 本次将要提交的文件：
+  src/commands/commit.ts
+请确认以上文件是否全部需要提交？ (Y/n)
+请选择提交类型（必选）： feat
+影响范围（可选，如模块名，直接回车跳过）：core
+简短说明（必填，建议50字以内）：支持交互式 commit
+详细描述（可选，直接回车跳过）：
+脚注（如 BREAKING CHANGE/关联 issue，可选，直接回车跳过）：
+
+🚩 即将提交以下内容：
+提交文件:
+  src/commands/commit.ts
+提交注释:
+feat(core): 支持交互式 commit
+请确认是否提交并 push？ (Y/n)
+✅ commit 成功！
+🚀 push 成功！
+🔗 你可以在 Bitbucket 上查看新创建的内容
+💡 提示：在 Bitbucket 中，你可以在 "Commits" 页面查看
+```
 
-```bash
-# 安装依赖
-npm install
+## 扩展性说明
 
-# 开发模式运行
-npm run dev
+- 所有 git 操作、tag 处理、交互、常量、类型均已抽取为公共模块
+- 新增命令/支持更多平台/自定义交互，只需在 utils/constants/types 里维护
+- 代码高度解耦，便于单元测试和团队协作
 
-# 构建
-npm run build
+## 贡献
 
-# 运行构建后的版本
-npm start
-``` 
+欢迎提 issue 或 PR，或根据自身需求 fork 扩展！ 

package/dist/commands/commit.d.ts

@@ -0,0 +1,5 @@
+/**
+ * 交互式规范化 commit 并 push
+ */
+export declare function commitCommand(): Promise<void>;
+//# sourceMappingURL=commit.d.ts.map

package/dist/commands/commit.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"commit.d.ts","sourceRoot":"","sources":["../../src/commands/commit.ts"],"names":[],"mappings":"AAyBA;;GAEG;AACH,wBAAsB,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC,CAqGnD"}

package/dist/commands/commit.js

@@ -0,0 +1,133 @@
+"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.commitCommand = commitCommand;
+const simple_git_1 = require("simple-git");
+const git_remote_1 = require("../utils/git-remote");
+const git_1 = require("../utils/git");
+const constants_1 = require("../constants");
+const prompt = __importStar(require("../utils/prompt"));
+const message_1 = require("../utils/message");
+const git = (0, simple_git_1.simpleGit)();
+/**
+ * 交互式规范化 commit 并 push
+ */
+async function commitCommand() {
+    try {
+        // 0. 检查是否在 Git 仓库中
+        await (0, git_1.checkGitRepository)();
+        // 1. 检查分支保护
+        const branch = await (0, git_1.getCurrentBranch)();
+        if (constants_1.PROTECTED_BRANCHES.includes(branch)) {
+            (0, message_1.printError)(`当前分支为 "${branch}"，禁止在主分支（${constants_1.PROTECTED_BRANCHES.join("、")}）上 commit！`);
+            return;
+        }
+        // 2. pull（不加 --rebase）
+        try {
+            await (0, git_1.pullWithLoading)();
+        }
+        catch (e) {
+            (0, message_1.printErrorMessage)("", e);
+            return;
+        }
+        // 3. 检查暂存区文件
+        let stagedFiles = await (0, git_1.checkHasStagedFiles)();
+        // 检查未暂存的修改和未跟踪文件
+        const unstagedChanges = await (0, git_1.checkHasUnstagedChanges)();
+        if (stagedFiles.length === 0 && !unstagedChanges.hasChanges) {
+            (0, message_1.printWarning)("没有需要提交的内容。");
+            return;
+        }
+        if (stagedFiles.length === 0) {
+            // 没有暂存文件，自动 add .
+            await (0, git_1.addAllFiles)();
+            stagedFiles = await (0, git_1.checkHasStagedFiles)();
+        }
+        else {
+            if (stagedFiles.length > 0) {
+                // 暂存区有文件，检查是否有未add的文件 
+                if (unstagedChanges.hasChanges) {
+                    (0, message_1.printWarning)("检测到还有未 add 的文件：");
+                    unstagedChanges.notAdded.forEach((f) => console.log("  " + f));
+                    unstagedChanges.modified.forEach((f) => console.log("  " + f));
+                    const addMore = await prompt.confirm("是否将这些文件也一并 add？");
+                    if (addMore) {
+                        await (0, git_1.addAllFiles)();
+                        stagedFiles = await (0, git_1.checkHasStagedFiles)();
+                    }
+                }
+            }
+        }
+        // 如果暂存区没有文件，直接进入注释输入和确认流程
+        // 4. 交互式收集 commit 信息
+        const type = await prompt.select("请选择提交类型（必选）:", constants_1.commitTypes);
+        const scope = await prompt.input("影响范围（可选，如模块名，直接回车跳过）:");
+        const subject = await prompt.input("简短说明（必填，建议50字以内）:", (input) => !!input.trim() || "提交说明不能为空");
+        const body = await prompt.input("详细描述（可选，直接回车跳过）:");
+        const footer = await prompt.input("脚注（如 BREAKING CHANGE/关联 issue，可选，直接回车跳过）:");
+        // 5. 生成规范化 commit message
+        const message = (0, git_1.formatCommitMessage)(type, subject, scope, body, footer);
+        // 6. 打印将要提交的文件和注释，询问用户是否 commit 并 push
+        (0, message_1.printInfo)("\n🚩 即将提交以下内容：");
+        if (stagedFiles.length > 0) {
+            (0, message_1.printFileList)("提交文件:", stagedFiles);
+        }
+        else {
+            (0, message_1.printWarning)("没有文件将被提交（空 commit）");
+        }
+        (0, message_1.printInfo)("\n提交注释:");
+        console.log("\x1b[33m%s\x1b[0m", message);
+        const confirmCommit = await prompt.confirm("请确认是否 commit 并 push？");
+        if (!confirmCommit) {
+            (0, message_1.printWarning)("❌ 已终止提交。");
+            return;
+        }
+        // 7. commit
+        await git.commit(message);
+        (0, message_1.printSuccess)("commit 成功！");
+        // 8. push
+        await (0, git_1.pushCurrentBranch)();
+        (0, message_1.printSuccess)("push 成功！");
+        // 9. 远程仓库友好提示
+        const remoteInfo = await (0, git_remote_1.detectRemoteType)();
+        if (remoteInfo) {
+            (0, git_remote_1.showRemoteSpecificTips)(remoteInfo.type);
+        }
+    }
+    catch (error) {
+        (0, message_1.printErrorMessage)("提交或推送失败：", error);
+    }
+}
+//# sourceMappingURL=commit.js.map

package/dist/commands/commit.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"commit.js","sourceRoot":"","sources":["../../src/commands/commit.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4BA,sCAqGC;AAjID,2CAAkD;AAClD,oDAA+E;AAC/E,sCASsB;AACtB,4CAA+D;AAC/D,wDAA0C;AAC1C,8CAO0B;AAE1B,MAAM,GAAG,GAAc,IAAA,sBAAS,GAAE,CAAC;AAEnC;;GAEG;AACI,KAAK,UAAU,aAAa;IACjC,IAAI,CAAC;QACH,mBAAmB;QACnB,MAAM,IAAA,wBAAkB,GAAE,CAAC;QAE3B,YAAY;QACZ,MAAM,MAAM,GAAG,MAAM,IAAA,sBAAgB,GAAE,CAAC;QACxC,IAAI,8BAAkB,CAAC,QAAQ,CAAC,MAAa,CAAC,EAAE,CAAC;YAC/C,IAAA,oBAAU,EACR,UAAU,MAAM,YAAY,8BAAkB,CAAC,IAAI,CACjD,GAAG,CACJ,YAAY,CACd,CAAC;YACF,OAAO;QACT,CAAC;QAED,uBAAuB;QACvB,IAAI,CAAC;YACH,MAAM,IAAA,qBAAe,GAAE,CAAC;QAC1B,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAA,2BAAiB,EAAC,EAAE,EAAE,CAAC,CAAC,CAAC;YACzB,OAAO;QACT,CAAC;QAED,aAAa;QACb,IAAI,WAAW,GAAG,MAAM,IAAA,yBAAmB,GAAE,CAAC;QAC9C,iBAAiB;QACjB,MAAM,eAAe,GAAG,MAAM,IAAA,6BAAuB,GAAE,CAAC;QACxD,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,UAAU,EAAE,CAAC;YAC5D,IAAA,sBAAY,EAAC,YAAY,CAAC,CAAC;YAC3B,OAAO;QACT,CAAC;QACD,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC7B,kBAAkB;YAClB,MAAM,IAAA,iBAAW,GAAE,CAAC;YACpB,WAAW,GAAG,MAAM,IAAA,yBAAmB,GAAE,CAAC;QAC5C,CAAC;aAAM,CAAC;YACN,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC3B,uBAAuB;gBACvB,IAAI,eAAe,CAAC,UAAU,EAAE,CAAC;oBAC/B,IAAA,sBAAY,EAAC,iBAAiB,CAAC,CAAC;oBAChC,eAAe,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC;oBAC/D,eAAe,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC;oBAC/D,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;oBACxD,IAAI,OAAO,EAAE,CAAC;wBACZ,MAAM,IAAA,iBAAW,GAAE,CAAC;wBACpB,WAAW,GAAG,MAAM,IAAA,yBAAmB,GAAE,CAAC;oBAC5C,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QACD,0BAA0B;QAE1B,qBAAqB;QACrB,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,cAAc,EAAE,uBAAW,CAAC,CAAC;QAC9D,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,KAAK,CAC9B,uBAAuB,CACxB,CAAC;QACF,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,KAAK,CAChC,mBAAmB,EACnB,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,UAAU,CACxC,CAAC;QACF,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;QACpD,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,KAAK,CAC/B,2CAA2C,CAC5C,CAAC;QAEF,0BAA0B;QAC1B,MAAM,OAAO,GAAG,IAAA,yBAAmB,EAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;QAExE,uCAAuC;QACvC,IAAA,mBAAS,EAAC,gBAAgB,CAAC,CAAC;QAC5B,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC3B,IAAA,uBAAa,EAAC,OAAO,EAAE,WAAW,CAAC,CAAC;QACtC,CAAC;aAAM,CAAC;YACN,IAAA,sBAAY,EAAC,oBAAoB,CAAC,CAAC;QACrC,CAAC;QACD,IAAA,mBAAS,EAAC,SAAS,CAAC,CAAC;QACrB,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;QAC1C,MAAM,aAAa,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAC;QACnE,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,IAAA,sBAAY,EAAC,UAAU,CAAC,CAAC;YACzB,OAAO;QACT,CAAC;QAED,YAAY;QACZ,MAAM,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC1B,IAAA,sBAAY,EAAC,YAAY,CAAC,CAAC;QAE3B,UAAU;QACV,MAAM,IAAA,uBAAiB,GAAE,CAAC;QAC1B,IAAA,sBAAY,EAAC,UAAU,CAAC,CAAC;QAEzB,cAAc;QACd,MAAM,UAAU,GAAG,MAAM,IAAA,6BAAgB,GAAE,CAAC;QAC5C,IAAI,UAAU,EAAE,CAAC;YACf,IAAA,mCAAsB,EAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QAC1C,CAAC;IACH,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAA,2BAAiB,EAAC,UAAU,EAAE,KAAK,CAAC,CAAC;IACvC,CAAC;AACH,CAAC"}

package/dist/commands/tag.d.ts

@@ -1,7 +1,7 @@
 /**
  * 主要的 tag 命令处理函数
- * 执行完整的 tag 创建流程：检查分支 -> 检测仓库 -> 拉取最新信息 -> 创建新 tag -> 推送
- * @param skipPrompt 是否跳过确认，直接推送
  */
-export declare function tagCommand(skipPrompt?: boolean): Promise<void>;
+export declare function tagCommand(options?: {
+    pass?: boolean;
+}): Promise<void>;
 //# sourceMappingURL=tag.d.ts.map

package/dist/commands/tag.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"tag.d.ts","sourceRoot":"","sources":["../../src/commands/tag.ts"],"names":[],"mappings":"AAkCA;;;;GAIG;AACH,wBAAsB,UAAU,CAAC,UAAU,UAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,CA4DlE"}
+{"version":3,"file":"tag.d.ts","sourceRoot":"","sources":["../../src/commands/tag.ts"],"names":[],"mappings":"AAgBA;;GAEG;AACH,wBAAsB,UAAU,CAAC,OAAO,CAAC,EAAE;IAAE,IAAI,CAAC,EAAE,OAAO,CAAA;CAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAiD5E"}