@zjex/git-workflow 0.0.1 → 0.1.0

package/src/commands/branch.ts

@@ -49,6 +49,38 @@ export async function createBranch(
 ): Promise<void> {
   const config = getConfig();
 
+  // 检查是否有未提交的更改
+  const hasChanges = execOutput("git status --porcelain");
+  if (hasChanges) {
+    console.log(colors.yellow("检测到未提交的更改:"));
+    console.log(colors.dim(hasChanges));
+    divider();
+
+    const shouldStash = await select({
+      message: "是否暂存 (stash) 这些更改后继续?",
+      choices: [
+        { name: "是", value: true },
+        { name: "否，取消操作", value: false },
+      ],
+      theme,
+    });
+
+    if (!shouldStash) {
+      console.log(colors.yellow("已取消"));
+      return;
+    }
+
+    const stashSpinner = ora("正在暂存更改...").start();
+    try {
+      exec('git stash push -m "auto stash before branch switch"', true);
+      stashSpinner.succeed("更改已暂存，切换分支后可用 gw s 恢复");
+    } catch {
+      stashSpinner.fail("暂存失败");
+      return;
+    }
+    divider();
+  }
+
   const branchName = await getBranchName(type);
   if (!branchName) return;
 
@@ -118,15 +150,32 @@ export async function deleteBranch(branchArg?: string): Promise<void> {
 
   let branch = branchArg;
 
+  // 如果传入的是 origin/xxx 格式，提取分支名
+  if (branch?.startsWith("origin/")) {
+    branch = branch.replace("origin/", "");
+  }
+
   if (!branch) {
-    const recentBranches = execOutput(
+    // 获取本地分支
+    const localBranches = execOutput(
       "git for-each-ref --sort=-committerdate refs/heads/ --format='%(refname:short)'"
     )
       .split("\n")
       .filter((b) => b && b !== currentBranch);
 
-    if (recentBranches.length === 0) {
-      console.log(colors.yellow("没有可删除的本地分支"));
+    // 获取远程分支（排除 HEAD 和已有本地分支的）
+    const remoteBranches = execOutput(
+      "git for-each-ref --sort=-committerdate refs/remotes/origin/ --format='%(refname:short)'"
+    )
+      .split("\n")
+      .map((b) => b.replace("origin/", ""))
+      .filter(
+        (b) =>
+          b && b !== "HEAD" && b !== currentBranch && !localBranches.includes(b)
+      );
+
+    if (localBranches.length === 0 && remoteBranches.length === 0) {
+      console.log(colors.yellow("没有可删除的分支"));
       return;
     }
 
@@ -135,13 +184,25 @@ export async function deleteBranch(branchArg?: string): Promise<void> {
       value: string;
     }
 
-    const choices: BranchChoice[] = recentBranches.map((b) => {
-      const hasRemote = execOutput(`git branch -r | grep "origin/${b}$"`);
-      return {
+    const choices: BranchChoice[] = [];
+
+    // 本地分支
+    localBranches.forEach((b) => {
+      const hasRemote = execOutput(`git branch -r --list "origin/${b}"`);
+      choices.push({
         name: hasRemote ? `${b} (本地+远程)` : `${b} (仅本地)`,
         value: b,
-      };
+      });
     });
+
+    // 仅远程分支
+    remoteBranches.forEach((b) => {
+      choices.push({
+        name: `${b} (仅远程)`,
+        value: `__remote__${b}`,
+      });
+    });
+
     choices.push({ name: "取消", value: "__cancel__" });
 
     branch = await select({
@@ -154,6 +215,36 @@ export async function deleteBranch(branchArg?: string): Promise<void> {
       console.log(colors.yellow("已取消"));
       return;
     }
+
+    // 处理仅远程分支的情况
+    if (branch.startsWith("__remote__")) {
+      const remoteBranch = branch.replace("__remote__", "");
+
+      const confirm = await select({
+        message: `确认删除远程分支 origin/${remoteBranch}?`,
+        choices: [
+          { name: "是", value: true },
+          { name: "否", value: false },
+        ],
+        theme,
+      });
+
+      if (!confirm) {
+        console.log(colors.yellow("已取消"));
+        return;
+      }
+
+      const spinner = ora(`正在删除远程分支: origin/${remoteBranch}`).start();
+      try {
+        execSync(`git push origin --delete "${remoteBranch}"`, {
+          stdio: "pipe",
+        });
+        spinner.succeed(`远程分支已删除: origin/${remoteBranch}`);
+      } catch {
+        spinner.fail("远程分支删除失败");
+      }
+      return;
+    }
   }
 
   if (branch === currentBranch) {
@@ -162,7 +253,7 @@ export async function deleteBranch(branchArg?: string): Promise<void> {
   }
 
   const localExists = execOutput(`git branch --list "${branch}"`);
-  const hasRemote = execOutput(`git branch -r | grep "origin/${branch}$"`);
+  const hasRemote = execOutput(`git branch -r --list "origin/${branch}"`);
 
   if (!localExists) {
     if (hasRemote) {
@@ -170,7 +261,7 @@ export async function deleteBranch(branchArg?: string): Promise<void> {
         colors.yellow(`本地分支不存在，但远程分支存在: origin/${branch}`)
       );
       const deleteRemote = await select({
-        message: `是否删除远程分支 origin/${branch}?`,
+        message: `确认删除远程分支 origin/${branch}?`,
         choices: [
           { name: "是", value: true },
           { name: "否", value: false },
@@ -193,6 +284,23 @@ export async function deleteBranch(branchArg?: string): Promise<void> {
     return;
   }
 
+  // 删除本地分支前确认
+  const confirmDelete = await select({
+    message: `确认删除分支 ${branch}?${
+      hasRemote ? " (本地+远程)" : " (仅本地)"
+    }`,
+    choices: [
+      { name: "是", value: true },
+      { name: "否", value: false },
+    ],
+    theme,
+  });
+
+  if (!confirmDelete) {
+    console.log(colors.yellow("已取消"));
+    return;
+  }
+
   const localSpinner = ora(`正在删除本地分支: ${branch}`).start();
   try {
     execSync(`git branch -D "${branch}"`, { stdio: "pipe" });
@@ -203,25 +311,12 @@ export async function deleteBranch(branchArg?: string): Promise<void> {
   }
 
   if (hasRemote) {
-    divider();
-
-    const deleteRemote = await select({
-      message: `是否同时删除远程分支 origin/${branch}?`,
-      choices: [
-        { name: "是", value: true },
-        { name: "否", value: false },
-      ],
-      theme,
-    });
-
-    if (deleteRemote) {
-      const remoteSpinner = ora(`正在删除远程分支: origin/${branch}`).start();
-      try {
-        execSync(`git push origin --delete "${branch}"`, { stdio: "pipe" });
-        remoteSpinner.succeed(`远程分支已删除: origin/${branch}`);
-      } catch {
-        remoteSpinner.fail("远程分支删除失败");
-      }
+    const remoteSpinner = ora(`正在删除远程分支: origin/${branch}`).start();
+    try {
+      execSync(`git push origin --delete "${branch}"`, { stdio: "pipe" });
+      remoteSpinner.succeed(`远程分支已删除: origin/${branch}`);
+    } catch {
+      remoteSpinner.fail("远程分支删除失败");
     }
   }
 }

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));
 }