@zjex/git-workflow 0.2.24 → 0.3.0

package/docs/index.md

@@ -0,0 +1,205 @@
+---
+layout: home
+
+hero:
+  name: "Git Workflow"
+  text: "极简的 Git 工作流 CLI 工具"
+  tagline: "让分支管理和版本发布变得轻松愉快"
+  image:
+    src: /hero-logo.svg
+    alt: Git Workflow Logo
+  actions:
+    - theme: brand
+      text: 快速开始
+      link: /guide/getting-started
+    - theme: alt
+      text: 查看 GitHub
+      link: https://github.com/iamzjt-front-end/git-workflow
+
+features:
+  - icon: 🤖
+    title: AI 智能提交
+    details: 使用 AI 自动分析代码变更生成 commit message，支持 GitHub Models、OpenAI 等多种提供商
+  - icon: 🎯
+    title: 规范命名
+    details: 自动生成带日期的规范分支名，如 feature/20260109-PROJ-123-add-login
+  - icon: 🏷️
+    title: 智能版本
+    details: 自动识别当前版本，交互式选择下一版本，支持 semver + 预发布版本
+  - icon: 📝
+    title: 规范提交
+    details: 遵循 Conventional Commits + Gitmoji，提交信息更清晰规范
+  - icon: 🗑️
+    title: 批量清理
+    details: 一键删除本地+远程分支，按最近使用排序，智能检测远程分支状态
+  - icon: 💾
+    title: Stash 管理
+    details: 可视化管理 stash，支持预览、应用、创建分支等操作
+  - icon: ⚙️
+    title: 灵活配置
+    details: 支持项目级和全局配置，不同项目可使用不同规范
+  - icon: 🔔
+    title: 版本提醒
+    details: 自动检测新版本，一键更新，保持工具始终最新
+---
+
+## 🎯 为什么选择 Git Workflow？
+
+在日常开发中，你是否经常遇到这些问题：
+
+- 🤔 每次创建分支都要手动输入一长串命名规范？
+- 😫 发布版本时总是忘记当前版本号是多少？
+- 📝 提交信息格式不统一，难以生成 CHANGELOG？
+- 🔄 删除分支时需要分别处理本地和远程？
+- 📋 团队成员的分支命名风格五花八门？
+- 💬 写 commit message 总是词穷，不知道怎么描述？
+
+**Git Workflow** 就是为解决这些痛点而生的。它提供了一套简洁的命令，让你专注于编码，而不是 Git 操作。
+
+## ⚡️ 快速开始
+
+### 安装
+
+::: code-group
+
+```bash [npm]
+npm install -g @zjex/git-workflow
+```
+
+```bash [pnpm]
+pnpm add -g @zjex/git-workflow
+```
+
+```bash [yarn]
+yarn global add @zjex/git-workflow
+```
+
+:::
+
+### 三步开始使用
+
+```bash
+# 第 1 步：创建全局配置（只需一次）
+gw init
+# 选择 "全局配置（所有项目生效）"
+# 配置 AI commit、分支规范等
+
+# 第 2 步：在任意项目中使用
+cd your-project
+gw c                    # AI 自动生成 commit message
+gw f                    # 创建规范的 feature 分支
+gw t                    # 创建语义化版本 tag
+
+# 第 3 步：享受高效的 Git 工作流 🎉
+```
+
+## 🌟 核心特性
+
+### 🤖 AI 智能提交
+
+使用 AI 自动分析代码变更生成 commit message，2-3 秒完成，支持多种 AI 提供商：
+
+```bash
+gw c
+# 已暂存的文件:
+#   src/auth.ts
+#   src/login.ts
+# ────────────────────────────────────────
+# ? 选择 commit 方式:
+# ❯ 🤖 AI 自动生成 commit message
+#   ✍️  手动编写 commit message
+#
+# ✔ AI 生成完成
+#
+# AI 生成的 commit message:
+# ✨ feat(auth): 添加用户登录功能
+```
+
+### 🎯 规范分支命名
+
+自动生成带日期的规范分支名，支持自定义前缀和 ID 标签：
+
+```bash
+gw f
+# ? 请输入 Story ID (可跳过): PROJ-123
+# ? 请输入描述: add-user-login
+# ✔ 分支创建成功: feature/20260109-PROJ-123-add-user-login
+```
+
+### 🏷️ 智能版本管理
+
+自动检测现有 tag 前缀，智能递增版本号：
+
+```bash
+gw t
+# ? 选择 tag 前缀: v (最新: v1.2.0)
+# ? 选择版本类型:
+# ❯ patch   → v1.2.1
+#   minor   → v1.3.0
+#   major   → v2.0.0
+#   alpha   → v1.2.1-alpha.1
+```
+
+### 💾 可视化 Stash 管理
+
+原生 `git stash list` 输出难以阅读，Git Workflow 提供清晰的交互式界面：
+
+```bash
+gw s
+# 共 3 个 stash:
+#
+# ? 选择 stash:
+#   [0] main fix login bug (3 文件) 2 hours ago
+#   [1] develop add new feature (5 文件) 1 day ago
+#   [2] main WIP (1 文件) 3 days ago
+#   + 创建新 stash
+#   取消
+```
+
+## 📊 与其他工具对比
+
+| 特性             | Git Workflow  | git-flow    | 手动操作  |
+| ---------------- | ------------- | ----------- | --------- |
+| 学习成本         | ⭐ 极低       | ⭐⭐⭐ 较高 | ⭐⭐ 中等 |
+| 分支命名规范     | ✅ 自动生成   | ❌ 需手动   | ❌ 需手动 |
+| 版本号管理       | ✅ 智能递增   | ❌ 需手动   | ❌ 需手动 |
+| AI Commit        | ✅ 支持       | ❌ 不支持   | ❌ 不支持 |
+| Stash 可视化管理 | ✅ 支持       | ❌ 不支持   | ❌ 不支持 |
+| 交互式操作       | ✅ 支持       | ❌ 不支持   | ❌ 不支持 |
+| 配置灵活性       | ✅ 项目级配置 | ⚠️ 有限     | -         |
+
+## 🎨 优雅的用户界面
+
+Git Workflow 提供优雅的命令行界面，支持键盘快捷操作：
+
+```
+ ███████╗     ██╗███████╗██╗  ██╗
+ ╚══███╔╝     ██║██╔════╝╚██╗██╔╝
+   ███╔╝      ██║█████╗   ╚███╔╝
+  ███╔╝  ██   ██║██╔══╝   ██╔██╗
+ ███████╗╚█████╔╝███████╗██╔╝ ██╗
+ ╚══════╝ ╚════╝ ╚══════╝╚═╝  ╚═╝
+
+  git-workflow v0.2.24
+
+? 选择操作:
+  [1] ✨ 创建 feature 分支      gw f
+  [2] 🐛 创建 hotfix 分支       gw h
+  [3] 🗑️  删除分支               gw d
+  [4] 📝 提交代码               gw c
+  [5] 🏷️  创建 tag               gw t
+  ...
+```
+
+## 🤝 社区与支持
+
+- 📖 [完整文档](/guide/)
+- 🐛 [问题反馈](https://github.com/iamzjt-front-end/git-workflow/issues)
+- 💡 [功能建议](https://github.com/iamzjt-front-end/git-workflow/discussions)
+- 📦 [npm 包](https://www.npmjs.com/package/@zjex/git-workflow)
+
+---
+
+<div style="text-align: center; margin-top: 2rem;">
+  <strong>如果这个工具对你有帮助，请给个 ⭐️ 支持一下！</strong>
+</div>

package/docs/public/favicon.svg

@@ -0,0 +1,21 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 64 64">
+  <rect width="64" height="64" rx="8" fill="#ffffff"/>
+  <!-- 基于 zjex.svg 的交叉图案，放大版本用作 favicon -->
+  <g transform="translate(6, 6) scale(0.52)">
+    <!-- 蓝色条纹 -->
+    <path d="M69.3 59.41l-9.89 9.89L51 77.73 30.46 98.26A6 6 0 0 1 22 89.83L42.56 69.3 51 60.88l9.9-9.9z" fill="#0059cc"/>
+    <path d="M102 24.28a6 6 0 0 1-1.75 4.21L77.72 51l-8.42-8.44 22.5-22.5a6 6 0 0 1 10.2 4.22z" fill="#0059cc"/>
+    
+    <!-- 青色条纹 -->
+    <path d="M83.64 6a5.94 5.94 0 0 1-1.74 4.21L41.08 51l-8.42-8.42 9.9-9.89L51 24.24 73.48 1.75A6 6 0 0 1 83.64 6z" fill="#00dac7"/>
+    <path d="M32.66 59.41L12.13 79.93a6 6 0 0 1-8.42-8.42L24.24 51z" fill="#00dac7"/>
+    
+    <!-- 浅蓝色条纹 -->
+    <path d="M51 24.24l-8.42 8.43-22.5-22.5A6 6 0 0 1 24.28 0a5.89 5.89 0 0 1 4.2 1.75z" fill="#00baec"/>
+    <path d="M98.25 79.93a5.94 5.94 0 0 1-8.42 0L51 41.09l8.42-8.42 9.9 9.89 8.4 8.44 20.53 20.51a6 6 0 0 1 0 8.42z" fill="#00baec"/>
+    
+    <!-- 深蓝色条纹 -->
+    <path d="M51 60.88l-8.44 8.42L1.74 28.49a6 6 0 0 1 8.43-8.43l22.49 22.5L41.08 51z" fill="#00abd8"/>
+    <path d="M79.93 98.26a6 6 0 0 1-8.42 0L51 77.73l8.42-8.43 20.51 20.53a6 6 0 0 1 0 8.43z" fill="#00abd8"/>
+  </g>
+</svg>

package/docs/public/hero-logo.svg

@@ -0,0 +1,43 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 1800 1800" width="320" height="320">
+  <!-- 简洁版本 - 无背景渐变 -->
+  
+  <defs>
+    <!-- 原有的logo渐变 -->
+    <linearGradient id="blueGrad" x1="0%" y1="0%" x2="100%" y2="100%">
+      <stop offset="0%" style="stop-color:#00baec;stop-opacity:1" />
+      <stop offset="100%" style="stop-color:#0059cc;stop-opacity:1" />
+    </linearGradient>
+    <linearGradient id="cyanGrad" x1="0%" y1="0%" x2="100%" y2="100%">
+      <stop offset="0%" style="stop-color:#00dac7;stop-opacity:1" />
+      <stop offset="100%" style="stop-color:#00baec;stop-opacity:1" />
+    </linearGradient>
+    
+    <!-- 发光效果 -->
+    <filter id="glow">
+      <feGaussianBlur stdDeviation="3" result="coloredBlur"/>
+      <feMerge> 
+        <feMergeNode in="coloredBlur"/>
+        <feMergeNode in="SourceGraphic"/>
+      </feMerge>
+    </filter>
+  </defs>
+  
+  <!-- 交叉图案 - 保持原有颜色和效果 -->
+  <g transform="translate(900, 900) scale(16.2) translate(-51, -50)" filter="url(#glow)">
+    <!-- 蓝色条纹 - 使用渐变 -->
+    <path d="M69.3 59.41l-9.89 9.89L51 77.73 30.46 98.26A6 6 0 0 1 22 89.83L42.56 69.3 51 60.88l9.9-9.9z" fill="url(#blueGrad)"/>
+    <path d="M102 24.28a6 6 0 0 1-1.75 4.21L77.72 51l-8.42-8.44 22.5-22.5a6 6 0 0 1 10.2 4.22z" fill="url(#blueGrad)"/>
+    
+    <!-- 青色条纹 - 使用渐变 -->
+    <path d="M83.64 6a5.94 5.94 0 0 1-1.74 4.21L41.08 51l-8.42-8.42 9.9-9.89L51 24.24 73.48 1.75A6 6 0 0 1 83.64 6z" fill="url(#cyanGrad)"/>
+    <path d="M32.66 59.41L12.13 79.93a6 6 0 0 1-8.42-8.42L24.24 51z" fill="url(#cyanGrad)"/>
+    
+    <!-- 浅蓝色条纹 -->
+    <path d="M51 24.24l-8.42 8.43-22.5-22.5A6 6 0 0 1 24.28 0a5.89 5.89 0 0 1 4.2 1.75z" fill="#00baec"/>
+    <path d="M98.25 79.93a5.94 5.94 0 0 1-8.42 0L51 41.09l8.42-8.42 9.9 9.89 8.4 8.44 20.53 20.51a6 6 0 0 1 0 8.42z" fill="#00baec"/>
+    
+    <!-- 深蓝色条纹 -->
+    <path d="M51 60.88l-8.44 8.42L1.74 28.49a6 6 0 0 1 8.43-8.43l22.49 22.5L41.08 51z" fill="#00abd8"/>
+    <path d="M79.93 98.26a6 6 0 0 1-8.42 0L51 77.73l8.42-8.43 20.51 20.53a6 6 0 0 1 0 8.43z" fill="#00abd8"/>
+  </g>
+</svg>

package/docs/public/logo.svg

@@ -0,0 +1,20 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 120 100" width="96" height="96">
+  <!-- 简洁版本 - 用于导航栏 -->
+  <g transform="translate(60, 50) scale(0.9) translate(-51, -50)">
+    <!-- 蓝色条纹 -->
+    <path d="M69.3 59.41l-9.89 9.89L51 77.73 30.46 98.26A6 6 0 0 1 22 89.83L42.56 69.3 51 60.88l9.9-9.9z" fill="#0059cc"/>
+    <path d="M102 24.28a6 6 0 0 1-1.75 4.21L77.72 51l-8.42-8.44 22.5-22.5a6 6 0 0 1 10.2 4.22z" fill="#0059cc"/>
+    
+    <!-- 青色条纹 -->
+    <path d="M83.64 6a5.94 5.94 0 0 1-1.74 4.21L41.08 51l-8.42-8.42 9.9-9.89L51 24.24 73.48 1.75A6 6 0 0 1 83.64 6z" fill="#00dac7"/>
+    <path d="M32.66 59.41L12.13 79.93a6 6 0 0 1-8.42-8.42L24.24 51z" fill="#00dac7"/>
+    
+    <!-- 浅蓝色条纹 -->
+    <path d="M51 24.24l-8.42 8.43-22.5-22.5A6 6 0 0 1 24.28 0a5.89 5.89 0 0 1 4.2 1.75z" fill="#00baec"/>
+    <path d="M98.25 79.93a5.94 5.94 0 0 1-8.42 0L51 41.09l8.42-8.42 9.9 9.89 8.4 8.44 20.53 20.51a6 6 0 0 1 0 8.42z" fill="#00baec"/>
+    
+    <!-- 深蓝色条纹 -->
+    <path d="M51 60.88l-8.44 8.42L1.74 28.49a6 6 0 0 1 8.43-8.43l22.49 22.5L41.08 51z" fill="#00abd8"/>
+    <path d="M79.93 98.26a6 6 0 0 1-8.42 0L51 77.73l8.42-8.43 20.51 20.53a6 6 0 0 1 0 8.43z" fill="#00abd8"/>
+  </g>
+</svg>

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@zjex/git-workflow",
-	"version": "0.2.24",
+	"version": "0.3.0",
 	"description": "🚀 极简的 Git 工作流 CLI 工具，让分支管理和版本发布变得轻松愉快",
 	"type": "module",
 	"bin": {
@@ -17,13 +17,17 @@
 		"test:watch": "vitest",
 		"test:ui": "vitest --ui",
 		"test:coverage": "vitest --coverage",
+		"test:update-readme": "node scripts/update-test-count.js",
 		"changelog": "changelogen -o CHANGELOG.md",
 		"version": "node scripts/version.js",
 		"release": "./scripts/release.sh",
 		"release:dry": "./scripts/release.sh --dry-run",
 		"publish:npm": "NODE_NO_WARNINGS=1 node scripts/publish.js",
 		"prepublishOnly": "npm run build",
-		"prepare": "husky"
+		"prepare": "husky",
+		"docs:dev": "vitepress dev docs",
+		"docs:build": "vitepress build docs",
+		"docs:preview": "npm run docs:build && vitepress preview docs"
 	},
 	"keywords": [
 		"git",
@@ -34,6 +38,10 @@
 	],
 	"author": "zjex",
 	"license": "MIT",
+	"engines": {
+		"node": ">=18.0.0",
+		"npm": ">=9.0.0"
+	},
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/iamzjt-front-end/git-workflow.git"
@@ -59,6 +67,7 @@
 		"tsup": "^8.5.1",
 		"tsx": "^4.21.0",
 		"typescript": "^5.9.3",
+		"vitepress": "^1.6.4",
 		"vitest": "^4.0.16"
 	}
 }

package/scripts/publish.js

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 
-import { execSync } from "child_process";
+import { execSync, spawn } from "child_process";
 import { readFileSync } from "fs";
 import ora from "ora";
 import boxen from "boxen";
@@ -96,14 +96,61 @@ async function main() {
   const npmUser = exec("npm whoami", true);
   if (!npmUser) {
     spinner3.fail(`${colors.blue("[3/11]")} 检查 npm 登录状态`);
-    console.log(colors.red("✖ 未登录 npm，请先执行: npm login"));
-    process.exit(1);
+    console.log(colors.yellow("⚠️ 未登录 npm，需要先登录"));
+    console.log(colors.dim("正在为你打开 npm 登录..."));
+    console.log("");
+    
+    try {
+      // 使用 spawn 而不是 exec，以便用户可以交互
+      const loginProcess = spawn("npm", ["login"], {
+        stdio: "inherit", // 继承父进程的 stdio，允许用户交互
+        shell: true
+      });
+      
+      // 等待登录完成
+      await new Promise((resolve, reject) => {
+        loginProcess.on("close", (code) => {
+          if (code === 0) {
+            resolve();
+          } else {
+            reject(new Error(`npm login 失败，退出码: ${code}`));
+          }
+        });
+        
+        loginProcess.on("error", (error) => {
+          reject(error);
+        });
+      });
+      
+      console.log("");
+      console.log(colors.green("✅ npm 登录成功！"));
+      console.log(colors.dim("继续发布流程..."));
+      console.log("");
+      
+      // 重新检查登录状态
+      const newNpmUser = exec("npm whoami", true);
+      if (!newNpmUser) {
+        console.log(colors.red("✖ 登录验证失败，请手动执行: npm login"));
+        process.exit(1);
+      }
+      
+      spinner3.succeed(
+        `${colors.blue("[3/11]")} 检查 npm 登录状态 ${colors.dim(
+          `(${newNpmUser.trim()})`
+        )}`
+      );
+    } catch (error) {
+      console.log(colors.red("✖ npm 登录失败:"), error.message);
+      console.log(colors.dim("请手动执行: npm login"));
+      process.exit(1);
+    }
+  } else {
+    spinner3.succeed(
+      `${colors.blue("[3/11]")} 检查 npm 登录状态 ${colors.dim(
+        `(${npmUser.trim()})`
+      )}`
+    );
   }
-  spinner3.succeed(
-    `${colors.blue("[3/11]")} 检查 npm 登录状态 ${colors.dim(
-      `(${npmUser.trim()})`
-    )}`
-  );
 
   // 获取当前分支
   const currentBranch = exec("git branch --show-current", true).trim();

package/scripts/publish.sh

@@ -123,8 +123,26 @@ fi
 echo -ne "${BLUE}[3/${TOTAL_STEPS}]${NC} 检查 npm 登录状态... "
 if ! npm whoami &> /dev/null; then
   echo -e "${RED}❌${NC}"
-  print_error "未登录 npm，请先执行: npm login"
-  exit 1
+  echo -e "${YELLOW}⚠️  未登录 npm，需要先登录${NC}"
+  echo -e "${DIM}正在为你打开 npm 登录...${NC}"
+  echo ""
+  
+  # 执行 npm login
+  if npm login; then
+    echo ""
+    echo -e "${GREEN}✅ npm 登录成功！${NC}"
+    echo -e "${DIM}继续发布流程...${NC}"
+    echo ""
+    
+    # 重新检查登录状态
+    if ! npm whoami &> /dev/null; then
+      print_error "登录验证失败，请手动执行: npm login"
+      exit 1
+    fi
+  else
+    print_error "npm 登录失败，请手动执行: npm login"
+    exit 1
+  fi
 fi
 NPM_USER=$(npm whoami)
 echo -e "${GREEN}✅${NC} ${DIM}(${NPM_USER})${NC}"

package/scripts/release.sh

@@ -111,8 +111,26 @@ fi
 # 检查 npm 登录状态
 print_step "检查 npm 登录状态..."
 if ! npm whoami &> /dev/null; then
-  print_error "未登录 npm，请先执行: npm login"
-  exit 1
+  echo -e "${YELLOW}⚠️  未登录 npm，需要先登录${NC}"
+  echo -e "${DIM}正在为你打开 npm 登录...${NC}"
+  echo ""
+  
+  # 执行 npm login
+  if npm login; then
+    echo ""
+    echo -e "${GREEN}✅ npm 登录成功！${NC}"
+    echo -e "${DIM}继续发布流程...${NC}"
+    echo ""
+    
+    # 重新检查登录状态
+    if ! npm whoami &> /dev/null; then
+      print_error "登录验证失败，请手动执行: npm login"
+      exit 1
+    fi
+  else
+    print_error "npm 登录失败，请手动执行: npm login"
+    exit 1
+  fi
 fi
 NPM_USER=$(npm whoami)
 print_success "已登录 npm (用户: ${NPM_USER})"

package/scripts/update-test-count.js

@@ -0,0 +1,55 @@
+#!/usr/bin/env node
+
+import { readFileSync, writeFileSync } from 'fs';
+import { execSync } from 'child_process';
+
+try {
+  // 运行测试并获取结果
+  console.log('🧪 运行测试...');
+  const testOutput = execSync('npm test', { encoding: 'utf8' });
+  
+  // 从测试输出中提取测试数量
+  // 移除ANSI颜色代码，然后匹配测试总数
+  const cleanOutput = testOutput.replace(/\x1B\[[0-9;]*m/g, '');
+  const testMatch = cleanOutput.match(/Tests\s+(\d+)\s+passed\s+\(\d+\)/);
+  
+  let testCount = 0;
+  if (testMatch) {
+    testCount = parseInt(testMatch[1]);
+  }
+  
+  if (testCount === 0) {
+    console.log('❌ 无法从测试输出中提取测试数量');
+    console.log('测试输出:', testOutput.slice(-500)); // 显示最后500字符用于调试
+    process.exit(1);
+  }
+  
+  console.log(`✅ 检测到 ${testCount} 个测试用例`);
+  
+  // 读取README文件
+  const readmePath = 'README.md';
+  let readmeContent = readFileSync(readmePath, 'utf8');
+  
+  // 更新测试徽章
+  const badgeRegex = /tests-\d+%20passed/g;
+  const newBadge = `tests-${testCount}%20passed`;
+  
+  if (readmeContent.match(badgeRegex)) {
+    const oldContent = readmeContent;
+    readmeContent = readmeContent.replace(badgeRegex, newBadge);
+    
+    if (oldContent !== readmeContent) {
+      writeFileSync(readmePath, readmeContent);
+      console.log(`✅ README中的测试数量已更新为 ${testCount}`);
+    } else {
+      console.log(`ℹ️  测试数量无变化，保持 ${testCount}`);
+    }
+  } else {
+    console.log('❌ 未找到测试徽章，无法更新');
+    process.exit(1);
+  }
+  
+} catch (error) {
+  console.error('❌ 更新测试数量失败:', error.message);
+  process.exit(1);
+}