@ckpack/ai-commit 1.1.0 → 1.2.0

package/README.md

@@ -1,13 +1,15 @@
 # ai-commit
 
-使用 Codex 根据 git diff 生成符合 Conventional Commits 的提交信息。
+使用 Codex 或 Gemini CLI 根据 git diff 生成符合 Conventional Commits 的提交信息。
 
 ## 功能
 
 - 读取暂存区或工作区 diff（优先暂存区）
 - 自动忽略常见锁文件与日志文件
 - 生成单行 commit message，长度不超过 50 个字符
-- Codex 失败时自动回退为本地摘要
+- 支持 `codex`（默认）与 `gemini` 子命令
+- AI 执行失败时自动回退为本地摘要
+- 支持 debug 模式输出关键诊断信息（输出到 stderr）
 
 ## 安装
 
@@ -25,13 +27,28 @@ pnpm add -g @ckpack/ai-commit
 
 在包含变更的 git 仓库中运行：
 
+```bash
+ai-commit
+```
+
+`ai-commit` 默认等同于 `ai-commit codex`，你也可以显式指定：
+
 ```bash
 ai-commit codex
+ai-commit gemini
 ```
 
-输出示例：
+调试模式：
 
+```bash
+ai-commit --debug
+ai-commit codex --debug
+ai-commit gemini --debug
 ```
+
+输出示例：
+
+```text
 feat: add commit message generator
 ```
 
@@ -39,17 +56,23 @@ feat: add commit message generator
 
 ```bash
 pnpm dev -- codex
+pnpm dev -- gemini
 ```
 
 ## 环境变量
 
 - `CODEX_BIN`：Codex 可执行文件名，默认 `codex`
 - `CODEX_ARGS`：传给 Codex 的参数，默认 `exec`
+- `GEMINI_BIN`：Gemini 可执行文件名，默认 `gemini`
+- `GEMINI_ARGS`：传给 Gemini 的参数，默认 `-p`
+- `AI_COMMIT_DEBUG`：开启调试日志（`1/true/on` 开启，`0/false/off/no` 关闭）
 
 示例：
 
 ```bash
 CODEX_BIN=codex CODEX_ARGS="exec" ai-commit codex
+GEMINI_BIN=gemini GEMINI_ARGS="-p" ai-commit gemini
+AI_COMMIT_DEBUG=1 ai-commit codex
 ```
 
 ## 生成逻辑
@@ -58,7 +81,7 @@ CODEX_BIN=codex CODEX_ARGS="exec" ai-commit codex
 - 默认忽略：`**/*.log`、`**/pnpm-lock.yaml`、`**/package-lock.json`、`**/yarn.lock`
 - 生成的消息需匹配 Conventional Commits：
   `type(scope?): description`，描述不超过 50 个字符
-- Codex 返回异常或不符合规范时，回退为 `chore: update <files>`
+- Codex / Gemini 返回异常或不符合规范时，回退为 `chore: update <files>`
 
 ## 开发
 

package/dist/index.mjs

@@ -5,12 +5,7 @@ import process from "node:process";
 import { consola } from "consola";
 import { Command } from "commander";
 
