ai-git-tool 1.0.0 → 1.2.0

package/README.md

@@ -1,121 +1,151 @@
-# ai-git
+# ai-git-tool
 
 Groq API を使って、ステージ済み差分からコミットメッセージと PR 説明文を自動生成する TypeScript 製 CLI です。
 
-## 必要環境
+## セットアップ
 
-- Node.js `18` 以上
-- `git`
-- Groq API キー（`GROQ_API_KEY`）
+```bash
+npm install -g ai-git-tool
+```
 
-## セットアップ
+### 環境変数
 
-### npm からインストール（推奨）
+API キーの取得先: [Groq Console](https://console.groq.com/keys)
+
+**macOS / Linux (bash/zsh):**
 
 ```bash
-npm install -g @imakento/ai-git
+export GROQ_API_KEY="your_api_key"
 ```
 
-### ローカル開発版をリンク
+永続化する場合は `~/.bashrc` や `~/.zshrc` に追記してください。
 
-```bash
-npm install
-npm run build
-npm link
+**Windows (コマンドプロンプト):**
+
+```cmd
+setx GROQ_API_KEY "your_api_key"
+```
+
+**Windows (PowerShell):**
+
+```powershell
+[System.Environment]::SetEnvironmentVariable("GROQ_API_KEY", "your_api_key", "User")
 ```
 
-`npm link` 後は、どの Git リポジトリでも `ai-git` が使えます。
+> `setx` / `SetEnvironmentVariable` はユーザー環境変数として永続保存されます。設定後は**ターミナルを再起動**してください。
 
-## 環境変数
+**Windows (Git Bash):**
 
 ```bash
-export GROQ_API_KEY="your_api_key"
+echo 'export GROQ_API_KEY="your_api_key"' >> ~/.bashrc
+source ~/.bashrc
 ```
 
-任意でモデル指定も可能です。
+任意でモデル指定も可能です（デフォルト: `llama-3.1-8b-instant`）。
 
 ```bash
-export GROQ_MODEL="llama-3.1-8b-instant"
-```
+# macOS / Linux / Git Bash
+export GROQ_MODEL="llama-3.3-70b-versatile"
 
-API キーの取得先: [Groq Console](https://console.groq.com/keys)
+# Windows コマンドプロンプト
+setx GROQ_MODEL "llama-3.3-70b-versatile"
+```
 
 ## 使い方
 
 ### コミットメッセージ生成
 
-1. 先に変更をステージ
-
 ```bash
-git add .
+ai-git commit
 ```
 
-2. コミットメッセージを生成
+デフォルトで `git add .` を実行してからコミットメッセージを生成します。
 
 ```bash
-# 通常（タイトル + 箇条書き本文）
-ai-git commit
+# 手動でステージした差分のみ使う
+ai-git commit --no-add
 ```
 
-デフォルト言語は日本語です。
+確認プロンプトで操作を選択できます。
 
-```bash
-# 今回だけ英語で生成
-ai-git commit --lang en
+| 入力 | 動作 |
+|------|------|
+| `y` | そのままコミット |
+| `n` | 中止 |
+| `e` | エディタで編集してからコミット |
 
-# デフォルト言語を永続化
-ai-git --set-lang en
-ai-git --set-lang ja
+**生成されるコミットメッセージの形式（Conventional Commits）:**
+
+```
+feat(auth): Google ログインを追加する
+
+- GoogleAuthProvider の設定を auth.ts に追加する
+- トークン期限切れ時の更新処理を追加する
+- ネットワーク障害時のエラーハンドリングを追加する
+```
+
+### コミット & プッシュ
+
+```bash
+ai-git push
 ```
 
-3. 確認プロンプトで選択
+`git add .` → AI によるコミットメッセージ生成 → コミット → `git push` を一括で実行します。
 
-- `y`: そのままコミット
-- `n`: 中止
-- `e`: エディタで編集してからコミット
+- upstream が未設定の場合は `git push -u origin <branch>` で自動設定
+- PR は作成しません（PR を作りたい場合は `ai-git pr` を使用）
 
-### PR作成
+確認プロンプトで操作を選択できます。
 
-1. ブランチで作業してコミット
+| 入力 | 動作 |
+|------|------|
+| `y` | そのままコミット & プッシュ |
+| `n` | 中止 |
+| `e` | エディタで編集してからコミット & プッシュ |
 
 ```bash
-git checkout -b feature/new-feature
-git add .
-ai-git commit
+# ステージ済みの差分のみ使う
+ai-git push --no-add
 ```
 
-2. PR説明文を生成してPR作成
+### PR 作成
 
 ```bash
 ai-git pr
-
-# 言語指定も可能
-ai-git pr --lang en
 ```
 
-`ai-git pr` は自動的に以下を実行します:
+自動的に以下を実行します。
+
+- ブランチがまだ push されていない場合: `git push -u origin <branch>`
+- ローカルに新しいコミットがある場合: `git push`
+- PR 説明文を生成して PR を作成
+
+確認プロンプトで操作を選択できます。
 
-- ブランチがまだpushされていない場合、`git push -u origin <branch>` を実行
-- ローカルに新しいコミットがある場合、`git push` を実行
-- PR説明文を生成してPRを作成
+| 入力 | 動作 |
+|------|------|
+| `y` | PR を作成 |
+| `n` | 中止 |
+| `e` | エディタで編集してから作成 |
 
-3. 確認プロンプトで選択
+**生成される PR 説明文の形式:**
 
-- `y`: PRを作成
-- `n`: 中止
-- `e`: エディタで編集してから作成
+```markdown
+## Summary
+変更の全体像を 2〜3 文で説明
+
+## Changes
+- 具体的な変更内容（3〜7 項目）
+
+## Test plan
+- テスト・確認方法（2〜4 項目）
+```
 
 **前提条件:**
 
 - GitHub CLI (`gh`) がインストール済み ([インストール方法](https://cli.github.com/))
 - `gh auth login` で認証済み
 
-**生成されるPR説明文のフォーマット:**
-
-- ## Summary: 変更の概要（2-3文）
-- ## Changes: 具体的な変更内容（箇条書き）
-- ## Test plan: テスト方法（箇条書き）
-
 ### ブランチ作成（自動命名）
 
 変更差分（ステージ済み + 未ステージ）からブランチ名を推定して作成します。
@@ -126,21 +156,48 @@ ai-git checkout
 
 命名例:
 
-- `feat/auth-login-flow`
-- `fix/api-error-handling`
-- `docs/readme-update`
+```
+feat/google-login
+fix/api-error-handling
+docs/readme-update
+```
+
+### 言語設定
+
+デフォルト言語は日本語です。
+
+```bash
+# 今回だけ英語で生成
+ai-git commit --lang en
+ai-git pr --lang en
+
+# デフォルト言語を永続化
+ai-git --set-lang en
+ai-git --set-lang ja
+```
 
-推定できない場合は `feat/update-xxxxxx` のような名前を自動で使います。
+### ヘルプ
+
+```bash
+ai-git --help
+```
 
 ## 開発
 
 ```bash
-npm run dev
+npm install
 npm run build
+npm link   # どの Git リポジトリでも ai-git が使えるようになります
+```
+
+```bash
+npm run dev
 ```
 
 ## トラブルシューティング
 
-- `No staged changes found. Run \`git add\` first.`: `git add` してから実行
-- `GROQ_API_KEY が未設定です`: `GROQ_API_KEY` を設定
-- `413 Request too large` / `TPM` 超過: `git add -p` でステージを分割
+| エラー | 対処 |
+|--------|------|
+| `No staged changes found.` | `git add` してから実行 |
+| `GROQ_API_KEY が未設定です` | `GROQ_API_KEY` を設定 |
+| `413 Request too large` / TPM 超過 | `git add -p` でステージを分割 |

package/dist/index.js

@@ -51,6 +51,7 @@ const subcommandArgs = args.slice(1);
 const showHelp = args.includes("--help") || args.includes("-h") || subcommand === "help";
 const setLangArg = getOptionValue(args, "--set-lang");
 const langArg = getOptionValue(subcommandArgs, "--lang");
+const noAdd = subcommandArgs.includes("--no-add");
 const CONFIG_DIR = path.join(os.homedir(), ".ai-commit");
 const CONFIG_PATH = path.join(CONFIG_DIR, "config.json");
 const defaultGroqModel = "llama-3.1-8b-instant";
@@ -73,11 +74,13 @@ Usage: ai-git <command> [options]
 
 Commands:
   commit            Generate commit message from staged changes
+  push              Commit with AI message and push to remote (git add . + commit + push)
   pr                Generate PR description and create pull request
   checkout          Create branch from current changes
 
 Commit Options:
   --lang <ja|en>    Set language for this run
+  --no-add          Skip automatic git add .
 
 PR Options:
   --lang <ja|en>    Set language for this run
@@ -93,8 +96,11 @@ Environment:
     process.exit(0);
 }
 if (!subcommand ||
-    (subcommand !== "commit" && subcommand !== "pr" && subcommand !== "checkout")) {
-    console.error("Error: Please specify a command: 'commit', 'pr' or 'checkout'");
+    (subcommand !== "commit" &&
+        subcommand !== "push" &&
+        subcommand !== "pr" &&
+        subcommand !== "checkout")) {
+    console.error("Error: Please specify a command: 'commit', 'push', 'pr' or 'checkout'");
     console.error("Run 'ai-git --help' for usage information");
     process.exit(1);
 }
