@zjex/git-workflow 0.3.7 → 0.3.9

package/README.md

@@ -12,7 +12,7 @@
   <a href="https://github.com/iamzjt-front-end/git-workflow"><img src="https://img.shields.io/github/stars/iamzjt-front-end/git-workflow?style=flat&colorA=18181B&colorB=F59E0B" alt="github stars"></a>
   <a href="https://github.com/iamzjt-front-end/git-workflow/blob/main/LICENSE"><img src="https://img.shields.io/npm/l/@zjex/git-workflow?style=flat&colorA=18181B&colorB=10B981" alt="license"></a>
   <a href="https://nodejs.org"><img src="https://img.shields.io/badge/node-%3E%3D18-339933?style=flat&logo=node.js&logoColor=white&colorA=18181B" alt="node version"></a>
-  <a href="https://github.com/iamzjt-front-end/git-workflow/actions"><img src="https://img.shields.io/badge/tests-267%20passed-success?style=flat&colorA=18181B" alt="tests"></a>
+  <a href="https://github.com/iamzjt-front-end/git-workflow/actions"><img src="https://img.shields.io/badge/tests-290%20passed-success?style=flat&colorA=18181B" alt="tests"></a>
   <a href="https://github.com/iamzjt-front-end/git-workflow/issues"><img src="https://img.shields.io/github/issues/iamzjt-front-end/git-workflow?style=flat&colorA=18181B&colorB=EC4899" alt="issues"></a>
 </p>
 

package/dist/index.js

@@ -91,9 +91,9 @@ __export(update_notifier_exports, {
   clearUpdateCache: () => clearUpdateCache
 });
 import { execSync as execSync6 } from "child_process";
-import { readFileSync as readFileSync3, writeFileSync as writeFileSync3, existsSync as existsSync3, unlinkSync } from "fs";
+import { readFileSync as readFileSync3, writeFileSync as writeFileSync4, existsSync as existsSync3, unlinkSync as unlinkSync2 } from "fs";
 import { homedir as homedir3 } from "os";
-import { join as join3 } from "path";
+import { join as join4 } from "path";
 import boxen from "boxen";
 import { select as select7 } from "@inquirer/prompts";
 import ora5 from "ora";
