@zjex/git-workflow 0.2.23 → 0.2.24

package/tests/branch.test.ts

@@ -0,0 +1,255 @@
+import { describe, it, expect, vi } from "vitest";
+import { TODAY } from "../src/utils";
+
+describe("Branch 功能测试", () => {
+  describe("分支命名规范", () => {
+    it("应该生成带 ID 的 feature 分支名", () => {
+      const prefix = "feature";
+      const id = "PROJ-123";
+      const description = "add-login";
+      const branchName = `${prefix}/${TODAY}-${id}-${description}`;
+
+      expect(branchName).toMatch(/^feature\/\d{8}-PROJ-123-add-login$/);
+    });
+
+    it("应该生成不带 ID 的 feature 分支名", () => {
+      const prefix = "feature";
+      const description = "add-login";
+      const branchName = `${prefix}/${TODAY}-${description}`;
+
+      expect(branchName).toMatch(/^feature\/\d{8}-add-login$/);
+    });
+
+    it("应该生成带 ID 的 hotfix 分支名", () => {
+      const prefix = "hotfix";
+      const id = "BUG-456";
+      const description = "fix-crash";
+      const branchName = `${prefix}/${TODAY}-${id}-${description}`;
+
+      expect(branchName).toMatch(/^hotfix\/\d{8}-BUG-456-fix-crash$/);
+    });
+
+    it("应该生成不带 ID 的 hotfix 分支名", () => {
+      const prefix = "hotfix";
+      const description = "fix-crash";
+      const branchName = `${prefix}/${TODAY}-${description}`;
+
+      expect(branchName).toMatch(/^hotfix\/\d{8}-fix-crash$/);
+    });
+
+    it("应该使用当前日期", () => {
+      const today = new Date().toISOString().slice(0, 10).replace(/-/g, "");
+      expect(TODAY).toBe(today);
+    });
+  });
+
+  describe("分支前缀配置", () => {
+    it("应该支持自定义 feature 前缀", () => {
+      const customPrefix = "feat";
+      const description = "new-feature";
+      const branchName = `${customPrefix}/${TODAY}-${description}`;
+
+      expect(branchName).toMatch(/^feat\/\d{8}-new-feature$/);
+    });
+
+    it("应该支持自定义 hotfix 前缀", () => {
+      const customPrefix = "fix";
+      const description = "bug-fix";
+      const branchName = `${customPrefix}/${TODAY}-${description}`;
+
+      expect(branchName).toMatch(/^fix\/\d{8}-bug-fix$/);
+    });
+  });
+
+  describe("ID 验证", () => {
+    it("requireId 为 true 时 ID 不能为空", () => {
+      const requireId = true;
+      const id = "";
+
+      if (requireId && !id) {
+        expect(id).toBe("");
+      }
+    });
+
+    it("requireId 为 false 时 ID 可以为空", () => {
+      const requireId = false;
+      const id = "";
+
+      if (!requireId) {
+        expect(id).toBe("");
+      }
+    });
+
+    it("应该接受有效的 ID", () => {
+      const validIds = ["PROJ-123", "BUG-456", "TASK-789", "123", "ABC"];
+
+      validIds.forEach((id) => {
+        expect(id).toBeTruthy();
+        expect(id.length).toBeGreaterThan(0);
+      });
+    });
+  });
+
+  describe("描述验证", () => {
+    it("描述不能为空", () => {
+      const description = "";
+      expect(description).toBe("");
+    });
+
+    it("应该接受有效的描述", () => {
+      const validDescriptions = [
+        "add-login",
+        "fix-crash",
+        "update-readme",
+        "refactor-code",
+      ];
+
+      validDescriptions.forEach((desc) => {
+        expect(desc).toBeTruthy();
+        expect(desc.length).toBeGreaterThan(0);
+      });
+    });
+
+    it("描述应该使用连字符分隔", () => {
+      const description = "add-user-login";
+      expect(description).toContain("-");
+      expect(description.split("-").length).toBeGreaterThan(1);
+    });
+  });
+
+  describe("基础分支选择", () => {
+    it("应该支持指定基础分支", () => {
+      const baseBranch = "develop";
+      const fullBranch = `origin/${baseBranch}`;
+
+      expect(fullBranch).toBe("origin/develop");
+    });
+
+    it("应该支持 main 作为基础分支", () => {
+      const baseBranch = "main";
+      const fullBranch = `origin/${baseBranch}`;
+
+      expect(fullBranch).toBe("origin/main");
+    });
+
+    it("应该支持 master 作为基础分支", () => {
+      const baseBranch = "master";
+      const fullBranch = `origin/${baseBranch}`;
+
+      expect(fullBranch).toBe("origin/master");
+    });
+
+    it("应该支持自定义基础分支", () => {
+      const baseBranch = "release/1.0";
+      const fullBranch = `origin/${baseBranch}`;
+
+      expect(fullBranch).toBe("origin/release/1.0");
+    });
+  });
+
+  describe("分支名称格式", () => {
+    it("应该包含日期", () => {
+      const branchName = `feature/${TODAY}-add-feature`;
+      expect(branchName).toContain(TODAY);
+    });
+
+    it("应该包含前缀", () => {
+      const branchName = `feature/${TODAY}-add-feature`;
+      expect(branchName).toMatch(/^feature\//);
+    });
+
+    it("应该包含描述", () => {
+      const description = "add-feature";
+      const branchName = `feature/${TODAY}-${description}`;
+      expect(branchName).toContain(description);
+    });
+
+    it("带 ID 时应该包含 ID", () => {
+      const id = "PROJ-123";
+      const branchName = `feature/${TODAY}-${id}-add-feature`;
+      expect(branchName).toContain(id);
+    });
+
+    it("应该使用斜杠分隔前缀和名称", () => {
+      const branchName = `feature/${TODAY}-add-feature`;
+      expect(branchName).toContain("/");
+      const parts = branchName.split("/");
+      expect(parts.length).toBe(2);
+      expect(parts[0]).toBe("feature");
+    });
+  });
+
+  describe("分支类型", () => {
+    it("应该支持 feature 类型", () => {
+      const type: "feature" | "hotfix" = "feature";
+      expect(type).toBe("feature");
+    });
+
+    it("应该支持 hotfix 类型", () => {
+      const type: "feature" | "hotfix" = "hotfix";
+      expect(type).toBe("hotfix");
+    });
+  });
+
+  describe("autoPush 配置", () => {
+    it("autoPush 为 true 时应该自动推送", () => {
+      const autoPush = true;
+      expect(autoPush).toBe(true);
+    });
+
+    it("autoPush 为 false 时不应该推送", () => {
+      const autoPush = false;
+      expect(autoPush).toBe(false);
+    });
+
+    it("autoPush 未设置时应该询问", () => {
+      const autoPush = undefined;
+      expect(autoPush).toBeUndefined();
+    });
+  });
+
+  describe("分支名称边界情况", () => {
+    it("应该处理包含数字的描述", () => {
+      const description = "add-feature-v2";
+      const branchName = `feature/${TODAY}-${description}`;
+      expect(branchName).toContain("v2");
+    });
+
+    it("应该处理包含多个连字符的描述", () => {
+      const description = "add-user-login-feature";
+      const branchName = `feature/${TODAY}-${description}`;
+      expect(branchName.split("-").length).toBeGreaterThan(3);
+    });
+
+    it("应该处理长描述", () => {
+      const description = "add-very-long-feature-description-with-many-words";
+      const branchName = `feature/${TODAY}-${description}`;
+      expect(branchName.length).toBeGreaterThan(50);
+    });
+
+    it("应该处理包含下划线的 ID", () => {
+      const id = "PROJ_123";
+      const branchName = `feature/${TODAY}-${id}-add-feature`;
+      expect(branchName).toContain("PROJ_123");
+    });
+  });
+
+  describe("日期格式", () => {
+    it("TODAY 应该是 8 位数字", () => {
+      expect(TODAY).toMatch(/^\d{8}$/);
+    });
+
+    it("TODAY 应该是有效的日期格式", () => {
+      const year = parseInt(TODAY.slice(0, 4));
+      const month = parseInt(TODAY.slice(4, 6));
+      const day = parseInt(TODAY.slice(6, 8));
+
+      expect(year).toBeGreaterThan(2020);
+      expect(year).toBeLessThan(2100);
+      expect(month).toBeGreaterThanOrEqual(1);
+      expect(month).toBeLessThanOrEqual(12);
+      expect(day).toBeGreaterThanOrEqual(1);
+      expect(day).toBeLessThanOrEqual(31);
+    });
+  });
+});

package/tests/commit.test.ts

@@ -0,0 +1,85 @@
+import { describe, it, expect } from "vitest";
+
+describe("Commit 功能测试", () => {
+  describe("提交类型", () => {
+    const commitTypes = [
+      { 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 配置" },
+      { type: "chore", emoji: "🔧", description: "其他修改" },
+    ];
+
+    it("应该有 10 种提交类型", () => {
+      expect(commitTypes).toHaveLength(10);
+    });
+
+    it("每种类型都应该有必需的字段", () => {
+      commitTypes.forEach((type) => {
+        expect(type).toHaveProperty("type");
+        expect(type).toHaveProperty("emoji");
+        expect(type).toHaveProperty("description");
+        expect(type.type).toBeTruthy();
+        expect(type.emoji).toBeTruthy();
+        expect(type.description).toBeTruthy();
+      });
+    });
+
+    it("类型名称应该是小写", () => {
+      commitTypes.forEach((type) => {
+        expect(type.type).toBe(type.type.toLowerCase());
+      });
+    });
+  });
+
+  describe("提交消息格式", () => {
+    it("应该生成正确的提交消息格式", () => {
+      const type = "feat";
+      const emoji = "✨";
+      const scope = "tag";
+      const message = "支持多列显示";
+
+      const commitMessage = `${type}(${scope}): ${emoji} ${message}`;
+      expect(commitMessage).toBe("feat(tag): ✨ 支持多列显示");
+    });
+
+    it("无 scope 时应该省略括号", () => {
+      const type = "fix";
+      const emoji = "🐛";
+      const message = "修复对齐问题";
+
+      const commitMessage = `${type}: ${emoji} ${message}`;
+      expect(commitMessage).toBe("fix: 🐛 修复对齐问题");
+    });
+  });
+
+  describe("Refactor 对齐处理", () => {
+    it("refactor 类型应该添加额外空格", () => {
+      const type = "refactor";
+      const emoji = "♻️";
+      const extraSpace = type === "refactor" ? " " : "";
+      const display = `${emoji}${extraSpace} ${type}`;
+
+      // refactor 的 emoji 宽度不一致，需要额外空格
+      expect(display).toContain(" ");
+    });
+
+    it("其他类型不应该添加额外空格", () => {
+      const type = "feat";
+      const emoji = "✨";
+      const extraSpace = type === "refactor" ? " " : "";
+      const display = `${emoji}${extraSpace} ${type}`;
+
+      expect(extraSpace).toBe("");
+    });
+  });
+});

package/tests/config.test.ts

@@ -0,0 +1,311 @@
+import { describe, it, expect, vi, beforeEach, afterEach } from "vitest";
+import { existsSync, readFileSync } from "fs";
+import { homedir } from "os";
+import { loadConfig, getConfig } from "../src/config";
+import { execOutput } from "../src/utils";
+
+// Mock dependencies
+vi.mock("fs");
+vi.mock("os");
+vi.mock("../src/utils");
+
+describe("Config 模块测试", () => {
+  beforeEach(() => {
+    vi.clearAllMocks();
+    // Mock homedir to return a valid path
+    vi.mocked(homedir).mockReturnValue("/home/user");
+  });
+
+  afterEach(() => {
+    vi.restoreAllMocks();
+  });
+
+  describe("默认配置", () => {
+    it("应该返回默认配置", () => {
+      vi.mocked(existsSync).mockReturnValue(false);
+      vi.mocked(execOutput).mockReturnValue("");
+
+      const config = loadConfig();
+
+      expect(config).toMatchObject({
+        featurePrefix: "feature",
+        hotfixPrefix: "hotfix",
+        requireId: false,
+        featureIdLabel: "Story ID",
+        hotfixIdLabel: "Issue ID",
+        autoStage: true,
+        useEmoji: true,
+      });
+    });
+  });
+
+  describe("项目配置", () => {
+    it("应该加载 .gwrc.json 配置", () => {
+      const mockConfig = {
+        featurePrefix: "feat",
+        requireId: true,
+      };
+
+      vi.mocked(existsSync).mockImplementation((path) => {
+        return path === ".gwrc.json";
+      });
+
+      vi.mocked(readFileSync).mockReturnValue(JSON.stringify(mockConfig));
+      vi.mocked(execOutput).mockReturnValue("");
+
+      const config = loadConfig();
+
+      expect(config.featurePrefix).toBe("feat");
+      expect(config.requireId).toBe(true);
+    });
+
+    it("应该加载 .gwrc 配置", () => {
+      const mockConfig = {
+        hotfixPrefix: "fix",
+      };
+
+      vi.mocked(existsSync).mockImplementation((path) => {
+        return path === ".gwrc";
+      });
+
+      vi.mocked(readFileSync).mockReturnValue(JSON.stringify(mockConfig));
+      vi.mocked(execOutput).mockReturnValue("");
+
+      const config = loadConfig();
+
+      expect(config.hotfixPrefix).toBe("fix");
+    });
+
+    it("应该加载 gw.config.json 配置", () => {
+      const mockConfig = {
+        autoPush: true,
+      };
+
+      vi.mocked(existsSync).mockImplementation((path) => {
+        return path === "gw.config.json";
+      });
+
+      vi.mocked(readFileSync).mockReturnValue(JSON.stringify(mockConfig));
+      vi.mocked(execOutput).mockReturnValue("");
+
+      const config = loadConfig();
+
+      expect(config.autoPush).toBe(true);
+    });
+  });
+
+  describe("全局配置", () => {
+    it("应该加载全局配置", () => {
+      const mockGlobalConfig = {
+        aiCommit: {
+          enabled: true,
+          provider: "github" as const,
+          apiKey: "test-key",
+        },
+      };
+
+      vi.mocked(homedir).mockReturnValue("/home/user");
+      vi.mocked(existsSync).mockImplementation((path) => {
+        return path === "/home/user/.gwrc.json";
+      });
+
+      vi.mocked(readFileSync).mockReturnValue(JSON.stringify(mockGlobalConfig));
+      vi.mocked(execOutput).mockReturnValue("");
+
+      const config = loadConfig();
+
+      expect(config.aiCommit?.enabled).toBe(true);
+      expect(config.aiCommit?.provider).toBe("github");
+      expect(config.aiCommit?.apiKey).toBe("test-key");
+    });
+  });
+
+  describe("配置合并", () => {
+    it("项目配置应该覆盖全局配置", () => {
+      const mockGlobalConfig = {
+        featurePrefix: "global-feature",
+        requireId: false,
+      };
+
+      const mockProjectConfig = {
+        featurePrefix: "project-feature",
+      };
+
+      vi.mocked(homedir).mockReturnValue("/home/user");
+      vi.mocked(existsSync).mockImplementation((path) => {
+        if (path === "/home/user/.gwrc.json") return true;
+        if (path === ".gwrc.json") return true;
+        return false;
+      });
+
+      vi.mocked(readFileSync).mockImplementation((path) => {
+        if (path === "/home/user/.gwrc.json") {
+          return JSON.stringify(mockGlobalConfig);
+        }
+        if (path === ".gwrc.json") {
+          return JSON.stringify(mockProjectConfig);
+        }
+        return "{}";
+      });
+
+      vi.mocked(execOutput).mockReturnValue("");
+
+      const config = loadConfig();
+
+      expect(config.featurePrefix).toBe("project-feature");
+      expect(config.requireId).toBe(false);
+    });
+
+    it("应该深度合并 aiCommit 配置", () => {
+      const mockGlobalConfig = {
+        aiCommit: {
+          enabled: true,
+          provider: "github" as const,
+          apiKey: "global-key",
+          language: "zh-CN" as const,
+        },
+      };
+
+      const mockProjectConfig = {
+        aiCommit: {
+          provider: "openai" as const,
+          model: "gpt-4",
+        },
+      };
+
+      vi.mocked(homedir).mockReturnValue("/home/user");
+      vi.mocked(existsSync).mockImplementation((path) => {
+        if (path === "/home/user/.gwrc.json") return true;
+        if (path === ".gwrc.json") return true;
+        return false;
+      });
+
+      vi.mocked(readFileSync).mockImplementation((path) => {
+        if (path === "/home/user/.gwrc.json") {
+          return JSON.stringify(mockGlobalConfig);
+        }
+        if (path === ".gwrc.json") {
+          return JSON.stringify(mockProjectConfig);
+        }
+        return "{}";
+      });
+
+      vi.mocked(execOutput).mockReturnValue("");
+
+      const config = loadConfig();
+
+      expect(config.aiCommit?.enabled).toBe(true);
+      expect(config.aiCommit?.provider).toBe("openai");
+      expect(config.aiCommit?.apiKey).toBe("global-key");
+      expect(config.aiCommit?.language).toBe("zh-CN");
+      expect(config.aiCommit?.model).toBe("gpt-4");
+    });
+  });
+
+  describe("配置文件解析错误", () => {
+    it("全局配置解析失败时应该使用默认配置", () => {
+      vi.mocked(homedir).mockReturnValue("/home/user");
+      vi.mocked(existsSync).mockImplementation((path) => {
+        return path === "/home/user/.gwrc.json";
+      });
+
+      vi.mocked(readFileSync).mockReturnValue("invalid json");
+      vi.mocked(execOutput).mockReturnValue("");
+
+      const consoleWarnSpy = vi
+        .spyOn(console, "warn")
+        .mockImplementation(() => {});
+
+      const config = loadConfig();
+
+      expect(config.featurePrefix).toBe("feature");
+      expect(consoleWarnSpy).toHaveBeenCalled();
+
+      consoleWarnSpy.mockRestore();
+    });
+
+    it("项目配置解析失败时应该使用默认配置", () => {
+      vi.mocked(existsSync).mockImplementation((path) => {
+        return path === ".gwrc.json";
+      });
+
+      vi.mocked(readFileSync).mockReturnValue("invalid json");
+      vi.mocked(execOutput).mockReturnValue("");
+
+      const consoleWarnSpy = vi
+        .spyOn(console, "warn")
+        .mockImplementation(() => {});
+
+      const config = loadConfig();
+
+      expect(config.featurePrefix).toBe("feature");
+      expect(consoleWarnSpy).toHaveBeenCalled();
+
+      consoleWarnSpy.mockRestore();
+    });
+  });
+
+  describe("getConfig 函数", () => {
+    it("应该缓存配置", () => {
+      vi.mocked(existsSync).mockReturnValue(false);
+      vi.mocked(execOutput).mockReturnValue("");
+
+      const config1 = getConfig();
+      const config2 = getConfig();
+
+      expect(config1).toBe(config2);
+    });
+  });
+
+  describe("Git 根目录查找", () => {
+    it("应该在 git 根目录查找配置", () => {
+      vi.mocked(execOutput).mockReturnValue("/path/to/repo");
+      vi.mocked(existsSync).mockImplementation((path) => {
+        return path === "/path/to/repo/.gwrc.json";
+      });
+
+      vi.mocked(readFileSync).mockReturnValue(
+        JSON.stringify({ featurePrefix: "git-root-feature" })
+      );
+
+      const config = loadConfig();
+
+      expect(config.featurePrefix).toBe("git-root-feature");
+    });
+  });
+
+  describe("配置优先级", () => {
+    it("当前目录 > git 根目录 > 全局配置", () => {
+      const mockGlobalConfig = { featurePrefix: "global" };
+      const mockGitRootConfig = { featurePrefix: "git-root" };
+      const mockCurrentConfig = { featurePrefix: "current" };
+
+      vi.mocked(homedir).mockReturnValue("/home/user");
+      vi.mocked(execOutput).mockReturnValue("/path/to/repo");
+
+      vi.mocked(existsSync).mockImplementation((path) => {
+        if (path === "/home/user/.gwrc.json") return true;
+        if (path === "/path/to/repo/.gwrc.json") return true;
+        if (path === ".gwrc.json") return true;
+        return false;
+      });
+
+      vi.mocked(readFileSync).mockImplementation((path) => {
+        if (path === "/home/user/.gwrc.json") {
+          return JSON.stringify(mockGlobalConfig);
+        }
+        if (path === "/path/to/repo/.gwrc.json") {
+          return JSON.stringify(mockGitRootConfig);
+        }
+        if (path === ".gwrc.json") {
+          return JSON.stringify(mockCurrentConfig);
+        }
+        return "{}";
+      });
+
+      const config = loadConfig();
+
+      expect(config.featurePrefix).toBe("current");
+    });
+  });
+});