@@ -114,17 +120,69 @@ async function generateCommitMessage(diff) {
     const inputDiff = truncateByChars(diff, COMMIT_DIFF_COMPACT_CHARS);
     const prompt = buildPrompt(inputDiff, language);
     try {
-        return await generateText(prompt);
+        const raw = await generateText(prompt);
+        return normalizeGeneratedCommitMessage(raw, diff, language);
     }
     catch (error) {
         if (isRequestTooLargeError(error)) {
             const smallerDiff = truncateByChars(diff, 1800);
-            return generateText(buildPrompt(smallerDiff, language));
+            const retryRaw = await generateText(buildPrompt(smallerDiff, language));
+            return normalizeGeneratedCommitMessage(retryRaw, diff, language);
         }
         handleGroqError(error);
         process.exit(1);
     }
 }
+function normalizeGeneratedCommitMessage(raw, diff, lang) {
+    const lines = raw
+        .split("\n")
+        .map((line) => line.replace(/\s+$/g, ""))
+        .filter((_, idx, arr) => !(idx > 0 && arr[idx - 1] === "" && arr[idx] === ""));
+    if (lines.length === 0) {
+        return buildFallbackCommitMessage(diff, lang);
+    }
+    const subjectLine = lines[0]?.trim() || "";
+    const conventionalMatch = /^[a-z]+(\([^)]+\))?:\s+(.+)$/.exec(subjectLine);
+    const hasConventionalPrefix = Boolean(conventionalMatch);
+    const shortDescription = conventionalMatch?.[2]?.trim() || subjectLine;
+    if (!hasConventionalPrefix ||
+        looksLikePathOnly(shortDescription) ||
+        shortDescription.length < 8) {
+        lines[0] = buildFallbackSubjectLine(diff, lang);
+    }
+    return lines.join("\n").trim();
+}
+function looksLikePathOnly(value) {
+    const normalized = value.trim().toLowerCase();
+    if (!normalized) {
+        return false;
+    }
+    const hasPathToken = normalized.includes("/") || normalized.includes(".");
+    return hasPathToken && /^[a-z0-9/_\-.]+$/.test(normalized);
+}
+function buildFallbackCommitMessage(diff, lang) {
+    const subject = buildFallbackSubjectLine(diff, lang);
+    if (lang === "ja") {
+        return `${subject}\n\n- 差分の主目的を明確にし、変更理由が伝わる形に整える`;
+    }
+    return `${subject}\n\n- Clarify the main change intent so the reason is easy to understand`;
+}
+function buildFallbackSubjectLine(diff, lang) {
+    const files = getChangedFiles();
+    const type = inferBranchType(files, diff);
+    const rawTopic = inferTopic(files, diff);
+    const topic = rawTopic ? rawTopic.replace(/-/g, " ") : "";
+    if (lang === "ja") {
+        const description = topic
+            ? `${topic} の変更意図を分かりやすく整理する`
+            : "変更意図が伝わるように更新内容を整理する";
+        return `${type}: ${description}`;
+    }
+    const description = topic
+        ? `clarify the intent behind ${topic} changes`
+        : "clarify update intent in one clear sentence";
+    return `${type}: ${description}`;
+}
 function buildPrompt(diff, lang) {
     if (lang === "ja") {
         return `あなたは git のコミットメッセージ作成の専門家です。
@@ -208,6 +266,13 @@ function doCommit(message) {
         process.exit(1);
     }
 }
+function stageAllChanges() {
+    const result = (0, child_process_1.spawnSync)("git", ["add", "."], { stdio: "inherit" });
+    if (result.status !== 0) {
+        console.error("Error: git add . failed");
+        process.exit(1);
+    }
+}
 async function mainCheckout() {
     const suggested = await suggestBranchName();
     const branchName = ensureAvailableBranchName(suggested);
@@ -428,15 +493,11 @@ function branchExists(name) {
         return false;
     }
 }
-// ── メイン ───────────────────────────────────────────────
-async function main() {
-    if (subcommand === "checkout") {
-        await mainCheckout();
-        return;
-    }
-    if (subcommand === "pr") {
-        await mainPR();
-        return;
+// ── コミットフロー共通処理 ────────────────────────────────
+async function runCommitFlow() {
+    if (!noAdd) {
+        console.log("📦 変更をステージしています... (git add .)");
+        stageAllChanges();
     }
     const diff = getStagedDiff();
     if (!diff.trim()) {
@@ -446,7 +507,6 @@ async function main() {
     console.log("🤖 コミットメッセージを生成中... (compact summary input)");
     const message = await generateCommitMessage(diff);
     console.log(`\n📝 Generated commit message:\n`);
-    // 詳細モードは複数行なのでインデントして表示
     message.split("\n").forEach((line) => {
         console.log(`  ${line}`);
     });
@@ -472,6 +532,53 @@ async function main() {
     doCommit(finalMessage);
     console.log(`\n✅ Committed successfully!`);
 }
+// ── push サブコマンド ─────────────────────────────────────
+async function mainPush() {
+    await runCommitFlow();
+    const currentBranch = (0, child_process_1.execSync)("git branch --show-current", {
+        encoding: "utf-8",
+    }).trim();
+    // upstream が設定済みか確認し、なければ -u origin で push
+    try {
+        (0, child_process_1.execSync)(`git rev-parse --abbrev-ref ${currentBranch}@{upstream}`, {
+            encoding: "utf-8",
+            stdio: "pipe",
+        });
+        console.log(`📤 push 中... (origin ${currentBranch})`);
+        const pushResult = (0, child_process_1.spawnSync)("git", ["push"], { stdio: "inherit" });
+        if (pushResult.status !== 0) {
+            console.error("❌ git push に失敗しました。");
+            process.exit(1);
+        }
+    }
+    catch {
+        console.log(`📤 push 中... (origin ${currentBranch} を新規作成)`);
+        const pushResult = (0, child_process_1.spawnSync)("git", ["push", "-u", "origin", currentBranch], {
+            stdio: "inherit",
+        });
+        if (pushResult.status !== 0) {
+            console.error("❌ git push に失敗しました。");
+            process.exit(1);
+        }
+    }
+    console.log(`\n✅ Push 完了!`);
+}
+// ── メイン ───────────────────────────────────────────────
+async function main() {
+    if (subcommand === "checkout") {
+        await mainCheckout();
+        return;
+    }
+    if (subcommand === "pr") {
+        await mainPR();
+        return;
+    }
+    if (subcommand === "push") {
+        await mainPush();
+        return;
+    }
+    await runCommitFlow();
+}
 main().catch((err) => {
     console.error("❌ 予期しないエラー:", err.message);
     process.exit(1);
@@ -690,16 +797,24 @@ function getBranchDiff(baseBranch) {
 function buildPRPrompt(commits, diff, lang) {
     if (lang === "ja") {
         return `あなたは GitHub の Pull Request 作成の専門家です。
-次のコミット履歴と差分から、PR の説明文を生成してください。
+次のコミット履歴と差分から、PR のタイトルと説明文を生成してください。
 
-ルール:
-- GitHub の標準フォーマットを使用する
-- ## Summary: 2-3文で変更の概要を説明
+出力フォーマット（必ずこの順番で出力してください）:
+1行目: Title: <Conventional Commits 形式のタイトル（72文字以内、日本語で）>
+2行目: 空行
+3行目以降: PR 説明文（以下の形式）
+
+説明文のルール:
+- ## Summary: 1-2文で変更の概要を説明
 - ## Changes: "- " で始まる箇条書き（3-7個）で具体的な変更内容
 - ## Test plan: テスト方法の箇条書き（2-4個）
 - 命令形を使う
 - WHATとWHYを重視し、HOWは最小限に
-- 出力はPR説明文のみ（余計な説明は不要）
+- 出力はタイトルとPR説明文のみ（余計な説明は不要）
+
+タイトルの例:
+Title: feat: push サブコマンドを追加する
+Title: fix: コミットメッセージ生成のエラーハンドリングを修正する
 
 コミット履歴:
 ${commits}
@@ -708,16 +823,24 @@ ${commits}
 ${diff}`;
     }
     return `You are an expert at writing GitHub Pull Request descriptions.
-Generate a PR description from the following commit history and diff.
+Generate a PR title and description from the following commit history and diff.
 
-Rules:
-- Use standard GitHub format
-- ## Summary: 2-3 sentences explaining the overall change
+Output format (in this exact order):
+Line 1: Title: <Conventional Commits title, max 72 chars>
+Line 2: empty line
+Line 3+: PR description in the following format
+
+Description rules:
+- ## Summary: 1-2 sentences explaining the overall change
 - ## Changes: bullet points (3-7 items) with "- " prefix detailing specific changes
 - ## Test plan: bullet points (2-4 items) describing how to test
 - Use imperative mood
 - Focus on WHAT and WHY, minimize HOW
-- Output ONLY the PR description, no extra explanation
+- Output ONLY the title line and PR description, no extra explanation
+
+Title examples:
+Title: feat: add push subcommand
+Title: fix: improve error handling in commit message generation
 
 Commit history:
 ${commits}
@@ -770,10 +893,51 @@ function isRequestTooLargeError(error) {
         lower.includes("tokens per minute") ||
         lower.includes("tpm"));
 }
+/**
+ * AI が出力した "Title: <text>" 行からタイトルを抽出する。
+ * 見つからない場合は description の先頭テキストからフォールバック。
+ */
+function extractPRTitle(raw) {
+    const firstLine = raw.split("\n")[0]?.trim() ?? "";
+    const titleMatch = /^Title:\s*(.+)$/i.exec(firstLine);
+    if (titleMatch?.[1]) {
+        return titleMatch[1].trim();
+    }
+    // フォールバック: Summary 直下の最初の文
+    const lines = raw
+        .split("\n")
+        .map((v) => v.trim())
+        .filter(Boolean);
+    const summaryIdx = lines.findIndex((l) => l.toLowerCase().startsWith("## summary"));
+    let candidate = summaryIdx >= 0
+        ? (lines.slice(summaryIdx + 1).find((l) => !l.startsWith("##")) ?? "")
+        : (lines.find((l) => !l.startsWith("#") && !l.startsWith("-")) ?? "");
+    candidate = candidate
+        .replace(/^this pull request\s+(is|does)\s*/i, "")
+        .replace(/^この\s*pull request\s*は、?/i, "")
+        .replace(/^このprは、?/i, "")
+        .replace(/\s+/g, " ")
+        .trim();
+    const sentenceCut = candidate.search(/[。.!?]/);
+    if (sentenceCut > 0) {
+        candidate = candidate.slice(0, sentenceCut);
+    }
+    return candidate || "Update project changes";
+}
+/**
+ * "Title: <text>" 行を description 本文から除いて返す。
+ */
+function stripTitleLine(raw) {
+    const lines = raw.split("\n");
+    if (/^Title:\s*/i.test(lines[0]?.trim() ?? "")) {
+        // Title 行と直後の空行を除去
+        return lines.slice(lines[1]?.trim() === "" ? 2 : 1).join("\n").trimStart();
+    }
+    return raw;
+}
 function createPR(description, baseBranch, fallbackURL) {
-    // Extract title from first non-header line
-    const lines = description.split("\n");
-    const titleLine = lines.find((l) => l.trim() && !l.startsWith("#")) || "Pull Request";
+    const titleLine = extractPRTitle(description);
+    const body = stripTitleLine(description);
     const result = (0, child_process_1.spawnSync)("gh", [
         "pr",
         "create",
@@ -782,7 +946,7 @@ function createPR(description, baseBranch, fallbackURL) {
         "--title",
         titleLine.trim(),
         "--body",
-        description,
+        body,
     ], { encoding: "utf-8", stdio: "pipe" });
     if (result.stdout) {
         process.stdout.write(result.stdout);
@@ -864,8 +1028,12 @@ async function mainPR() {
     }
     console.log(`🤖 PR説明文を生成中... (${baseBranch}...${currentBranch}) [compact summary input]`);
     const description = await generatePRDescription(baseBranch);
-    console.log(`\n📝 Generated PR description:\n`);
-    description.split("\n").forEach((line) => {
+    console.log(`\n📝 Generated PR:\n`);
+    console.log(`  Title: ${extractPRTitle(description)}`);
+    console.log();
+    stripTitleLine(description)
+        .split("\n")
+        .forEach((line) => {
         console.log(`  ${line}`);
     });
     console.log();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ai-git-tool",
-  "version": "1.0.0",
+  "version": "1.2.0",
   "description": "AI-powered git commit and PR description generator using Groq API",
   "main": "dist/index.js",
   "bin": {