-//#region src/command/codex.ts
-function codex(program$1) {
-	program$1.command("codex", { isDefault: true }).action(() => {
-		runCodexCommand();
-	});
-}
+//#region src/command/provider.ts
 function runCommand(command, args, options = {}) {
 	const result = spawnSync(command, args, {
 		encoding: "utf-8",
@@ -23,6 +18,34 @@ function runCommand(command, args, options = {}) {
 		error: result.error
 	};
 }
+function debugLog(enabled, message) {
+	if (!enabled) return;
+	consola.info(`[commit-msg][debug] ${message}`);
+}
+function formatShellArg(value) {
+	if (!value) return "\"\"";
+	return /[^\w@%+=:,./-]/.test(value) ? JSON.stringify(value) : value;
+}
+function formatCommandPreview(bin, args, options) {
+	const base = [bin, ...args].map(formatShellArg).join(" ");
+	if (options.useStdin) return `${base} <stdin:${options.promptChars} chars>`;
+	return `${base} <prompt:${options.promptChars} chars>`;
+}
+function parseEnvFlag(value) {
+	if (!value) return false;
+	return ![
+		"0",
+		"false",
+		"off",
+		"no"
+	].includes(value.trim().toLowerCase());
+}
+function hasDebugArgv(argv = process.argv.slice(2)) {
+	return argv.includes("--debug") || argv.includes("-d");
+}
+function resolveDebugMode(value) {
+	return Boolean(value) || hasDebugArgv() || parseEnvFlag(process.env.AI_COMMIT_DEBUG);
+}
 function ensureNonEmptyDiff(options) {
 	const ignores = (options?.ignores ?? [
 		"**/*.log",
@@ -41,9 +64,15 @@ function ensureNonEmptyDiff(options) {
 		"--staged",
 		...ignores
 	]).stdout.trim();
-	if (stagedDiff) return stagedDiff;
+	if (stagedDiff) return {
+		diff: stagedDiff,
+		source: "staged"
+	};
 	const workingDiff = runCommand("git", [...baseArgs, ...ignores]).stdout.trim();
-	if (workingDiff) return workingDiff;
+	if (workingDiff) return {
+		diff: workingDiff,
+		source: "working"
+	};
 	throw new Error("No changes detected. Stage changes or modify files before generating a commit message.");
 }
 function buildPrompt(diff) {
@@ -60,7 +89,7 @@ function sanitizeMessage(raw) {
 	return (raw.split(/\r?\n/).map((line) => line.trim()).find(Boolean) ?? "").replace(/\s+/g, " ").trim();
 }
 function isConventional(msg) {
-	return (/* @__PURE__ */ new RegExp(`^(revert: )?(${[
+	return new RegExp(`^(revert: )?(${[
 		"feat",
 		"fix",
 		"docs",
@@ -76,52 +105,103 @@ function isConventional(msg) {
 		"types",
 		"wip",
 		"release"
-	].join("|")})(\\(.+\\))?: .{1,50}$`)).test(msg);
+	].join("|")})(\\(.+\\))?: .{1,50}$`).test(msg);
 }
-function tryCodex(prompt) {
-	const bin = process.env.CODEX_BIN || "codex";
-	const args = process.env.CODEX_ARGS?.split(/\s+/).filter(Boolean) ?? ["exec"];
-	const result = args.includes("-") ? runCommand(bin, args, { input: prompt }) : runCommand(bin, [...args, prompt]);
+function tryGenerateMessage(prompt, config, options) {
+	const bin = process.env[config.binEnv] || config.defaultBin;
+	const args = process.env[config.argsEnv]?.split(/\s+/).filter(Boolean) ?? config.defaultArgs;
+	const useStdin = args.includes("-");
+	debugLog(options.debug, `provider=${config.providerName} bin=${bin}`);
+	debugLog(options.debug, `args=${JSON.stringify(args)} stdin=${useStdin ? "yes" : "no"} promptChars=${prompt.length}`);
+	debugLog(options.debug, `command=${formatCommandPreview(bin, args, {
+		useStdin,
+		promptChars: prompt.length
+	})}`);
+	const result = useStdin ? runCommand(bin, args, { input: prompt }) : runCommand(bin, [...args, prompt]);
+	debugLog(options.debug, `exitStatus=${String(result.status)} stdoutChars=${result.stdout.length} stderrChars=${result.stderr.length}`);
 	if (result.status !== 0) {
-		if (result.error) console.warn(`[commit-msg] codex execution failed: ${result.error.message}`);
-		else if (result.stderr.trim()) console.warn(`[commit-msg] codex stderr: ${result.stderr.trim()}`);
+		if (result.error) consola.warn(`[commit-msg] ${config.providerName} execution failed: ${result.error.message}`);
+		else if (result.stderr.trim()) consola.warn(`[commit-msg] ${config.providerName} stderr: ${result.stderr.trim()}`);
 		return null;
 	}
-	return sanitizeMessage(result.stdout) || null;
+	const msg = sanitizeMessage(result.stdout);
+	debugLog(options.debug, `modelMessage=${msg || "<empty>"}`);
+	return msg || null;
 }
 function fallbackMessage() {
 	const files = runCommand("git", ["status", "--short"]).stdout.split(/\r?\n/).map((line) => line.trim()).filter(Boolean);
 	if (files.length === 0) return "chore: update changes";
 	return `chore: update ${files.slice(0, 3).map((line) => line.replace(/^\S+\s+/, "")).join(", ")}${files.length > 3 ? ` and ${files.length - 3} more` : ""}`;
 }
-function runCodexCommand() {
+function runProviderCommand(config, options) {
 	try {
-		const candidate = sanitizeMessage(tryCodex(buildPrompt(ensureNonEmptyDiff())) ?? "");
-		const message = isConventional(candidate) ? candidate : fallbackMessage();
+		const { diff, source } = ensureNonEmptyDiff();
+		debugLog(options.debug, `diffSource=${source} diffChars=${diff.length}`);
+		const candidate = sanitizeMessage(tryGenerateMessage(buildPrompt(diff), config, options) ?? "");
+		const valid = isConventional(candidate);
+		const message = valid ? candidate : fallbackMessage();
+		debugLog(options.debug, `candidate=${candidate || "<empty>"}`);
+		debugLog(options.debug, `isConventional=${valid ? "yes" : "no"}`);
+		debugLog(options.debug, `finalMessage=${message}`);
 		consola.log(message);
 	} catch (error) {
 		const fallback = fallbackMessage();
+		debugLog(options.debug, `error=${error instanceof Error ? error.message : String(error)}`);
+		debugLog(options.debug, `finalMessage=${fallback}`);
 		consola.warn(`[commit-msg] ${error instanceof Error ? error.message : String(error)}. Using fallback message.`);
 		consola.log(fallback);
 	}
 }
+function addProviderCommand(program, config) {
+	program.command(config.name, { isDefault: config.isDefault }).option("-d, --debug", "print debug information").action(function() {
+		runProviderCommand(config, { debug: resolveDebugMode(this.opts().debug) });
+	});
+}
+
+//#endregion
+//#region src/command/codex.ts
+function codex(program) {
+	addProviderCommand(program, {
+		name: "codex",
+		isDefault: true,
+		providerName: "codex",
+		binEnv: "CODEX_BIN",
+		argsEnv: "CODEX_ARGS",
+		defaultBin: "codex",
+		defaultArgs: ["exec"]
+	});
+}
+
+//#endregion
+//#region src/command/gemini.ts
+function gemini(program) {
+	addProviderCommand(program, {
+		name: "gemini",
+		providerName: "gemini",
+		binEnv: "GEMINI_BIN",
+		argsEnv: "GEMINI_ARGS",
+		defaultBin: "gemini",
+		defaultArgs: ["-p"]
+	});
+}
 
 //#endregion
 //#region src/command/index.ts
-function initCommand(program$1) {
-	codex(program$1);
+function initCommand(program) {
+	codex(program);
+	gemini(program);
 }
 
 //#endregion
 //#region package.json
 var name = "@ckpack/ai-commit";
-var version = "1.1.0";
+var version = "1.2.0";
 var description = "根据 git diff 信息 生成符合 Conventional Commits 的提交信息.";
 
 //#endregion
 //#region src/index.ts
 const program = new Command();
-program.name(name).description(description).version(version);
+program.name(name).description(description).version(version).option("-d, --debug", "print debug information");
 initCommand(program);
 program.parse();
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ckpack/ai-commit",
   "type": "module",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "private": false,
   "packageManager": "pnpm@10.12.1+sha512.f0dda8580f0ee9481c5c79a1d927b9164f2c478e90992ad268bbb2465a736984391d6333d2c327913578b2804af33474ca554ba29c04a8b13060a717675ae3ac",
   "description": "根据 git diff 信息 生成符合 Conventional Commits 的提交信息.",
@@ -35,17 +35,17 @@
     "release": "npx changelogen --release --push"
   },
   "dependencies": {
-    "commander": "^14.0.2",
+    "commander": "^14.0.3",
     "consola": "^3.4.2"
   },
   "devDependencies": {
-    "@antfu/eslint-config": "^6.7.3",
+    "@antfu/eslint-config": "^7.6.0",
     "@commander-js/extra-typings": "^14.0.0",
-    "@types/node": "^24",
-    "eslint": "^9.39.2",
+    "@types/node": "^25.3.0",
+    "eslint": "^10.0.2",
     "lint-staged": "^16.2.7",
     "simple-git-hooks": "^2.13.1",
-    "tsdown": "^0.18.3",
+    "tsdown": "^0.20.3",
     "typescript": "^5.9.3"
   },
   "simple-git-hooks": {