git-repo-comitter 0.1.1

package/.env.example

@@ -0,0 +1,3 @@
+LLM_API_KEY=your-api-key-here
+LLM_ENDPOINT=https://api.openai.com/v1
+LLM_MODEL=gpt-4

package/.eslintrc.cjs

@@ -0,0 +1,19 @@
+module.exports = {
+  root: true,
+  parser: "@typescript-eslint/parser",
+  plugins: ["@typescript-eslint"],
+  extends: [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "prettier",
+  ],
+  env: {
+    node: true,
+    es2020: true,
+  },
+  parserOptions: {
+    ecmaVersion: 2020,
+    sourceType: "module",
+  },
+  rules: {},
+};

package/.github/workflows/publish.yml

@@ -0,0 +1,29 @@
+name: Publish Package
+
+on:
+  push:
+    tags:
+      - "v*"
+
+permissions:
+  id-token: write
+  contents: read
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: pnpm/action-setup@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: "20"
+          registry-url: "https://registry.npmjs.org"
+
+      - run: pnpm install --frozen-lockfile
+
+      - run: pnpm build
+
+      - run: npm publish --provenance --access public

package/.prettierrc

@@ -0,0 +1,7 @@
+{
+  "semi": true,
+  "singleQuote": false,
+  "tabWidth": 2,
+  "trailingComma": "all",
+  "printWidth": 80
+}

package/LICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <https://unlicense.org>

package/config.yaml

@@ -0,0 +1,16 @@
+# Git Repo Committer 配置文件
+
+# 大模型配置
+llm:
+  model: "gpt-4"
+  temperature: 0.7
+  max_tokens: 256
+
+# 生成风格模板
+style:
+  language: "zh-CN"
+  template: "conventional"  # conventional | conventional-commit | custom
+
+# Git 目录路径（默认为当前目录）
+git:
+  repoPath: "."

package/docs/feature/01./345/210/235/345/247/213/345/214/226/351/241/271/347/233/256.md

