@zjex/git-workflow 0.0.1 → 0.0.2

package/src/commands/commit.ts

@@ -0,0 +1,263 @@
+import { execSync } from "child_process";
+import { select, input, confirm, checkbox } from "@inquirer/prompts";
+import ora from "ora";
+import { colors, theme, execOutput, divider } from "../utils.js";
+import { getConfig } from "../config.js";
+
+// Conventional Commits 类型 + Gitmoji
+const DEFAULT_COMMIT_TYPES = [
+  { type: "feat", emoji: "✨", description: "新功能" },
+  { type: "fix", emoji: "🐛", description: "修复 Bug" },
+  { type: "docs", emoji: "📝", description: "文档更新" },
+  { type: "style", emoji: "💄", description: "代码格式 (不影响功能)" },
+  { type: "refactor", emoji: "♻️", description: "重构 (非新功能/修复)" },
+  { type: "perf", emoji: "⚡️", description: "性能优化" },
+  { type: "test", emoji: "✅", description: "测试相关" },
+  { type: "build", emoji: "📦", description: "构建/依赖相关" },
+  { type: "ci", emoji: "👷", description: "CI/CD 相关" },
+  { type: "chore", emoji: "🔧", description: "其他杂项" },
+  { type: "revert", emoji: "⏪", description: "回退提交" },
+] as const;
+
+type CommitType = (typeof DEFAULT_COMMIT_TYPES)[number]["type"];
+
+function getCommitTypes(config: ReturnType<typeof getConfig>) {
+  const customEmojis = config.commitEmojis || {};
+  return DEFAULT_COMMIT_TYPES.map((item) => ({
+    ...item,
+    emoji: customEmojis[item.type as CommitType] || item.emoji,
+  }));
+}
+
+interface FileStatus {
+  status: string;
+  file: string;
+}
+
+function parseGitStatus(): { staged: FileStatus[]; unstaged: FileStatus[] } {
+  const output = execOutput("git status --porcelain");
+  if (!output) return { staged: [], unstaged: [] };
+
+  const staged: FileStatus[] = [];
+  const unstaged: FileStatus[] = [];
+
+  for (const line of output.split("\n")) {
+    if (!line) continue;
+    const indexStatus = line[0];
+    const workTreeStatus = line[1];
+    const file = line.slice(3);
+
+    // 已暂存的更改 (index 有状态)
+    if (indexStatus !== " " && indexStatus !== "?") {
+      staged.push({ status: indexStatus, file });
+    }
+
+    // 未暂存的更改 (work tree 有状态，或者是未跟踪文件)
+    if (workTreeStatus !== " " || indexStatus === "?") {
+      const status = indexStatus === "?" ? "?" : workTreeStatus;
+      unstaged.push({ status, file });
+    }
+  }
+
+  return { staged, unstaged };
+}
+
+function formatFileStatus(status: string): string {
+  const statusMap: Record<string, string> = {
+    M: colors.yellow("M"),
+    A: colors.green("A"),
+    D: colors.red("D"),
+    R: colors.yellow("R"),
+    C: colors.yellow("C"),
+    "?": colors.green("?"),
+  };
+  return statusMap[status] || status;
+}
+
+export async function commit(): Promise<void> {
+  const config = getConfig();
+  let { staged, unstaged } = parseGitStatus();
+
+  // 没有暂存的更改
+  if (staged.length === 0) {
+    if (unstaged.length === 0) {
+      console.log(colors.yellow("工作区干净，没有需要提交的更改"));
+      return;
+    }
+
+    console.log(colors.yellow("没有暂存的更改"));
+    divider();
+    console.log("未暂存的文件:");
+    for (const { status, file } of unstaged) {
+      console.log(`  ${formatFileStatus(status)} ${file}`);
+    }
+    divider();
+
+    // 根据配置决定是否自动暂存
+    const autoStage = config.autoStage ?? true;
+
+    if (autoStage) {
+      // 自动暂存所有文件
+      execSync("git add -A", { stdio: "pipe" });
+      console.log(colors.green("✔ 已自动暂存所有更改"));
+      divider();
+      // 重新获取状态
+      const newStatus = parseGitStatus();
+      staged = newStatus.staged;
+    } else {
+      // 让用户选择要暂存的文件
+      const filesToStage = await checkbox({
+        message: "选择要暂存的文件:",
+        choices: unstaged.map(({ status, file }) => ({
+          name: `${formatFileStatus(status)} ${file}`,
+          value: file,
+          checked: true,
+        })),
+        theme,
+      });
+
+      if (filesToStage.length === 0) {
+        console.log(colors.yellow("没有选择任何文件，已取消"));
+        return;
+      }
+
+      // 暂存选中的文件
+      for (const file of filesToStage) {
+        execSync(`git add "${file}"`, { stdio: "pipe" });
+      }
+      console.log(colors.green(`✔ 已暂存 ${filesToStage.length} 个文件`));
+      divider();
+
+      // 重新获取状态
+      const newStatus = parseGitStatus();
+      staged = newStatus.staged;
+    }
+  } else {
+    console.log("已暂存的文件:");
+    for (const { status, file } of staged) {
+      console.log(`  ${formatFileStatus(status)} ${file}`);
+    }
+    divider();
+  }
+
+  // 获取提交类型（支持自定义 emoji）
+  const commitTypes = getCommitTypes(config);
+
+  // 选择提交类型
+  const typeChoice = await select({
+    message: "选择提交类型:",
+    choices: commitTypes.map((t) => ({
+      name: `${t.emoji}  ${t.type.padEnd(10)} ${colors.dim(t.description)}`,
+      value: t,
+    })),
+    theme,
+  });
+
+  // 输入 scope (可选)
+  const scope = await input({
+    message: "输入影响范围 scope (可跳过):",
+    theme,
+  });
+
+  // 输入简短描述
+  const subject = await input({
+    message: "输入简短描述:",
+    validate: (value) => {
+      if (!value.trim()) return "描述不能为空";
+      if (value.length > 72) return "描述不能超过 72 个字符";
+      return true;
+    },
+    theme,
+  });
+
+  // 输入详细描述 (可选)
+  const body = await input({
+    message: "输入详细描述 (可跳过):",
+    theme,
+  });
+
+  // 是否有破坏性变更
+  const hasBreaking = await confirm({
+    message: "是否包含破坏性变更 (BREAKING CHANGE)?",
+    default: false,
+    theme,
+  });
+
+  let breakingDesc = "";
+  if (hasBreaking) {
+    breakingDesc = await input({
+      message: "描述破坏性变更:",
+      validate: (value) => (value.trim() ? true : "请描述破坏性变更"),
+      theme,
+    });
+  }
+
+  // 关联 Issue (可选)
+  const issues = await input({
+    message: "关联 Issue (如 #123, 可跳过):",
+    theme,
+  });
+
+  // 构建 commit message
+  const { type, emoji } = typeChoice;
+  const scopePart = scope ? `(${scope})` : "";
+  const breakingMark = hasBreaking ? "!" : "";
+
+  // 根据配置决定是否使用 emoji
+  const useEmoji = config.useEmoji ?? true;
+  const emojiPrefix = useEmoji ? `${emoji} ` : "";
+
+  // Header: [emoji] type(scope)!: subject
+  let message = `${emojiPrefix}${type}${scopePart}${breakingMark}: ${subject}`;
+
+  // Body
+  if (body || hasBreaking || issues) {
+    message += "\n";
+
+    if (body) {
+      message += `\n${body}`;
+    }
+
+    if (hasBreaking) {
+      message += `\n\nBREAKING CHANGE: ${breakingDesc}`;
+    }
+
+    if (issues) {
+      message += `\n\n${issues}`;
+    }
+  }
+
+  divider();
+  console.log("提交信息预览:");
+  console.log(colors.green(message));
+  divider();
+
+  const shouldCommit = await confirm({
+    message: "确认提交?",
+    default: true,
+    theme,
+  });
+
+  if (!shouldCommit) {
+    console.log(colors.yellow("已取消"));
+    return;
+  }
+
+  const spinner = ora("正在提交...").start();
+
+  try {
+    // 使用 -m 参数，需要转义引号
+    const escapedMessage = message.replace(/"/g, '\\"');
+    execSync(`git commit -m "${escapedMessage}"`, { stdio: "pipe" });
+    spinner.succeed("提交成功");
+
+    // 显示提交信息
+    const commitHash = execOutput("git rev-parse --short HEAD");
+    console.log(colors.dim(`commit: ${commitHash}`));
+  } catch (error) {
+    spinner.fail("提交失败");
+    if (error instanceof Error) {
+      console.log(colors.red(error.message));
+    }
+  }
+}

package/src/commands/help.ts

@@ -4,43 +4,52 @@ export function showHelp(): string {
   return `
 分支命令:
   gw feature [--base <branch>]    创建 feature 分支
-  gw feat [--base <branch>]       同上 (简写)
-  gw f [--base <branch>]          同上 (简写)
+  gw feat [--base <branch>]       同上 (别名)
+  gw f [--base <branch>]          同上 (别名)
 
   gw hotfix [--base <branch>]     创建 hotfix 分支
-  gw fix [--base <branch>]        同上 (简写)
-  gw h [--base <branch>]          同上 (简写)
+  gw fix [--base <branch>]        同上 (别名)
+  gw h [--base <branch>]          同上 (别名)
 
   gw delete [branch]              删除本地/远程分支
-  gw del [branch]                 同上 (简写)
-  gw d [branch]                   同上 (简写)
+  gw del [branch]                 同上 (别名)
+  gw d [branch]                   同上 (别名)
 
 Tag 命令:
   gw tags [prefix]                列出所有 tag，可按前缀过滤
-  gw ts [prefix]                  同上 (简写)
+  gw ts [prefix]                  同上 (别名)
 
   gw tag [prefix]                 交互式选择版本类型并创建 tag
-  gw t [prefix]                   同上 (简写)
+  gw t [prefix]                   同上 (别名)
 
 发布命令:
   gw release                      交互式选择版本号并更新 package.json
-  gw r                            同上 (简写)
+  gw r                            同上 (别名)
 
 配置命令:
   gw init                         初始化配置文件 .gwrc.json
 
 Stash 命令:
   gw stash                        交互式管理 stash
-  gw s                            同上 (简写)
+  gw s                            同上 (别名)
+  gw st                           同上 (别名)
+
+Commit 命令:
+  gw commit                       交互式提交 (Conventional Commits + Gitmoji)
+  gw c                            同上 (别名)
+  gw cm                           同上 (别名)
 
 示例:
-  gw feat                         基于 main/master 创建 feature 分支
-  gw feat --base develop          基于 develop 分支创建 feature 分支
-  gw fix --base release           基于 release 分支创建 hotfix 分支
-  gw del                          交互式选择并删除分支
-  gw del feature/xxx              直接删除指定分支
-  gw tags v                       列出所有 v 开头的 tag
-  gw tag                          交互式创建 tag
+  gw f                            基于 main/master 创建 feature 分支
+  gw f --base develop             基于 develop 分支创建 feature 分支
+  gw h --base release             基于 release 分支创建 hotfix 分支
+  gw d                            交互式选择并删除分支
+  gw d feature/xxx                直接删除指定分支
+  gw ts v                         列出所有 v 开头的 tag
+  gw t                            交互式创建 tag
+  gw r                            交互式发布版本
+  gw s                            交互式管理 stash
+  gw c                            交互式提交代码
 
 分支命名格式:
   feature/${TODAY}-<Story ID>-<描述>

package/src/commands/init.ts

@@ -5,6 +5,21 @@ import type { GwConfig } from "../config.js";
 
 const CONFIG_FILE = ".gwrc.json";
 
+// 默认的 commit emoji 配置
+const DEFAULT_COMMIT_EMOJIS = {
+  feat: "✨",
+  fix: "🐛",
+  docs: "📝",
+  style: "💄",
+  refactor: "♻️",
+  perf: "⚡️",
+  test: "✅",
+  build: "📦",
+  ci: "👷",
+  chore: "🔧",
+  revert: "⏪",
+};
+
 export async function init(): Promise<void> {
   if (existsSync(CONFIG_FILE)) {
     const overwrite = await confirm({
@@ -94,10 +109,35 @@ export async function init(): Promise<void> {
 
   divider();
 
+  // Commit 配置
+  const autoStage = await confirm({
+    message: "Commit 时是否自动暂存所有更改?",
+    default: true,
+    theme,
+  });
+  if (!autoStage) config.autoStage = false;
+
+  const useEmoji = await confirm({
+    message: "Commit 时是否使用 emoji?",
+    default: true,
+    theme,
+  });
+  if (!useEmoji) config.useEmoji = false;
+
+  // 始终写入默认的 commitEmojis 配置，方便用户修改
+  config.commitEmojis = DEFAULT_COMMIT_EMOJIS;
+
+  divider();
+
   // 写入配置
   const content = JSON.stringify(config, null, 2);
   writeFileSync(CONFIG_FILE, content + "\n");
 
   console.log(colors.green(`✓ 配置已保存到 ${CONFIG_FILE}`));
+  console.log(
+    colors.dim(
+      "\n提示: 可以在配置文件中修改 commitEmojis 来自定义各类型的 emoji"
+    )
+  );
   console.log(colors.dim("\n" + content));
 }

package/src/commands/tag.ts

@@ -42,6 +42,14 @@ interface TagChoice {
   value: string;
 }
 
+// 获取指定前缀的最新 tag（不依赖 shell 管道）
+function getLatestTag(prefix: string): string {
+  const tags = execOutput(`git tag -l "${prefix}*" --sort=-v:refname`)
+    .split("\n")
+    .filter(Boolean);
+  return tags[0] || "";
+}
+
 export async function createTag(inputPrefix?: string): Promise<void> {
   const config = getConfig();
   const fetchSpinner = ora("正在获取 tags...").start();
@@ -60,13 +68,68 @@ export async function createTag(inputPrefix?: string): Promise<void> {
 
   if (!prefix) {
     const allTags = execOutput("git tag -l").split("\n").filter(Boolean);
+
+    // 仓库没有任何 tag 的情况
+    if (allTags.length === 0) {
+      prefix = await input({
+        message: "当前仓库没有 tag，请输入前缀 (如 v):",
+        default: "v",
+        theme,
+      });
+      if (!prefix) {
+        console.log(colors.yellow("已取消"));
+        return;
+      }
+
+      // 选择初始版本号
+      const initialVersion = await select({
+        message: "选择初始版本号:",
+        choices: [
+          { name: `${prefix}0.0.1`, value: "0.0.1" },
+          { name: `${prefix}0.1.0`, value: "0.1.0" },
+          { name: `${prefix}1.0.0`, value: "1.0.0" },
+          { name: "自定义...", value: "__custom__" },
+        ],
+        theme,
+      });
+
+      let version = initialVersion;
+      if (initialVersion === "__custom__") {
+        version = await input({
+          message: "请输入版本号 (如 0.0.1):",
+          theme,
+        });
+        if (!version) {
+          console.log(colors.yellow("已取消"));
+          return;
+        }
+      }
+
+      const newTag = `${prefix}${version}`;
+      const ok = await select({
+        message: `确认创建 ${newTag}?`,
+        choices: [
+          { name: "是", value: true },
+          { name: "否", value: false },
+        ],
+        theme,
+      });
+      if (ok) {
+        doCreateTag(newTag);
+      }
+      return;
+    }
+
+    // 从现有 tag 中提取前缀
     const prefixes = [
       ...new Set(allTags.map((t) => t.replace(/[0-9].*/, "")).filter(Boolean)),
     ];
 
     if (prefixes.length === 0) {
+      // 有 tag 但无法提取前缀（比如纯数字 tag）
       prefix = await input({
-        message: "当前仓库没有 tag，请输入新前缀 (如 v):",
+        message: "请输入 tag 前缀 (如 v):",
+        default: "v",
         theme,
       });
       if (!prefix) {
@@ -75,9 +138,7 @@ export async function createTag(inputPrefix?: string): Promise<void> {
       }
     } else {
       const prefixWithDate: PrefixInfo[] = prefixes.map((p) => {
-        const latest = execOutput(
-          `git tag -l "${p}*" --sort=-v:refname | head -1`
-        );
+        const latest = getLatestTag(p);
         const date = latest
           ? execOutput(`git log -1 --format=%ct "${latest}" 2>/dev/null`)
           : "0";
@@ -108,9 +169,7 @@ export async function createTag(inputPrefix?: string): Promise<void> {
     }
   }
 
-  const latestTag = execOutput(
-    `git tag -l "${prefix}*" --sort=-v:refname | head -1`
-  );
+  const latestTag = getLatestTag(prefix);
 
   if (!latestTag) {
     const newTag = `${prefix}1.0.0`;

package/src/config.ts

@@ -18,6 +18,24 @@ export interface GwConfig {
   defaultTagPrefix?: string;
   // 创建分支后是否自动推送，默认询问
   autoPush?: boolean;
+  // commit 时是否自动暂存所有更改，默认 true
+  autoStage?: boolean;
+  // commit 时是否使用 emoji，默认 true
+  useEmoji?: boolean;
+  // 自定义 commit 类型的 emoji
+  commitEmojis?: {
+    feat?: string;
+    fix?: string;
+    docs?: string;
+    style?: string;
+    refactor?: string;
+    perf?: string;
+    test?: string;
+    build?: string;
+    ci?: string;
+    chore?: string;
+    revert?: string;
+  };
 }
 
 const defaultConfig: GwConfig = {
@@ -26,6 +44,8 @@ const defaultConfig: GwConfig = {
   requireId: false,
   featureIdLabel: "Story ID",
   hotfixIdLabel: "Issue ID",
+  autoStage: true,
+  useEmoji: true,
 };
 
 function getGitRoot(): string {

package/src/index.ts

@@ -1,18 +1,146 @@
 // @ts-nocheck shebang handled by tsup banner
 
 import { cac } from "cac";
-import { checkGitRepo } from "./utils.js";
+import { select } from "@inquirer/prompts";
+import { ExitPromptError } from "@inquirer/core";
+import { checkGitRepo, theme, colors } from "./utils.js";
 import { createBranch, deleteBranch } from "./commands/branch.js";
 import { listTags, createTag } from "./commands/tag.js";
 import { release } from "./commands/release.js";
 import { init } from "./commands/init.js";
 import { stash } from "./commands/stash.js";
+import { commit } from "./commands/commit.js";
 import { showHelp } from "./commands/help.js";
 
-declare const __VERSION__: string;
+// 捕获 Ctrl+C 退出，静默处理
+process.on("uncaughtException", (err) => {
+  if (err instanceof ExitPromptError) {
+    process.exit(0);
+  }
+  console.error(err);
+  process.exit(1);
+});
+
+declare const __VERSION__: string | undefined;
+
+// 开发环境下从 package.json 读取版本号
+const version: string =
+  typeof __VERSION__ !== "undefined"
+    ? __VERSION__
+    : (await import("../package.json", { with: { type: "json" } })).default
+        .version;
+
+// 交互式主菜单
+async function mainMenu(): Promise<void> {
+  // ASCII Art Logo
+  console.log(
+    colors.green(`
+ ███████╗     ██╗███████╗██╗  ██╗
+ ╚══███╔╝     ██║██╔════╝╚██╗██╔╝
+   ███╔╝      ██║█████╗   ╚███╔╝ 
+  ███╔╝  ██   ██║██╔══╝   ██╔██╗ 
+ ███████╗╚█████╔╝███████╗██╔╝ ██╗
+ ╚══════╝ ╚════╝ ╚══════╝╚═╝  ╚═╝
+`)
+  );
+  console.log(colors.dim(`  git-workflow v${version}\n`));
+
+  const action = await select({
+    message: "选择操作:",
+    choices: [
+      {
+        name: `[1] ✨ 创建 feature 分支      ${colors.dim("gw f")}`,
+        value: "feature",
+      },
+      {
+        name: `[2] 🐛 创建 hotfix 分支       ${colors.dim("gw h")}`,
+        value: "hotfix",
+      },
+      {
+        name: `[3] 🗑️  删除分支               ${colors.dim("gw d")}`,
+        value: "delete",
+      },
+      {
+        name: `[4] 📝 提交代码               ${colors.dim("gw c")}`,
+        value: "commit",
+      },
+      {
+        name: `[5] 🏷️  创建 tag               ${colors.dim("gw t")}`,
+        value: "tag",
+      },
+      {
+        name: `[6] 📋 列出 tags              ${colors.dim("gw ts")}`,
+        value: "tags",
+      },
+      {
+        name: `[7] 📦 发布版本               ${colors.dim("gw r")}`,
+        value: "release",
+      },
+      {
+        name: `[8] 💾 管理 stash             ${colors.dim("gw s")}`,
+        value: "stash",
+      },
+      {
+        name: `[9] ⚙️  初始化配置             ${colors.dim("gw init")}`,
+        value: "init",
+      },
+      { name: "[0] ❓ 帮助", value: "help" },
+      { name: "[q] 退出", value: "exit" },
+    ],
+    loop: false,
+    theme,
+  });
+
+  switch (action) {
+    case "feature":
+      checkGitRepo();
+      await createBranch("feature");
+      break;
+    case "hotfix":
+      checkGitRepo();
+      await createBranch("hotfix");
+      break;
+    case "delete":
+      checkGitRepo();
+      await deleteBranch();
+      break;
+    case "tag":
+      checkGitRepo();
+      await createTag();
+      break;
+    case "tags":
+      checkGitRepo();
+      await listTags();
+      break;
+    case "commit":
+      checkGitRepo();
+      await commit();
+      break;
+    case "release":
+      await release();
+      break;
+    case "stash":
+      checkGitRepo();
+      await stash();
+      break;
+    case "init":
+      await init();
+      break;
+    case "help":
+      console.log(showHelp());
+      break;
+    case "exit":
+      break;
+  }
+}
 
 const cli = cac("gw");
 
+// 默认命令 - 显示交互式菜单
+cli.command("", "显示交互式菜单").action(() => {
+  return mainMenu();
+});
+
 cli
   .command("feature", "创建 feature 分支")
   .alias("feat")
@@ -78,11 +206,20 @@ cli
     return stash();
   });
 
+cli
+  .command("commit", "交互式提交 (Conventional Commits + Gitmoji)")
+  .alias("c")
+  .alias("cm")
+  .action(() => {
+    checkGitRepo();
+    return commit();
+  });
+
 cli.help((sections) => {
   sections.push({
     body: showHelp(),
   });
 });
-cli.version(__VERSION__);
+cli.version(version);
 
 cli.parse();