@zjex/git-workflow 0.3.8 → 0.3.10

package/tests/branch.test.ts

@@ -253,3 +253,119 @@ describe("Branch 功能测试", () => {
     });
   });
 });
+
+describe("描述必填配置", () => {
+  it("featureRequireDescription 为 true 时描述不能为空", () => {
+    const featureRequireDescription = true;
+    const description = "";
+
+    if (featureRequireDescription && !description) {
+      expect(description).toBe("");
+    }
+  });
+
+  it("featureRequireDescription 为 false 时描述可以为空", () => {
+    const featureRequireDescription = false;
+    const description = "";
+
+    if (!featureRequireDescription) {
+      expect(description).toBe("");
+    }
+  });
+
+  it("hotfixRequireDescription 为 true 时描述不能为空", () => {
+    const hotfixRequireDescription = true;
+    const description = "";
+
+    if (hotfixRequireDescription && !description) {
+      expect(description).toBe("");
+    }
+  });
+
+  it("hotfixRequireDescription 为 false 时描述可以为空", () => {
+    const hotfixRequireDescription = false;
+    const description = "";
+
+    if (!hotfixRequireDescription) {
+      expect(description).toBe("");
+    }
+  });
+
+  it("应该生成只有 ID 的 feature 分支名（描述为空）", () => {
+    const prefix = "feature";
+    const id = "PROJ-123";
+    const description = "";
+    const branchName = id ? `${prefix}/${TODAY}-${id}` : `${prefix}/${TODAY}`;
+
+    expect(branchName).toMatch(/^feature\/\d{8}-PROJ-123$/);
+  });
+
+  it("应该生成只有描述的 feature 分支名（ID 为空）", () => {
+    const prefix = "feature";
+    const id = "";
+    const description = "add-login";
+    const branchName = description
+      ? `${prefix}/${TODAY}-${description}`
+      : `${prefix}/${TODAY}`;
+
+    expect(branchName).toMatch(/^feature\/\d{8}-add-login$/);
+  });
+
+  it("应该生成只有日期的 feature 分支名（ID 和描述都为空）", () => {
+    const prefix = "feature";
+    const id = "";
+    const description = "";
+    const branchName = `${prefix}/${TODAY}`;
+
+    expect(branchName).toMatch(/^feature\/\d{8}$/);
+  });
+
+  it("应该生成只有 ID 的 hotfix 分支名（描述为空）", () => {
+    const prefix = "hotfix";
+    const id = "BUG-456";
+    const description = "";
+    const branchName = id ? `${prefix}/${TODAY}-${id}` : `${prefix}/${TODAY}`;
+
+    expect(branchName).toMatch(/^hotfix\/\d{8}-BUG-456$/);
+  });
+
+  it("应该生成只有描述的 hotfix 分支名（ID 为空）", () => {
+    const prefix = "hotfix";
+    const id = "";
+    const description = "fix-crash";
+    const branchName = description
+      ? `${prefix}/${TODAY}-${description}`
+      : `${prefix}/${TODAY}`;
+
+    expect(branchName).toMatch(/^hotfix\/\d{8}-fix-crash$/);
+  });
+
+  it("应该生成只有日期的 hotfix 分支名（ID 和描述都为空）", () => {
+    const prefix = "hotfix";
+    const id = "";
+    const description = "";
+    const branchName = `${prefix}/${TODAY}`;
+
+    expect(branchName).toMatch(/^hotfix\/\d{8}$/);
+  });
+
+  it("feature 和 hotfix 可以有不同的描述必填配置", () => {
+    const featureRequireDescription = true;
+    const hotfixRequireDescription = false;
+
+    expect(featureRequireDescription).toBe(true);
+    expect(hotfixRequireDescription).toBe(false);
+    expect(featureRequireDescription).not.toBe(hotfixRequireDescription);
+  });
+
+  it("描述必填配置默认应该为 false", () => {
+    const featureRequireDescription = undefined;
+    const hotfixRequireDescription = undefined;
+
+    const featureRequired = featureRequireDescription ?? false;
+    const hotfixRequired = hotfixRequireDescription ?? false;
+
+    expect(featureRequired).toBe(false);
+    expect(hotfixRequired).toBe(false);
+  });
+});