@@ -0,0 +1,143 @@
+# 项目初始化
+
+## 项目概述
+
+本项目是一个基于 TypeScript 的前端工具，用于调用大语言模型（采用 OpenAI 兼容格式），管理 Git 差异（diff），自动生成 Git 提交信息（commit message），并执行提交操作。
+
+## 技术栈
+
+- 编程语言：TypeScript
+- 构建工具：Vite
+- 包管理器：npm
+- 代码格式化：Prettier + ESLint
+- Git 钩子：husky + lint-staged
+
+## 功能需求
+
+### 核心功能
+
+1. **Git 差异管理**
+   - 读取当前 Git 仓库的变更内容（diff）
+   - 支持暂存区和工作区的差异提取
+
+2. **大模型调用**
+   - 调用外部大语言模型 API 生成提交信息（OpenAI 兼容格式）
+   - 支持从环境变量读取模型配置：
+     - `LLM_API_KEY`：API 密钥
+     - `LLM_ENDPOINT`：服务地址（例如 `https://api.openai.com/v1`）
+     - `LLM_MODEL`：模型名称（例如 `gpt-4`、`gpt-3.5-turbo`）
+
+3. **配置系统**
+   - 支持 YAML 配置文件（如 `.git-repo-committer.yaml`）
+   - 可配置项包括：
+     - 模型选择与参数（model、temperature、max_tokens 等）
+     - 生成风格或模板
+     - Git 目录路径
+
+4. **Git 提交**
+   - 自动执行 `git commit` 操作
+   - 使用生成的提交信息
+
+### 环境变量
+
+项目将依赖以下环境变量：
+
+- `LLM_API_KEY`：大模型 API 密钥
+- `LLM_ENDPOINT`：大模型服务地址（OpenAI 兼容端点）
+- `LLM_MODEL`：模型名称
+
+## 项目结构
+
+```
+git-repo-committer/
+├── src/
+│   ├── index.ts          # 入口文件
+│   ├── git.ts            # Git 差异处理
+│   ├── llm.ts            # 大模型调用（OpenAI 兼容）
+│   ├── config.ts         # 配置读取
+│   └── commit.ts         # 提交管理
+├── config.yaml           # YAML 配置文件
+├── .env                  # 环境变量文件（不提交）
+├── .env.example          # 环境变量示例
+├── .eslintrc.cjs         # ESLint 配置
+├── .prettierrc           # Prettier 配置
+├── tsconfig.json         # TypeScript 配置
+├── vite.config.ts        # Vite 配置
+├── package.json          # 包描述文件
+├── README.md             # 项目说明
+└── .gitignore            # Git 忽略规则
+```
+
+## 初始化步骤
+
+1. **创建项目目录并初始化 npm**
+
+   ```bash
+   mkdir git-repo-committer
+   cd git-repo-committer
+   npm init -y
+   ```
+
+2. **初始化 TypeScript 配置**
+
+   ```bash
+   npm install --save-dev typescript
+   npx tsc --init
+   ```
+
+3. **安装 Vite 及相关依赖**
+
+   ```bash
+   npm install --save-dev vite @types/node
+   ```
+
+4. **安装代码格式化工具**
+
+   ```bash
+   npm install --save-dev prettier eslint eslint-config-prettier @typescript-eslint/parser @typescript-eslint/eslint-plugin
+   ```
+
+5. **安装 Git 钩子工具**
+
+   ```bash
+   npm install --save-dev husky lint-staged
+   npx husky init
+   ```
+
+6. **安装运行时依赖**
+
+   ```bash
+   npm install yaml dotenv openai
+   ```
+
+7. **创建配置文件**
+
+   - 创建 `.env.example` 和 `.env`（写入环境变量）
+   - 创建 `config.yaml`（定义模型参数和模板）
+   - 创建 `.eslintrc.cjs`、`.prettierrc` 配置规则
+   - 创建 `vite.config.ts` 定义构建目标
+
+8. **实现核心模块**
+
+   - `src/config.ts`：读取 YAML 配置和 `.env` 环境变量
+   - `src/git.ts`：执行 `git diff` 命令并解析结果
+   - `src/llm.ts`：使用 OpenAI SDK 调用兼容 API
+   - `src/commit.ts`：组装并执行 `git commit -m "..."`
+
+9. **完善 package.json 元数据**
+
+
+## 发布计划
+
+项目完成后将发布到 npm registry，作为命令行工具（CLI）供开发者使用。发布步骤：
+
+1. 确保 `package.json` 中已填入正确的 GitHub 仓库地址和元信息
+2. 运行 `npm run build` 构建产物
+3. 执行 `npm publish` 发布
+
+## 注意事项
+
+- 确保 `.gitignore` 包含 `node_modules`、`dist`、`.env` 等目录
+- 环境变量文件 `.env` 不应提交到版本控制系统
+- 使用 `openai` 包时需配置 `baseURL` 为 `LLM_ENDPOINT` 的值
+- 代码提交前会通过 husky + lint-staged 自动执行 ESLint 和 Prettier 格式化

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "git-repo-comitter",
+  "version": "0.1.1",
+  "description": "A CLI tool that uses LLM to generate Git commit messages and execute commits",
+  "type": "module",
+  "main": "dist/index.cjs",
+  "bin": {
+    "git-repo-comitter": "dist/index.cjs"
+  },
+  "keywords": [
+    "git",
+    "commit",
+    "llm",
+    "ai",
+    "openai"
+  ],
+  "author": "",
+  "license": "unlicense",
+  "lint-staged": {
+    "*.ts": [
+      "prettier --write",
+      "eslint --fix"
+    ]
+  },
+  "devDependencies": {
+    "@types/node": "^26.1.1",
+    "@typescript-eslint/eslint-plugin": "^8.63.0",
+    "@typescript-eslint/parser": "^8.63.0",
+    "eslint": "^10.7.0",
+    "eslint-config-prettier": "^10.1.8",
+    "husky": "^9.1.7",
+    "lint-staged": "^16.4.0",
+    "prettier": "^3.9.5",
+    "typescript": "^6.0.3",
+    "vite": "^8.1.4"
+  },
+  "dependencies": {
+    "dotenv": "^17.4.2",
+    "openai": "^6.46.0",
+    "yaml": "^2.9.0"
+  },
+  "scripts": {
+    "dev": "vite",
+    "build": "tsc && vite build",
+    "preview": "vite preview",
+    "lint": "eslint src/",
+    "format": "prettier --write \"src/**/*.ts\""
+  }
+}

