git-repo-comitter 0.2.5 → 0.3.0

package/package.json

@@ -1,12 +1,15 @@
 {
   "name": "git-repo-comitter",
-  "version": "0.2.5",
+  "version": "0.3.0",
   "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"
   },
+  "files": [
+    "dist"
+  ],
   "scripts": {
     "dev": "vite",
     "build": "tsc && vite build",

package/.env.example

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

package/.eslintrc.cjs

@@ -1,19 +0,0 @@
-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

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

package/.prettierrc

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

package/config.yaml

@@ -1,16 +0,0 @@
-# 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

@@ -1,143 +0,0 @@
-# 项目初始化
-
-## 项目概述
-
-本项目是一个基于 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/src/commit.ts

@@ -1,12 +0,0 @@
-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

@@ -1,74 +0,0 @@
-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: "deepseek-v4-flash",
-    temperature: 0.7,
-    max_tokens: 262144,
-  },
-  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

@@ -1,47 +0,0 @@
-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

@@ -1,40 +0,0 @@
-#!/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 (!config.apiKey) {
-    console.error(
-      "Error: LLM_API_KEY is not set. Please set it in .env or environment variables.",
-    );
-    process.exit(1);
-  }
-
-  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

@@ -1,45 +0,0 @@
-import OpenAI from "openai";
-import type { AppConfig } from "./config";
-
-const SYSTEM_PROMPT = `你是一位擅长编写 Git 提交信息的专家。
-根据提供的 Git diff，生成简洁且描述准确的提交信息。
-遵循 Conventional Commits 格式：<type>(<scope>): <description>
-类型包括：feat, fix, docs, style, refactor, perf, test, build, ci, chore, revert
-标题行控制在 72 个字符以内。
-如果有重要变更，在空行后添加更详细的正文说明。
-只回复提交信息本身，不要添加任何解释。`;
-
-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: `以下是 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

@@ -1,18 +0,0 @@
-{
-  "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

@@ -1,18 +0,0 @@
-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"],
-    },
-  },
-});