@zjex/git-workflow 0.2.17 → 0.2.19

package/src/commands/commit.ts

@@ -79,22 +79,8 @@ 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();
-
-    // 根据配置决定是否自动暂存
+  // 如果有未暂存的更改，根据配置决定是否自动暂存
+  if (unstaged.length > 0) {
     const autoStage = config.autoStage ?? true;
 
     if (autoStage) {
@@ -105,7 +91,17 @@ export async function commit(): Promise<void> {
       // 重新获取状态
       const newStatus = parseGitStatus();
       staged = newStatus.staged;
-    } else {
+      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();
+
       // 让用户选择要暂存的文件
       const filesToStage = await checkbox({
         message: "选择要暂存的文件:",
@@ -133,14 +129,21 @@ export async function commit(): Promise<void> {
       const newStatus = parseGitStatus();
       staged = newStatus.staged;
     }
-  } else {
-    console.log("已暂存的文件:");
-    for (const { status, file } of staged) {
-      console.log(`  ${formatFileStatus(status)} ${file}`);
-    }
-    divider();
   }
 
+  // 没有暂存的更改
+  if (staged.length === 0) {
+    console.log(colors.yellow("工作区干净，没有需要提交的更改"));
+    return;
+  }
+
+  // 显示已暂存的文件
+  console.log("已暂存的文件:");
+  for (const { status, file } of staged) {
+    console.log(`  ${formatFileStatus(status)} ${file}`);
+  }
+  divider();
+
   // 询问用户选择手动还是 AI 生成
   const aiAvailable = isAICommitAvailable(config);
   let commitMode: "ai" | "manual" = "manual";

package/src/commands/help.ts

@@ -33,7 +33,14 @@ Tag 命令:
   gw r                            同上 (别名)
 
 配置命令:
-  gw init                         初始化配置文件 .gwrc.json
+  gw init                         初始化配置文件
+                                  • 全局配置: ~/.gwrc.json (所有项目生效)
+                                  • 项目配置: .gwrc.json (仅当前项目)
+                                  运行时可选择配置范围
+
+更新命令:
+  gw update                       检查并更新到最新版本
+  gw upt                          同上 (别名)
 
 Stash 命令:
   gw stash                        交互式管理 stash

package/src/commands/init.ts

@@ -1,10 +1,10 @@
 import { existsSync, writeFileSync } from "fs";
+import { join } from "path";
+import { homedir } from "os";
 import { select, input } from "@inquirer/prompts";
 import { colors, theme, divider } from "../utils.js";
 import type { GwConfig } from "../config.js";
 
-const CONFIG_FILE = ".gwrc.json";
-
 // 默认的 commit emoji 配置
 const DEFAULT_COMMIT_EMOJIS = {
   feat: "✨",
@@ -21,9 +21,34 @@ const DEFAULT_COMMIT_EMOJIS = {
 };
 
 export async function init(): Promise<void> {
-  if (existsSync(CONFIG_FILE)) {
+  console.log("");
+  console.log(colors.bold("⚙️  初始化 git-workflow 配置"));
+  console.log("");
+
+  // 选择配置范围
+  const configScope = await select({
+    message: "选择配置范围:",
+    choices: [
+      {
+        name: "全局配置（所有项目生效）",
+        value: "global",
+        description: "保存到 ~/.gwrc.json，所有项目都会使用此配置",
+      },
+      {
+        name: "项目配置（仅当前项目）",
+        value: "project",
+        description: "保存到当前目录 .gwrc.json，仅当前项目使用",
+      },
+    ],
+    theme,
+  });
+
+  const isGlobal = configScope === "global";
+  const configFile = isGlobal ? join(homedir(), ".gwrc.json") : ".gwrc.json";
+
+  if (existsSync(configFile)) {
     const overwrite = await select({
-      message: `${CONFIG_FILE} 已存在，是否覆盖?`,
+      message: `${isGlobal ? "全局" : "项目"}配置文件已存在，是否覆盖?`,
       choices: [
         { name: "否，取消", value: false },
         { name: "是，覆盖", value: true },
@@ -55,14 +80,14 @@ export async function init(): Promise<void> {
     default: "feature",
     theme,
   });
-  if (featurePrefix !== "feature") config.featurePrefix = featurePrefix;
+  config.featurePrefix = featurePrefix;
 
   const hotfixPrefix = await input({
     message: "Hotfix 分支前缀:",
     default: "hotfix",
     theme,
   });
-  if (hotfixPrefix !== "hotfix") config.hotfixPrefix = hotfixPrefix;
+  config.hotfixPrefix = hotfixPrefix;
 
   divider();
 
@@ -75,21 +100,21 @@ export async function init(): Promise<void> {
     ],
     theme,
   });
-  if (requireId) config.requireId = true;
+  config.requireId = requireId;
 
   const featureIdLabel = await input({
     message: "Feature 分支 ID 标签:",
     default: "Story ID",
     theme,
   });
-  if (featureIdLabel !== "Story ID") config.featureIdLabel = featureIdLabel;
+  config.featureIdLabel = featureIdLabel;
 
   const hotfixIdLabel = await input({
     message: "Hotfix 分支 ID 标签:",
     default: "Issue ID",
     theme,
   });
-  if (hotfixIdLabel !== "Issue ID") config.hotfixIdLabel = hotfixIdLabel;
+  config.hotfixIdLabel = hotfixIdLabel;
 
   divider();
 
@@ -110,8 +135,12 @@ export async function init(): Promise<void> {
     ],
     theme,
   });
-  if (autoPushChoice === "yes") config.autoPush = true;
-  if (autoPushChoice === "no") config.autoPush = false;
+  if (autoPushChoice === "yes") {
+    config.autoPush = true;
+  } else if (autoPushChoice === "no") {
+    config.autoPush = false;
+  }
+  // autoPushChoice === "ask" 时不设置，使用默认行为（每次询问）
 
   divider();
 
@@ -124,7 +153,7 @@ export async function init(): Promise<void> {
     ],
     theme,
   });
-  if (!autoStage) config.autoStage = false;
+  config.autoStage = autoStage;
 
   const useEmoji = await select({
     message: "Commit 时是否使用 emoji?",
@@ -134,7 +163,7 @@ export async function init(): Promise<void> {
     ],
     theme,
   });
-  if (!useEmoji) config.useEmoji = false;
+  config.useEmoji = useEmoji;
 
   // 始终写入默认的 commitEmojis 配置，方便用户修改
   config.commitEmojis = DEFAULT_COMMIT_EMOJIS;
@@ -164,11 +193,6 @@ export async function init(): Promise<void> {
           value: "github",
           description: "使用 GitHub 账号，每天 150 次免费",
         },
-        {
-          name: "Groq（免费）",
-          value: "groq",
-          description: "需要注册，每天 14,400 次免费",
-        },
         {
           name: "OpenAI（付费）",
           value: "openai",
@@ -188,28 +212,42 @@ export async function init(): Promise<void> {
       theme,
     });
 
-    const useBuiltinKey = await select({
-      message: "API Key 配置:",
-      choices: [
-        {
-          name: "使用内置 Key（开箱即用）",
-          value: true,
-          description: "使用工具内置的 API key，共享限额",
-        },
-        {
-          name: "使用自己的 Key（推荐）",
-          value: false,
-          description: "配置自己的 API key，独享限额",
+    let apiKey = "";
+
+    // GitHub Models 需要配置 GitHub Token
+    if (aiProvider === "github") {
+      console.log("");
+      console.log(colors.cyan("💡 如何获取 GitHub Token:"));
+      console.log(
+        colors.dim("  1. 访问: https://github.com/settings/tokens/new")
+      );
+      console.log(colors.dim("  2. 勾选 'repo' 权限"));
+      console.log(colors.dim("  3. 生成并复制 token"));
+      console.log("");
+
+      apiKey = await input({
+        message: "输入你的 GitHub Token:",
+        validate: (value) => {
+          if (!value.trim()) return "GitHub Token 不能为空";
+          return true;
         },
-      ],
-      theme,
-    });
+        theme,
+      });
+    } else if (aiProvider !== "ollama") {
+      // OpenAI 和 Claude 必须配置 API key
+      console.log("");
+      if (aiProvider === "openai") {
+        console.log(colors.cyan("💡 如何获取 OpenAI API Key:"));
+        console.log(colors.dim("  访问: https://platform.openai.com/api-keys"));
+      } else {
+        console.log(colors.cyan("💡 如何获取 Claude API Key:"));
+        console.log(colors.dim("  访问: https://console.anthropic.com/"));
+      }
+      console.log("");
 
-    let apiKey = "";
-    if (!useBuiltinKey) {
       apiKey = await input({
         message: `输入你的 ${
-          aiProvider === "github" ? "GitHub Token" : "API Key"
+          aiProvider === "openai" ? "OpenAI API Key" : "Claude API Key"
         }:`,
         validate: (value) => {
           if (!value.trim()) return "API Key 不能为空";
@@ -230,12 +268,7 @@ export async function init(): Promise<void> {
 
     config.aiCommit = {
       enabled: true,
-      provider: aiProvider as
-        | "github"
-        | "groq"
-        | "openai"
-        | "claude"
-        | "ollama",
+      provider: aiProvider as "github" | "openai" | "claude" | "ollama",
       apiKey: apiKey || undefined,
       language: language as "zh-CN" | "en-US",
     };
@@ -243,7 +276,6 @@ export async function init(): Promise<void> {
     // 根据提供商设置默认模型
     const defaultModels: Record<string, string> = {
       github: "gpt-4o-mini",
-      groq: "llama-3.1-8b-instant",
       openai: "gpt-4o-mini",
       claude: "claude-3-haiku-20240307",
       ollama: "qwen2.5-coder:7b",
@@ -259,15 +291,35 @@ export async function init(): Promise<void> {
 
   // 写入配置
   const content = JSON.stringify(config, null, 2);
-  writeFileSync(CONFIG_FILE, content + "\n");
+  writeFileSync(configFile, content + "\n");
 
-  console.log(colors.green(`✓ 配置已保存到 ${CONFIG_FILE}`));
   console.log(
-    colors.dim(
-      "\n提示: 可以在配置文件中修改 commitEmojis 来自定义各类型的 emoji"
+    colors.green(
+      `✓ 配置已保存到 ${
+        isGlobal ? "全局配置文件" : "项目配置文件"
+      }: ${configFile}`
     )
   );
 
+  if (isGlobal) {
+    console.log("");
+    console.log(colors.cyan("💡 提示:"));
+    console.log(
+      colors.dim("  • 全局配置对所有项目生效，无需在每个项目中重复配置")
+    );
+    console.log(
+      colors.dim("  • 如需为特定项目自定义配置，可在项目中运行 gw init")
+    );
+    console.log(colors.dim("  • 项目配置会覆盖全局配置"));
+  } else {
+    console.log("");
+    console.log(
+      colors.dim(
+        "提示: 可以在配置文件中修改 commitEmojis 来自定义各类型的 emoji"
+      )
+    );
+  }
+
   if (config.aiCommit?.enabled) {
     console.log(
       colors.dim(

package/src/commands/update.ts

@@ -0,0 +1,122 @@
+import { execSync } from "child_process";
+import ora from "ora";
+import boxen from "boxen";
+import { colors } from "../utils.js";
+
+/**
+ * 获取 npm 上的最新版本
+ */
+async function getLatestVersion(packageName: string): Promise<string | null> {
+  try {
+    const result = execSync(`npm view ${packageName} version`, {
+      encoding: "utf-8",
+      timeout: 3000,
+      stdio: ["pipe", "pipe", "ignore"],
+    });
+    return result.trim();
+  } catch {
+    return null;
+  }
+}
+
+/**
+ * 手动更新命令
+ */
+export async function update(currentVersion: string): Promise<void> {
+  const packageName = "@zjex/git-workflow";
+
+  console.log("");
+  console.log(colors.bold("🔍 检查更新..."));
+  console.log("");
+
+  const spinner = ora("正在获取最新版本信息...").start();
+
+  try {
+    const latestVersion = await getLatestVersion(packageName);
+
+    if (!latestVersion) {
+      spinner.fail("无法获取最新版本信息");
+      console.log(colors.dim("  请检查网络连接后重试"));
+      return;
+    }
+
+    spinner.stop();
+
+    if (latestVersion === currentVersion) {
+      console.log(
+        boxen(
+          [
+            colors.bold("✅ 已是最新版本"),
+            "",
+            `当前版本: ${colors.green(currentVersion)}`,
+          ].join("\n"),
+          {
+            padding: 1,
+            margin: { top: 0, bottom: 1, left: 2, right: 2 },
+            borderStyle: "round",
+            borderColor: "green",
+            align: "left",
+          }
+        )
+      );
+      return;
+    }
+
+    // 有新版本
+    console.log(
+      boxen(
+        [
+          colors.bold("🎉 发现新版本！"),
+          "",
+          `${colors.dim(currentVersion)}  →  ${colors.green(
+            colors.bold(latestVersion)
+          )}`,
+        ].join("\n"),
+        {
+          padding: 1,
+          margin: { top: 0, bottom: 1, left: 2, right: 2 },
+          borderStyle: "round",
+          borderColor: "yellow",
+          align: "left",
+        }
+      )
+    );
+
+    // 开始更新
+    const updateSpinner = ora("正在更新...").start();
+
+    execSync(`npm install -g ${packageName}@latest`, {
+      encoding: "utf-8",
+      stdio: ["pipe", "pipe", "pipe"],
+    });
+
+    updateSpinner.succeed(colors.green("更新成功！"));
+    console.log("");
+    console.log(
+      boxen(
+        [
+          colors.bold("✨ 更新完成！"),
+          "",
+          colors.dim("请重新打开终端使用新版本"),
+        ].join("\n"),
+        {
+          padding: 1,
+          margin: { top: 0, bottom: 1, left: 2, right: 2 },
+          borderStyle: "round",
+          borderColor: "green",
+          align: "left",
+        }
+      )
+    );
+
+    // 更新成功后退出
+    process.exit(0);
+  } catch (error) {
+    spinner.fail(colors.red("更新失败"));
+    console.log("");
+    console.log(colors.dim("  你可以手动运行以下命令更新:"));
+    console.log(colors.cyan(`  npm install -g ${packageName}@latest`));
+    console.log("");
+    process.exit(1);
+  }
+}

package/src/config.ts

@@ -1,5 +1,6 @@
 import { existsSync, readFileSync } from "fs";
 import { join } from "path";
+import { homedir } from "os";
 import { execOutput } from "./utils.js";
 
 export interface GwConfig {
@@ -39,7 +40,7 @@ export interface GwConfig {
   // AI commit 配置
   aiCommit?: {
     enabled?: boolean; // 是否启用 AI commit，默认 true
-    provider?: "github" | "groq" | "openai" | "claude" | "ollama"; // AI 提供商，默认 github
+    provider?: "github" | "openai" | "claude" | "ollama"; // AI 提供商，默认 github
     apiKey?: string; // API key，空则使用内置 key
     model?: string; // 模型名称
     language?: "zh-CN" | "en-US"; // 生成语言，默认 zh-CN
@@ -89,21 +90,55 @@ function findConfigFile(): string | null {
   return null;
 }
 
+function findGlobalConfigFile(): string | null {
+  const globalConfigPath = join(homedir(), ".gwrc.json");
+  return existsSync(globalConfigPath) ? globalConfigPath : null;
+}
+
 export function loadConfig(): GwConfig {
-  const configPath = findConfigFile();
+  let config = { ...defaultConfig };
 
-  if (!configPath) {
-    return defaultConfig;
+  // 1. 先加载全局配置
+  const globalConfigPath = findGlobalConfigFile();
+  if (globalConfigPath) {
+    try {
+      const content = readFileSync(globalConfigPath, "utf-8");
+      const globalConfig = JSON.parse(content) as Partial<GwConfig>;
+      // 深度合并 aiCommit 配置
+      config = {
+        ...config,
+        ...globalConfig,
+        aiCommit: {
+          ...config.aiCommit,
+          ...globalConfig.aiCommit,
+        },
+      };
+    } catch (e) {
+      console.warn(`全局配置文件解析失败: ${globalConfigPath}`);
+    }
   }
 
-  try {
-    const content = readFileSync(configPath, "utf-8");
-    const userConfig = JSON.parse(content) as Partial<GwConfig>;
-    return { ...defaultConfig, ...userConfig };
-  } catch (e) {
-    console.warn(`配置文件解析失败: ${configPath}`);
-    return defaultConfig;
+  // 2. 再加载项目配置（会覆盖全局配置）
+  const projectConfigPath = findConfigFile();
+  if (projectConfigPath) {
+    try {
+      const content = readFileSync(projectConfigPath, "utf-8");
+      const projectConfig = JSON.parse(content) as Partial<GwConfig>;
+      // 深度合并 aiCommit 配置
+      config = {
+        ...config,
+        ...projectConfig,
+        aiCommit: {
+          ...config.aiCommit,
+          ...projectConfig.aiCommit,
+        },
+      };
+    } catch (e) {
+      console.warn(`项目配置文件解析失败: ${projectConfigPath}`);
+    }
   }
+
+  return config;
 }
 
 // 全局配置实例

package/src/index.ts

@@ -12,6 +12,7 @@ import { stash } from "./commands/stash.js";
 import { commit } from "./commands/commit.js";
 import { showHelp } from "./commands/help.js";
 import { checkForUpdates } from "./update-notifier.js";
+import { update } from "./commands/update.js";
 
 // 捕获 Ctrl+C 退出，静默处理
 process.on("uncaughtException", (err) => {
@@ -282,6 +283,13 @@ cli
     return commit();
   });
 
+cli
+  .command("update", "检查并更新到最新版本")
+  .alias("upt")
+  .action(async () => {
+    return update(version);
+  });
+
 cli.help((sections) => {
   sections.push({
     body: showHelp(),