package/src/commit.ts

@@ -0,0 +1,12 @@
+import { execSync } from "child_process";
+
+export function gitCommit(message: string, repoPath?: string): void {
+  const cwd = repoPath || process.cwd();
+  const escapedMessage = message.replace(/"/g, '\\"');
+  execSync(`git commit -m "${escapedMessage}"`, { cwd, encoding: "utf-8" });
+}
+
+export function gitAddAll(repoPath?: string): void {
+  const cwd = repoPath || process.cwd();
+  execSync("git add -A", { cwd, encoding: "utf-8" });
+}

package/src/config.ts

@@ -0,0 +1,73 @@
+import { readFileSync, existsSync } from "fs";
+import { resolve } from "path";
+import YAML from "yaml";
+import dotenv from "dotenv";
+
+dotenv.config();
+
+export interface LLMConfig {
+  model: string;
+  temperature: number;
+  max_tokens: number;
+}
+
+export interface StyleConfig {
+  language: string;
+  template: string;
+}
+
+export interface GitConfig {
+  repoPath: string;
+}
+
+export interface AppConfig {
+  llm: LLMConfig;
+  style: StyleConfig;
+  git: GitConfig;
+  apiKey: string;
+  endpoint: string;
+}
+
+const DEFAULT_CONFIG: AppConfig = {
+  llm: {
+    model: "gpt-4",
+    temperature: 0.7,
+    max_tokens: 256,
+  },
+  style: {
+    language: "zh-CN",
+    template: "conventional",
+  },
+  git: {
+    repoPath: ".",
+  },
+  apiKey: "",
+  endpoint: "https://api.openai.com/v1",
+};
+
+export function loadConfig(configPath?: string): AppConfig {
+  const configFile =
+    configPath ||
+    [
+      ".git-repo-committer.yaml",
+      ".git-repo-committer.yml",
+      "config.yaml",
+    ].find((f) => existsSync(resolve(process.cwd(), f)));
+
+  let fileConfig: Partial<AppConfig> = {};
+
+  if (configFile) {
+    const content = readFileSync(resolve(process.cwd(), configFile), "utf-8");
+    fileConfig = YAML.parse(content);
+  }
+
+  return {
+    ...DEFAULT_CONFIG,
+    ...fileConfig,
+    llm: { ...DEFAULT_CONFIG.llm, ...(fileConfig.llm || {}) },
+    style: { ...DEFAULT_CONFIG.style, ...(fileConfig.style || {}) },
+    git: { ...DEFAULT_CONFIG.git, ...(fileConfig.git || {}) },
+    apiKey: process.env.LLM_API_KEY || fileConfig.apiKey || "",
+    endpoint: process.env.LLM_ENDPOINT || fileConfig.endpoint || DEFAULT_CONFIG.endpoint,
+  };
+}

package/src/git.ts

@@ -0,0 +1,47 @@
+import { execSync } from "child_process";
+
+export function getStagedDiff(repoPath?: string): string {
+  const cwd = repoPath || process.cwd();
+  try {
+    return execSync("git diff --cached", { cwd, encoding: "utf-8" });
+  } catch {
+    return "";
+  }
+}
+
+export function getUnstagedDiff(repoPath?: string): string {
+  const cwd = repoPath || process.cwd();
+  try {
+    return execSync("git diff", { cwd, encoding: "utf-8" });
+  } catch {
+    return "";
+  }
+}
+
+export function getAllDiff(repoPath?: string): string {
+  const cwd = repoPath || process.cwd();
+  const staged = getStagedDiff(cwd);
+  const unstaged = getUnstagedDiff(cwd);
+
+  const parts: string[] = [];
+  if (staged.trim()) {
+    parts.push("=== Staged Changes ===\n" + staged);
+  }
+  if (unstaged.trim()) {
+    parts.push("=== Unstaged Changes ===\n" + unstaged);
+  }
+  return parts.join("\n\n");
+}
+
+export function hasStagedChanges(repoPath?: string): boolean {
+  const cwd = repoPath || process.cwd();
+  try {
+    const result = execSync("git diff --cached --name-only", {
+      cwd,
+      encoding: "utf-8",
+    });
+    return result.trim().length > 0;
+  } catch {
+    return false;
+  }
+}

package/src/index.ts

@@ -0,0 +1,33 @@
+#!/usr/bin/env node
+
+import { loadConfig } from "./config";
+import { getAllDiff, hasStagedChanges } from "./git";
+import { generateCommitMessage } from "./llm";
+import { gitCommit, gitAddAll } from "./commit";
+
+async function main() {
+  const config = loadConfig();
+
+  if (!hasStagedChanges(config.git.repoPath)) {
+    console.log("No staged changes found. Staging all changes...");
+    gitAddAll(config.git.repoPath);
+  }
+
+  const diff = getAllDiff(config.git.repoPath);
+  if (!diff.trim()) {
+    console.log("No changes to commit.");
+    process.exit(0);
+  }
+
+  console.log("Generating commit message...\n");
+  const message = await generateCommitMessage(diff, config);
+  console.log(`Commit message:\n  ${message}\n`);
+
+  gitCommit(message, config.git.repoPath);
+  console.log("Commit successful!");
+}
+
+main().catch((err) => {
+  console.error("Error:", err.message);
+  process.exit(1);
+});

package/src/llm.ts

@@ -0,0 +1,45 @@
+import OpenAI from "openai";
+import type { AppConfig } from "./config";
+
+const SYSTEM_PROMPT = `You are an expert at writing Git commit messages.
+Based on the provided Git diff, generate a concise and descriptive commit message.
+Follow the Conventional Commits format: <type>(<scope>): <description>
+Types: feat, fix, docs, style, refactor, perf, test, build, ci, chore, revert
+Keep the message under 72 characters for the subject line.
+If there are significant changes, add a blank line followed by a more detailed body.
+Respond with ONLY the commit message, no explanation.`;
+
+export async function generateCommitMessage(
+  diff: string,
+  config: AppConfig,
+): Promise<string> {
+  if (!config.apiKey) {
+    throw new Error(
+      "LLM_API_KEY is not set. Please set it in .env or environment variables.",
+    );
+  }
+
+  const client = new OpenAI({
+    apiKey: config.apiKey,
+    baseURL: config.endpoint,
+  });
+
+  const response = await client.chat.completions.create({
+    model: config.llm.model,
+    temperature: config.llm.temperature,
+    max_tokens: config.llm.max_tokens,
+    messages: [
+      { role: "system", content: SYSTEM_PROMPT },
+      {
+        role: "user",
+        content: `Here is the Git diff:\n\n${diff}`,
+      },
+    ],
+  });
+
+  const message = response.choices[0]?.message?.content?.trim();
+  if (!message) {
+    throw new Error("LLM returned an empty commit message.");
+  }
+  return message;
+}

package/tsconfig.json

@@ -0,0 +1,18 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "resolveJsonModule": true,
+    "declaration": true,
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "sourceMap": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist"]
+}

package/vite.config.ts

@@ -0,0 +1,18 @@
+import { defineConfig } from "vite";
+import { resolve } from "path";
+
+export default defineConfig({
+  build: {
+    lib: {
+      entry: resolve(__dirname, "src/index.ts"),
+      name: "git-repo-comitter",
+      fileName: "index",
+      formats: ["cjs"],
+    },
+    outDir: "dist",
+    sourcemap: true,
+    rollupOptions: {
+      external: ["openai", "yaml", "dotenv"],
+    },
+  },
+});