package/tests/clean.test.ts

@@ -0,0 +1,293 @@
+import { describe, it, expect, vi, beforeEach, afterEach } from "vitest";
+import { existsSync, unlinkSync, readdirSync, writeFileSync } from "fs";
+import { homedir, tmpdir } from "os";
+import { join } from "path";
+
+// Mock 所有外部依赖
+vi.mock("fs", () => ({
+  existsSync: vi.fn(),
+  unlinkSync: vi.fn(),
+  readdirSync: vi.fn(),
+  writeFileSync: vi.fn(),
+  readFileSync: vi.fn(),
+}));
+
+vi.mock("os", () => ({
+  homedir: vi.fn(),
+  tmpdir: vi.fn(),
+}));
+
+vi.mock("path", () => ({
+  join: vi.fn((...args) => args.join("/")),
+}));
+
+vi.mock("@inquirer/prompts", () => ({
+  select: vi.fn(),
+}));
+
+vi.mock("../src/update-notifier.js", () => ({
+  clearUpdateCache: vi.fn(),
+}));
+
+describe("Clean 命令测试", () => {
+  const mockExistsSync = vi.mocked(existsSync);
+  const mockUnlinkSync = vi.mocked(unlinkSync);
+  const mockReaddirSync = vi.mocked(readdirSync);
+  const mockHomedir = vi.mocked(homedir);
+  const mockTmpdir = vi.mocked(tmpdir);
+
+  beforeEach(() => {
+    vi.clearAllMocks();
+    mockHomedir.mockReturnValue("/home/user");
+    mockTmpdir.mockReturnValue("/tmp");
+  });
+
+  afterEach(() => {
+    vi.restoreAllMocks();
+  });
+
+  describe("清理更新缓存", () => {
+    it("应该清理更新缓存文件", async () => {
+      const { clearUpdateCache } = await import("../src/update-notifier.js");
+
+      clearUpdateCache();
+
+      expect(clearUpdateCache).toHaveBeenCalled();
+    });
+  });
+
+  describe("清理全局配置文件", () => {
+    it("没有全局配置文件时不应该询问", async () => {
+      mockExistsSync.mockReturnValue(false);
+      mockReaddirSync.mockReturnValue([]);
+
+      const { select } = await import("@inquirer/prompts");
+
+      expect(mockExistsSync).not.toHaveBeenCalledWith("/home/user/.gwrc.json");
+    });
+
+    it("有全局配置文件时应该询问是否删除", async () => {
+      const globalConfig = "/home/user/.gwrc.json";
+      mockExistsSync.mockReturnValue(true);
+      mockReaddirSync.mockReturnValue([]);
+
+      const { select } = await import("@inquirer/prompts");
+      vi.mocked(select).mockResolvedValue(false);
+
+      // 模拟检查全局配置文件
+      const hasGlobalConfig = mockExistsSync(globalConfig);
+
+      expect(hasGlobalConfig).toBe(true);
+    });
+
+    it("选择删除时应该删除全局配置文件", async () => {
+      const globalConfig = "/home/user/.gwrc.json";
+      mockExistsSync.mockReturnValue(true);
+      mockReaddirSync.mockReturnValue([]);
+
+      const { select } = await import("@inquirer/prompts");
+      vi.mocked(select).mockResolvedValue(true);
+
+      // 模拟删除操作
+      if (mockExistsSync(globalConfig)) {
+        mockUnlinkSync(globalConfig);
+      }
+
+      expect(mockUnlinkSync).toHaveBeenCalledWith(globalConfig);
+    });
+
+    it("选择不删除时应该保留全局配置文件", async () => {
+      const globalConfig = "/home/user/.gwrc.json";
+      mockExistsSync.mockReturnValue(true);
+      mockReaddirSync.mockReturnValue([]);
+
+      const { select } = await import("@inquirer/prompts");
+      vi.mocked(select).mockResolvedValue(false);
+
+      // 模拟不删除的情况
+      const shouldDelete = await vi.mocked(select)();
+
+      if (!shouldDelete) {
+        expect(mockUnlinkSync).not.toHaveBeenCalledWith(globalConfig);
+      }
+    });
+  });
+
+  describe("清理临时 commit 文件", () => {
+    it("应该清理所有临时 commit 文件", () => {
+      mockReaddirSync.mockReturnValue([
+        ".gw-commit-msg-123456",
+        ".gw-commit-msg-789012",
+        "other-file.txt",
+      ] as any);
+
+      const tmpDir = mockTmpdir();
+      const files = mockReaddirSync(tmpDir);
+      const gwTmpFiles = files.filter((f: string) =>
+        f.startsWith(".gw-commit-msg-")
+      );
+
+      expect(gwTmpFiles).toHaveLength(2);
+      expect(gwTmpFiles).toContain(".gw-commit-msg-123456");
+      expect(gwTmpFiles).toContain(".gw-commit-msg-789012");
+    });
+
+    it("应该忽略非 gw 临时文件", () => {
+      mockReaddirSync.mockReturnValue([
+        ".gw-commit-msg-123456",
+        "other-temp-file",
+        ".other-file",
+      ] as any);
+
+      const tmpDir = mockTmpdir();
+      const files = mockReaddirSync(tmpDir);
+      const gwTmpFiles = files.filter((f: string) =>
+        f.startsWith(".gw-commit-msg-")
+      );
+
+      expect(gwTmpFiles).toHaveLength(1);
+      expect(gwTmpFiles).toContain(".gw-commit-msg-123456");
+    });
+
+    it("没有临时文件时不应该报错", () => {
+      mockReaddirSync.mockReturnValue([]);
+
+      const tmpDir = mockTmpdir();
+      const files = mockReaddirSync(tmpDir);
+      const gwTmpFiles = files.filter((f: string) =>
+        f.startsWith(".gw-commit-msg-")
+      );
+
+      expect(gwTmpFiles).toHaveLength(0);
+    });
+
+    it("应该删除找到的临时文件", () => {
+      mockReaddirSync.mockReturnValue([
+        ".gw-commit-msg-123456",
+        ".gw-commit-msg-789012",
+      ] as any);
+
+      const tmpDir = mockTmpdir();
+      const files = mockReaddirSync(tmpDir);
+      const gwTmpFiles = files.filter((f: string) =>
+        f.startsWith(".gw-commit-msg-")
+      );
+
+      gwTmpFiles.forEach((file: string) => {
+        mockUnlinkSync(join(tmpDir, file));
+      });
+
+      expect(mockUnlinkSync).toHaveBeenCalledTimes(2);
+      expect(mockUnlinkSync).toHaveBeenCalledWith("/tmp/.gw-commit-msg-123456");
+      expect(mockUnlinkSync).toHaveBeenCalledWith("/tmp/.gw-commit-msg-789012");
+    });
+  });
+
+  describe("清理统计", () => {
+    it("应该正确统计清理的文件数量", () => {
+      let cleanedCount = 0;
+
+      // 清理更新缓存
+      cleanedCount++;
+
+      // 清理全局配置
+      mockExistsSync.mockReturnValue(true);
+      if (mockExistsSync("/home/user/.gwrc.json")) {
+        cleanedCount++;
+      }
+
+      // 清理临时文件
+      mockReaddirSync.mockReturnValue([
+        ".gw-commit-msg-123456",
+        ".gw-commit-msg-789012",
+      ] as any);
+      const gwTmpFiles = mockReaddirSync("/tmp").filter((f: string) =>
+        f.startsWith(".gw-commit-msg-")
+      );
+      cleanedCount += gwTmpFiles.length;
+
+      expect(cleanedCount).toBe(4); // 1 缓存 + 1 配置 + 2 临时文件
+    });
+
+    it("没有全局配置时应该统计正确", () => {
+      let cleanedCount = 0;
+
+      // 清理更新缓存
+      cleanedCount++;
+
+      // 没有全局配置
+      mockExistsSync.mockReturnValue(false);
+
+      // 清理临时文件
+      mockReaddirSync.mockReturnValue([".gw-commit-msg-123456"] as any);
+      const gwTmpFiles = mockReaddirSync("/tmp").filter((f: string) =>
+        f.startsWith(".gw-commit-msg-")
+      );
+      cleanedCount += gwTmpFiles.length;
+
+      expect(cleanedCount).toBe(2); // 1 缓存 + 1 临时文件
+    });
+
+    it("没有任何文件时应该只清理缓存", () => {
+      let cleanedCount = 0;
+
+      // 清理更新缓存
+      cleanedCount++;
+
+      // 没有全局配置
+      mockExistsSync.mockReturnValue(false);
+
+      // 没有临时文件
+      mockReaddirSync.mockReturnValue([]);
+
+      expect(cleanedCount).toBe(1); // 只有缓存
+    });
+  });
+
+  describe("错误处理", () => {
+    it("删除文件失败时应该静默处理", () => {
+      mockUnlinkSync.mockImplementation(() => {
+        throw new Error("Permission denied");
+      });
+
+      expect(() => {
+        try {
+          mockUnlinkSync("/home/user/.gwrc.json");
+        } catch {
+          // 静默失败
+        }
+      }).not.toThrow();
+    });
+
+    it("读取目录失败时应该静默处理", () => {
+      mockReaddirSync.mockImplementation(() => {
+        throw new Error("Directory not found");
+      });
+
+      expect(() => {
+        try {
+          mockReaddirSync("/tmp");
+        } catch {
+          // 静默失败
+        }
+      }).not.toThrow();
+    });
+  });
+
+  describe("文件路径", () => {
+    it("应该使用正确的全局配置路径", () => {
+      const globalConfig = join(mockHomedir(), ".gwrc.json");
+      expect(globalConfig).toBe("/home/user/.gwrc.json");
+    });
+
+    it("应该使用正确的临时目录路径", () => {
+      const tmpDir = mockTmpdir();
+      expect(tmpDir).toBe("/tmp");
+    });
+
+    it("应该正确拼接临时文件路径", () => {
+      const tmpFile = join(mockTmpdir(), ".gw-commit-msg-123456");
+      expect(tmpFile).toBe("/tmp/.gw-commit-msg-123456");
+    });
+  });
+});