@@ -179,11 +179,10 @@ function showSimpleNotification(current, latest) {
   )} \u2192 ${colors.green(latest)}    ${colors.dim("\u8FD0\u884C")} ${colors.cyan(
     "gw update"
   )} ${colors.dim("\u66F4\u65B0")}`;
-  console.log("");
   console.log(
     boxen(message, {
       padding: { top: 0, bottom: 0, left: 2, right: 2 },
-      margin: { top: 0, bottom: 1, left: 0, right: 0 },
+      margin: { top: 0, bottom: 0, left: 0, right: 0 },
       borderStyle: "round",
       borderColor: "yellow",
       align: "center"
@@ -283,16 +282,16 @@ async function performUpdate(packageName) {
 }
 function clearUpdateCache() {
   try {
-    const cacheFile = join3(homedir3(), CACHE_FILE);
+    const cacheFile = join4(homedir3(), CACHE_FILE);
     if (existsSync3(cacheFile)) {
-      unlinkSync(cacheFile);
+      unlinkSync2(cacheFile);
     }
   } catch {
   }
 }
 function readCache() {
   try {
-    const cacheFile = join3(homedir3(), CACHE_FILE);
+    const cacheFile = join4(homedir3(), CACHE_FILE);
     if (!existsSync3(cacheFile)) {
       return null;
     }
@@ -304,8 +303,8 @@ function readCache() {
 }
 function writeCache(cache) {
   try {
-    const cacheFile = join3(homedir3(), CACHE_FILE);
-    writeFileSync3(cacheFile, JSON.stringify(cache), "utf-8");
+    const cacheFile = join4(homedir3(), CACHE_FILE);
+    writeFileSync4(cacheFile, JSON.stringify(cache), "utf-8");
   } catch {
   }
 }
@@ -431,12 +430,22 @@ async function getBranchName(type) {
     console.log(colors.red(`${idLabel}\u4E0D\u80FD\u4E3A\u7A7A`));
     return null;
   }
-  const description = await input({ message: "\u8BF7\u8F93\u5165\u63CF\u8FF0:", theme });
-  if (!description) {
+  const requireDescription = type === "feature" ? config2.featureRequireDescription ?? false : config2.hotfixRequireDescription ?? false;
+  const descMessage = requireDescription ? "\u8BF7\u8F93\u5165\u63CF\u8FF0:" : "\u8BF7\u8F93\u5165\u63CF\u8FF0 (\u53EF\u8DF3\u8FC7):";
+  const description = await input({ message: descMessage, theme });
+  if (requireDescription && !description) {
     console.log(colors.red("\u63CF\u8FF0\u4E0D\u80FD\u4E3A\u7A7A"));
     return null;
   }
-  return id ? `${branchPrefix}/${TODAY}-${id}-${description}` : `${branchPrefix}/${TODAY}-${description}`;
+  if (id && description) {
+    return `${branchPrefix}/${TODAY}-${id}-${description}`;
+  } else if (id) {
+    return `${branchPrefix}/${TODAY}-${id}`;
+  } else if (description) {
+    return `${branchPrefix}/${TODAY}-${description}`;
+  } else {
+    return `${branchPrefix}/${TODAY}`;
+  }
 }
 async function createBranch(type, baseBranchArg) {
   const config2 = getConfig();
@@ -1327,6 +1336,25 @@ async function init() {
   });
   config2.hotfixIdLabel = hotfixIdLabel;
   divider();
+  const featureRequireDescription = await select4({
+    message: "Feature \u5206\u652F\u662F\u5426\u8981\u6C42\u5FC5\u586B\u63CF\u8FF0?",
+    choices: [
+      { name: "\u5426", value: false },
+      { name: "\u662F", value: true }
+    ],
+    theme
+  });
+  config2.featureRequireDescription = featureRequireDescription;
+  const hotfixRequireDescription = await select4({
+    message: "Hotfix \u5206\u652F\u662F\u5426\u8981\u6C42\u5FC5\u586B\u63CF\u8FF0?",
+    choices: [
+      { name: "\u5426", value: false },
+      { name: "\u662F", value: true }
+    ],
+    theme
+  });
+  config2.hotfixRequireDescription = hotfixRequireDescription;
+  divider();
   const defaultTagPrefix = await input3({
     message: "\u9ED8\u8BA4 Tag \u524D\u7F00 (\u7559\u7A7A\u5219\u6BCF\u6B21\u9009\u62E9):",
     theme
@@ -1791,6 +1819,9 @@ async function dropStash(index) {
 // src/commands/commit.ts
 init_utils();
 import { execSync as execSync5 } from "child_process";
+import { writeFileSync as writeFileSync3, unlinkSync } from "fs";
+import { tmpdir } from "os";
+import { join as join3 } from "path";
 import { select as select6, input as input5, checkbox } from "@inquirer/prompts";
 import ora4 from "ora";
 
@@ -2198,45 +2229,39 @@ function formatFileStatus(status) {
 }
 async function commit() {
   const config2 = getConfig();
+  const autoStage = config2.autoStage ?? true;
+  if (autoStage) {
+    execSync5("git add -A", { stdio: "pipe" });
+  }
   let { staged, unstaged } = parseGitStatus();
-  if (unstaged.length > 0) {
-    const autoStage = config2.autoStage ?? true;
-    if (autoStage) {
-      execSync5("git add -A", { stdio: "pipe" });
-      console.log(colors.green("\u2714 \u5DF2\u81EA\u52A8\u6682\u5B58\u6240\u6709\u66F4\u6539"));
-      divider();
-      const newStatus = parseGitStatus();
-      staged = newStatus.staged;
-      unstaged = newStatus.unstaged;
-    } else if (staged.length === 0) {
-      console.log(colors.yellow("\u6CA1\u6709\u6682\u5B58\u7684\u66F4\u6539"));
-      divider();
-      console.log("\u672A\u6682\u5B58\u7684\u6587\u4EF6:");
-      for (const { status, file } of unstaged) {
-        console.log(`  ${formatFileStatus(status)} ${file}`);
-      }
-      divider();
-      const filesToStage = await checkbox({
-        message: "\u9009\u62E9\u8981\u6682\u5B58\u7684\u6587\u4EF6:",
-        choices: unstaged.map(({ status, file }) => ({
-          name: `${formatFileStatus(status)} ${file}`,
-          value: file,
-          checked: true
-        })),
-        theme
-      });
-      if (filesToStage.length === 0) {
-        console.log(colors.yellow("\u6CA1\u6709\u9009\u62E9\u4EFB\u4F55\u6587\u4EF6\uFF0C\u5DF2\u53D6\u6D88"));
-        return;
-      }
-      for (const file of filesToStage) {
-        execSync5(`git add "${file}"`, { stdio: "pipe" });
-      }
-      console.log(colors.green(`\u2714 \u5DF2\u6682\u5B58 ${filesToStage.length} \u4E2A\u6587\u4EF6`));
-      divider();
-      const newStatus = parseGitStatus();
-      staged = newStatus.staged;
+  if (staged.length === 0 && unstaged.length > 0 && !autoStage) {
+    console.log(colors.yellow("\u6CA1\u6709\u6682\u5B58\u7684\u66F4\u6539"));
+    divider();
+    console.log("\u672A\u6682\u5B58\u7684\u6587\u4EF6:");
+    for (const { status, file } of unstaged) {
+      console.log(`  ${formatFileStatus(status)} ${file}`);
+    }
+    divider();
+    const filesToStage = await checkbox({
+      message: "\u9009\u62E9\u8981\u6682\u5B58\u7684\u6587\u4EF6:",
+      choices: unstaged.map(({ status, file }) => ({
+        name: `${formatFileStatus(status)} ${file}`,
+        value: file,
+        checked: true
+      })),
+      theme
+    });
+    if (filesToStage.length === 0) {
+      console.log(colors.yellow("\u6CA1\u6709\u9009\u62E9\u4EFB\u4F55\u6587\u4EF6\uFF0C\u5DF2\u53D6\u6D88"));
+      return;
+    }
+    for (const file of filesToStage) {
+      execSync5(`git add "${file}"`, { stdio: "pipe" });
     }
+    console.log(colors.green(`\u2714 \u5DF2\u6682\u5B58 ${filesToStage.length} \u4E2A\u6587\u4EF6`));
+    divider();
+    const newStatus = parseGitStatus();
+    staged = newStatus.staged;
   }
   if (staged.length === 0) {
     console.log(colors.yellow("\u5DE5\u4F5C\u533A\u5E72\u51C0\uFF0C\u6CA1\u6709\u9700\u8981\u63D0\u4EA4\u7684\u66F4\u6539"));
@@ -2322,14 +2347,10 @@ async function commit() {
   }
   const spinner = ora4("\u6B63\u5728\u63D0\u4EA4...").start();
   try {
-    let finalStatus = parseGitStatus();
-    if (finalStatus.staged.length === 0 && finalStatus.unstaged.length > 0) {
-      const autoStage = config2.autoStage ?? true;
-      if (autoStage) {
-        execSync5("git add -A", { stdio: "pipe" });
-        finalStatus = parseGitStatus();
-      }
+    if (autoStage) {
+      execSync5("git add -A", { stdio: "pipe" });
     }
+    const finalStatus = parseGitStatus();
     if (finalStatus.staged.length === 0) {
       spinner.fail("\u6CA1\u6709\u6682\u5B58\u7684\u6587\u4EF6\u53EF\u4EE5\u63D0\u4EA4");
       console.log("");
@@ -2340,9 +2361,18 @@ async function commit() {
       console.log("");
       return;
     }
-    execSync5(`git commit -F -`, {
-      input: message
-    });
+    const tmpFile = join3(tmpdir(), `.gw-commit-msg-${Date.now()}`);
+    try {
+      writeFileSync3(tmpFile, message, "utf-8");
+      execSync5(`git commit -F "${tmpFile}"`, {
+        stdio: ["pipe", "pipe", "pipe"]
+      });
+    } finally {
+      try {
+        unlinkSync(tmpFile);
+      } catch {
+      }
+    }
     spinner.succeed("\u63D0\u4EA4\u6210\u529F");
     const commitHash = execOutput("git rev-parse --short HEAD");
     console.log(colors.dim(`commit: ${commitHash}`));
@@ -2449,15 +2479,15 @@ import { execSync as execSync7 } from "child_process";
 import ora6 from "ora";
 import boxen2 from "boxen";
 import semver2 from "semver";
-import { existsSync as existsSync4, unlinkSync as unlinkSync2 } from "fs";
+import { existsSync as existsSync4, unlinkSync as unlinkSync3 } from "fs";
 import { homedir as homedir4 } from "os";
-import { join as join4 } from "path";
+import { join as join5 } from "path";
 var CACHE_FILE2 = ".gw-update-check";
 function clearUpdateCache2() {
   try {
-    const cacheFile = join4(homedir4(), CACHE_FILE2);
+    const cacheFile = join5(homedir4(), CACHE_FILE2);
     if (existsSync4(cacheFile)) {
-      unlinkSync2(cacheFile);
+      unlinkSync3(cacheFile);
     }
   } catch {
   }
@@ -2914,7 +2944,7 @@ process.on("SIGTERM", () => {
   console.log("");
   process.exit(0);
 });
-var version = true ? "0.3.7" : "0.0.0-dev";
+var version = true ? "0.3.9" : "0.0.0-dev";
 async function mainMenu() {
   console.log(
     colors.green(`

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@zjex/git-workflow",
-	"version": "0.3.7",
+	"version": "0.3.9",
 	"description": "🚀 极简的 Git 工作流 CLI 工具，让分支管理和版本发布变得轻松愉快",
 	"type": "module",
 	"bin": {

package/src/commands/branch.ts

@@ -32,15 +32,32 @@ export async function getBranchName(type: BranchType): Promise<string | null> {
     return null;
   }
 
-  const description = await input({ message: "请输入描述:", theme });
-  if (!description) {
+  // 描述是否必填，默认非必填
+  const requireDescription =
+    type === "feature"
+      ? config.featureRequireDescription ?? false
+      : config.hotfixRequireDescription ?? false;
+  const descMessage = requireDescription
+    ? "请输入描述:"
+    : "请输入描述 (可跳过):";
+
+  const description = await input({ message: descMessage, theme });
+
+  if (requireDescription && !description) {
     console.log(colors.red("描述不能为空"));
     return null;
   }
 
-  return id
-    ? `${branchPrefix}/${TODAY}-${id}-${description}`
-    : `${branchPrefix}/${TODAY}-${description}`;
+  // 构建分支名
+  if (id && description) {
+    return `${branchPrefix}/${TODAY}-${id}-${description}`;
+  } else if (id) {
+    return `${branchPrefix}/${TODAY}-${id}`;
+  } else if (description) {
+    return `${branchPrefix}/${TODAY}-${description}`;
+  } else {
+    return `${branchPrefix}/${TODAY}`;
+  }
 }
 
 export async function createBranch(

package/src/commands/commit.ts

@@ -1,4 +1,7 @@
 import { execSync } from "child_process";
+import { writeFileSync, unlinkSync } from "fs";
+import { tmpdir } from "os";
+import { join } from "path";
 import { select, input, checkbox } from "@inquirer/prompts";
 import ora from "ora";
 import { colors, theme, execOutput, divider } from "../utils.js";
@@ -102,58 +105,52 @@ function formatFileStatus(status: string): string {
  */
 export async function commit(): Promise<void> {
   const config = getConfig();
-  let { staged, unstaged } = parseGitStatus();
-
-  // ========== 步骤 1: 处理未暂存的文件 ==========
-  if (unstaged.length > 0) {
-    const autoStage = config.autoStage ?? true;
+  const autoStage = config.autoStage ?? true;
 
-    if (autoStage) {
-      // 自动暂存所有文件
-      execSync("git add -A", { stdio: "pipe" });
-      console.log(colors.green("✔ 已自动暂存所有更改"));
-      divider();
-      // 重新获取状态
-      const newStatus = parseGitStatus();
-      staged = newStatus.staged;
-      unstaged = newStatus.unstaged;
-    } else if (staged.length === 0) {
-      // 没有暂存的文件，且不自动暂存，让用户选择
-      console.log(colors.yellow("没有暂存的更改"));
-      divider();
-      console.log("未暂存的文件:");
-      for (const { status, file } of unstaged) {
-        console.log(`  ${formatFileStatus(status)} ${file}`);
-      }
-      divider();
+  // ========== 步骤 1: 自动暂存（如果启用）==========
+  if (autoStage) {
+    execSync("git add -A", { stdio: "pipe" });
+  }
 
-      // 让用户选择要暂存的文件
-      const filesToStage = await checkbox({
-        message: "选择要暂存的文件:",
-        choices: unstaged.map(({ status, file }) => ({
-          name: `${formatFileStatus(status)} ${file}`,
-          value: file,
-          checked: true,
-        })),
-        theme,
-      });
+  // 获取当前状态
+  let { staged, unstaged } = parseGitStatus();
 
-      if (filesToStage.length === 0) {
-        console.log(colors.yellow("没有选择任何文件，已取消"));
-        return;
-      }
+  // ========== 步骤 2: 如果没有暂存文件，让用户选择 ==========
+  if (staged.length === 0 && unstaged.length > 0 && !autoStage) {
+    console.log(colors.yellow("没有暂存的更改"));
+    divider();
+    console.log("未暂存的文件:");
+    for (const { status, file } of unstaged) {
+      console.log(`  ${formatFileStatus(status)} ${file}`);
+    }
+    divider();
+
+    // 让用户选择要暂存的文件
+    const filesToStage = await checkbox({
+      message: "选择要暂存的文件:",
+      choices: unstaged.map(({ status, file }) => ({
+        name: `${formatFileStatus(status)} ${file}`,
+        value: file,
+        checked: true,
+      })),
+      theme,
+    });
 
-      // 暂存选中的文件
-      for (const file of filesToStage) {
-        execSync(`git add "${file}"`, { stdio: "pipe" });
-      }
-      console.log(colors.green(`✔ 已暂存 ${filesToStage.length} 个文件`));
-      divider();
+    if (filesToStage.length === 0) {
+      console.log(colors.yellow("没有选择任何文件，已取消"));
+      return;
+    }
 
-      // 重新获取状态
-      const newStatus = parseGitStatus();
-      staged = newStatus.staged;
+    // 暂存选中的文件
+    for (const file of filesToStage) {
+      execSync(`git add "${file}"`, { stdio: "pipe" });
     }
+    console.log(colors.green(`✔ 已暂存 ${filesToStage.length} 个文件`));
+    divider();
+
+    // 重新获取状态
+    const newStatus = parseGitStatus();
+    staged = newStatus.staged;
   }
 
   // ========== 步骤 2: 检查是否有文件可提交 ==========
@@ -264,18 +261,13 @@ export async function commit(): Promise<void> {
   const spinner = ora("正在提交...").start();
 
   try {
-    // 提交前再次检查是否有暂存的文件
-    let finalStatus = parseGitStatus();
-
-    // 如果暂存区为空，但有未暂存的更改，且开启了自动暂存，则重新暂存
-    if (finalStatus.staged.length === 0 && finalStatus.unstaged.length > 0) {
-      const autoStage = config.autoStage ?? true;
-      if (autoStage) {
-        execSync("git add -A", { stdio: "pipe" });
-        finalStatus = parseGitStatus();
-      }
+    // 提交前再次暂存所有更改（确保不会遗漏）
+    if (autoStage) {
+      execSync("git add -A", { stdio: "pipe" });
     }
 
+    // 检查是否有暂存的文件
+    const finalStatus = parseGitStatus();
     if (finalStatus.staged.length === 0) {
       spinner.fail("没有暂存的文件可以提交");
       console.log("");
@@ -287,11 +279,21 @@ export async function commit(): Promise<void> {
       return;
     }
 
-    // 处理多行消息：使用 git commit -F - 通过 stdin 传递
-    // 这样可以正确处理包含换行符的 commit message
-    execSync(`git commit -F -`, {
-      input: message,
-    });
+    // 处理多行消息：使用临时文件传递 commit message
+    const tmpFile = join(tmpdir(), `.gw-commit-msg-${Date.now()}`);
+    try {
+      writeFileSync(tmpFile, message, "utf-8");
+      execSync(`git commit -F "${tmpFile}"`, {
+        stdio: ["pipe", "pipe", "pipe"],
+      });
+    } finally {
+      // 清理临时文件
+      try {
+        unlinkSync(tmpFile);
+      } catch {
+        // 忽略删除失败
+      }
+    }
     spinner.succeed("提交成功");
 
     // 显示提交信息

package/src/commands/init.ts

@@ -118,6 +118,29 @@ export async function init(): Promise<void> {
 
   divider();
 
+  // 描述必填配置
+  const featureRequireDescription = await select({
+    message: "Feature 分支是否要求必填描述?",
+    choices: [
+      { name: "否", value: false },
+      { name: "是", value: true },
+    ],
+    theme,
+  });
+  config.featureRequireDescription = featureRequireDescription;
+
+  const hotfixRequireDescription = await select({
+    message: "Hotfix 分支是否要求必填描述?",
+    choices: [
+      { name: "否", value: false },
+      { name: "是", value: true },
+    ],
+    theme,
+  });
+  config.hotfixRequireDescription = hotfixRequireDescription;
+
+  divider();
+
   // Tag 配置
   const defaultTagPrefix = await input({
     message: "默认 Tag 前缀 (留空则每次选择):",
@@ -269,15 +292,16 @@ export async function init(): Promise<void> {
     const detailedDescription = await select({
       message: "是否生成详细的修改点描述?",
       choices: [
-        { 
-          name: "是（包含修改点列表，推荐）", 
+        {
+          name: "是（包含修改点列表，推荐）",
           value: true,
-          description: "如：feat(auth): 添加用户登录功能\n\n- 实现用户名密码登录接口\n- 添加登录状态验证中间件"
+          description:
+            "如：feat(auth): 添加用户登录功能\n\n- 实现用户名密码登录接口\n- 添加登录状态验证中间件",
         },
-        { 
-          name: "否（仅生成标题）", 
+        {
+          name: "否（仅生成标题）",
           value: false,
-          description: "如：feat(auth): 添加用户登录功能"
+          description: "如：feat(auth): 添加用户登录功能",
         },
       ],
       theme,
@@ -286,20 +310,20 @@ export async function init(): Promise<void> {
     const aiUseEmoji = await select({
       message: "AI 生成的 commit message 是否包含 emoji?",
       choices: [
-        { 
-          name: "是（推荐）", 
+        {
+          name: "是（推荐）",
           value: true,
-          description: "如：✨ feat(auth): 添加用户登录功能"
+          description: "如：✨ feat(auth): 添加用户登录功能",
         },
-        { 
-          name: "否", 
+        {
+          name: "否",
           value: false,
-          description: "如：feat(auth): 添加用户登录功能"
+          description: "如：feat(auth): 添加用户登录功能",
         },
-        { 
-          name: "跟随全局设置", 
+        {
+          name: "跟随全局设置",
           value: undefined,
-          description: `当前全局设置：${useEmoji ? '启用' : '禁用'} emoji`
+          description: `当前全局设置：${useEmoji ? "启用" : "禁用"} emoji`,
         },
       ],
       theme,

package/src/config.ts

@@ -12,6 +12,10 @@ export interface GwConfig {
   hotfixPrefix: string;
   // 是否要求必填 ID，默认 false
   requireId: boolean;
+  // feature 分支是否要求必填描述，默认 false
+  featureRequireDescription?: boolean;
+  // hotfix 分支是否要求必填描述，默认 false
+  hotfixRequireDescription?: boolean;
   // ID 标签名称
   featureIdLabel: string;
   hotfixIdLabel: string;

package/src/update-notifier.ts

@@ -151,11 +151,10 @@ function showSimpleNotification(current: string, latest: string): void {
     "gw update"
   )} ${colors.dim("更新")}`;
 
-  console.log("");
   console.log(
     boxen(message, {
       padding: { top: 0, bottom: 0, left: 2, right: 2 },
-      margin: { top: 0, bottom: 1, left: 0, right: 0 },
+      margin: { top: 0, bottom: 0, left: 0, right: 0 },
       borderStyle: "round",
       borderColor: "yellow",
       align: "center",