package/tests/commit.test.ts

@@ -1,4 +1,10 @@
-import { describe, it, expect } from "vitest";
+import { describe, it, expect, vi, beforeEach, afterEach } from "vitest";
+import { execSync } from "child_process";
+
+// Mock child_process
+vi.mock("child_process", () => ({
+  execSync: vi.fn(),
+}));
 
 describe("Commit 功能测试", () => {
   describe("提交类型", () => {
@@ -82,4 +88,183 @@ describe("Commit 功能测试", () => {
       expect(extraSpace).toBe("");
     });
   });
+
+  describe("自动暂存功能", () => {
+    beforeEach(() => {
+      vi.clearAllMocks();
+    });
+
+    afterEach(() => {
+      vi.restoreAllMocks();
+    });
+
+    it("autoStage 为 true 时应该执行 git add -A", () => {
+      const autoStage = true;
+
+      if (autoStage) {
+        execSync("git add -A", { stdio: "pipe" });
+      }
+
+      expect(execSync).toHaveBeenCalledWith("git add -A", { stdio: "pipe" });
+    });
+
+    it("autoStage 为 false 时不应该自动执行 git add -A", () => {
+      const autoStage = false;
+
+      if (autoStage) {
+        execSync("git add -A", { stdio: "pipe" });
+      }
+
+      expect(execSync).not.toHaveBeenCalled();
+    });
+
+    it("提交前应该再次执行 git add -A 确保文件被暂存", () => {
+      const autoStage = true;
+
+      // 模拟提交前的暂存操作
+      if (autoStage) {
+        execSync("git add -A", { stdio: "pipe" });
+      }
+
+      // 模拟提交前再次暂存
+      if (autoStage) {
+        execSync("git add -A", { stdio: "pipe" });
+      }
+
+      // 应该被调用两次
+      expect(execSync).toHaveBeenCalledTimes(2);
+      expect(execSync).toHaveBeenCalledWith("git add -A", { stdio: "pipe" });
+    });
+
+    it("默认 autoStage 应该为 true", () => {
+      const config = {};
+      const autoStage = (config as any).autoStage ?? true;
+
+      expect(autoStage).toBe(true);
+    });
+
+    it("配置 autoStage 为 false 时应该覆盖默认值", () => {
+      const config = { autoStage: false };
+      const autoStage = config.autoStage ?? true;
+
+      expect(autoStage).toBe(false);
+    });
+  });
+
+  describe("Git 状态解析", () => {
+    it("应该正确解析已暂存的文件", () => {
+      // 模拟 git status --porcelain 输出
+      // M  = 已暂存的修改
+      // A  = 已暂存的新文件
+      const output = "M  src/index.ts\nA  src/new.ts";
+      const lines = output.split("\n");
+
+      const staged: { status: string; file: string }[] = [];
+
+      for (const line of lines) {
+        if (!line) continue;
+        const indexStatus = line[0];
+        const file = line.slice(3);
+
+        if (indexStatus !== " " && indexStatus !== "?") {
+          staged.push({ status: indexStatus, file });
+        }
+      }
+
+      expect(staged).toHaveLength(2);
+      expect(staged[0]).toEqual({ status: "M", file: "src/index.ts" });
+      expect(staged[1]).toEqual({ status: "A", file: "src/new.ts" });
+    });
+
+    it("应该正确解析未暂存的文件", () => {
+      // 模拟 git status --porcelain 输出
+      // " M" = 未暂存的修改
+      // "??" = 未跟踪的文件
+      const output = " M src/modified.ts\n?? src/untracked.ts";
+      const lines = output.split("\n");
+
+      const unstaged: { status: string; file: string }[] = [];
+
+      for (const line of lines) {
+        if (!line) continue;
+        const indexStatus = line[0];
+        const workTreeStatus = line[1];
+        const file = line.slice(3);
+
+        if (workTreeStatus !== " " || indexStatus === "?") {
+          const status = indexStatus === "?" ? "?" : workTreeStatus;
+          unstaged.push({ status, file });
+        }
+      }
+
+      expect(unstaged).toHaveLength(2);
+      expect(unstaged[0]).toEqual({ status: "M", file: "src/modified.ts" });
+      expect(unstaged[1]).toEqual({ status: "?", file: "src/untracked.ts" });
+    });
+
+    it("空输出应该返回空数组", () => {
+      const output = "";
+      const staged: any[] = [];
+      const unstaged: any[] = [];
+
+      if (!output) {
+        expect(staged).toHaveLength(0);
+        expect(unstaged).toHaveLength(0);
+      }
+    });
+
+    it("应该正确处理同时有暂存和未暂存状态的文件", () => {
+      // "MM" = 已暂存且有新的未暂存修改
+      const output = "MM src/both.ts";
+      const lines = output.split("\n");
+
+      const staged: { status: string; file: string }[] = [];
+      const unstaged: { status: string; file: string }[] = [];
+
+      for (const line of lines) {
+        if (!line) continue;
+        const indexStatus = line[0];
+        const workTreeStatus = line[1];
+        const file = line.slice(3);
+
+        if (indexStatus !== " " && indexStatus !== "?") {
+          staged.push({ status: indexStatus, file });
+        }
+
+        if (workTreeStatus !== " " || indexStatus === "?") {
+          const status = indexStatus === "?" ? "?" : workTreeStatus;
+          unstaged.push({ status, file });
+        }
+      }
+
+      expect(staged).toHaveLength(1);
+      expect(unstaged).toHaveLength(1);
+      expect(staged[0]).toEqual({ status: "M", file: "src/both.ts" });
+      expect(unstaged[0]).toEqual({ status: "M", file: "src/both.ts" });
+    });
+  });
+
+  describe("临时文件提交", () => {
+    it("应该使用临时文件传递多行 commit message", () => {
+      const message = "feat: 新功能\n\n- 详细描述1\n- 详细描述2";
+      const lines = message.split("\n");
+
+      expect(lines).toHaveLength(4);
+      expect(lines[0]).toBe("feat: 新功能");
+      expect(lines[1]).toBe("");
+      expect(lines[2]).toBe("- 详细描述1");
+      expect(lines[3]).toBe("- 详细描述2");
+    });
+
+    it("临时文件名应该包含时间戳避免冲突", () => {
+      const timestamp1 = Date.now();
+      const tmpFile1 = `.gw-commit-msg-${timestamp1}`;
+
+      // 模拟短暂延迟
+      const timestamp2 = timestamp1 + 1;
+      const tmpFile2 = `.gw-commit-msg-${timestamp2}`;
+
+      expect(tmpFile1).not.toBe(tmpFile2);
+    });
+  });
 });