ai-git-tool 1.2.0 → 1.4.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Imamura Kento
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+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 OR COPYRIGHT HOLDERS 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.

package/README.md

@@ -1,6 +1,8 @@
 # ai-git-tool
 
-Groq API を使って、ステージ済み差分からコミットメッセージと PR 説明文を自動生成する TypeScript 製 CLI です。
+AIを使って、ステージ済み差分からコミットメッセージと PR 説明文を自動生成する TypeScript 製 CLI です。
+
+<video src="https://github.com/user-attachments/assets/c3826580-eb80-409a-b3fc-cc19f006cceb" />　　
 
 ## セットアップ
 
@@ -41,7 +43,7 @@ echo 'export GROQ_API_KEY="your_api_key"' >> ~/.bashrc
 source ~/.bashrc
 ```
 
-任意でモデル指定も可能です（デフォルト: `llama-3.1-8b-instant`）。
+任意でモデル指定も可能です（デフォルト: `Llama 3.3 70B Versatile`）。
 
 ```bash
 # macOS / Linux / Git Bash
@@ -68,11 +70,11 @@ ai-git commit --no-add
 
 確認プロンプトで操作を選択できます。
 
-| 入力 | 動作 |
-|------|------|
-| `y` | そのままコミット |
-| `n` | 中止 |
-| `e` | エディタで編集してからコミット |
+| 入力 | 動作                           |
+| ---- | ------------------------------ |
+| `y`  | そのままコミット               |
+| `n`  | 中止                           |
+| `e`  | エディタで編集してからコミット |
 
 **生成されるコミットメッセージの形式（Conventional Commits）:**
 
@@ -97,11 +99,11 @@ ai-git push
 
 確認プロンプトで操作を選択できます。
 
-| 入力 | 動作 |
-|------|------|
-| `y` | そのままコミット & プッシュ |
-| `n` | 中止 |
-| `e` | エディタで編集してからコミット & プッシュ |
+| 入力 | 動作                                      |
+| ---- | ----------------------------------------- |
+| `y`  | そのままコミット & プッシュ               |
+| `n`  | 中止                                      |
+| `e`  | エディタで編集してからコミット & プッシュ |
 
 ```bash
 # ステージ済みの差分のみ使う
@@ -122,22 +124,25 @@ ai-git pr
 
 確認プロンプトで操作を選択できます。
 
-| 入力 | 動作 |
-|------|------|
-| `y` | PR を作成 |
-| `n` | 中止 |
-| `e` | エディタで編集してから作成 |
+| 入力 | 動作                       |
+| ---- | -------------------------- |
+| `y`  | PR を作成                  |
+| `n`  | 中止                       |
+| `e`  | エディタで編集してから作成 |
 
 **生成される PR 説明文の形式:**
 
 ```markdown
 ## Summary
-変更の全体像を 2〜3 文で説明
+
+変更の全体像を 1〜2 文で説明
 
 ## Changes
+
 - 具体的な変更内容（3〜7 項目）
 
 ## Test plan
+
 - テスト・確認方法（2〜4 項目）
 ```
 
@@ -196,8 +201,54 @@ npm run dev
 
 ## トラブルシューティング
 
-| エラー | 対処 |
-|--------|------|
-| `No staged changes found.` | `git add` してから実行 |
-| `GROQ_API_KEY が未設定です` | `GROQ_API_KEY` を設定 |
-| `413 Request too large` / TPM 超過 | `git add -p` でステージを分割 |
+### エラーメッセージについて
+
+ai-git は Git 初心者にも優しいエラーメッセージを表示します。エラーが発生した場合、以下の情報が表示されます：
+
+- **何が起こったか**（エラーの内容）
+- **なぜ起こったか**（原因）
+- **どうすればいいか**（解決方法）
+- **ai-git のどのコマンドが使えるか**（次のステップ）
+
+### よくあるエラーと対処法
+
+| エラー                                         | 原因                                       | 対処                                                                    |
+| ---------------------------------------------- | ------------------------------------------ | ----------------------------------------------------------------------- |
+| `ステージされた変更が見つかりません`           | コミットする変更がステージングエリアにない | `git add .` でステージ、または `ai-git push` を使用                     |
+| `GROQ_API_KEY が未設定です`                    | AI 機能に必要な API キーが設定されていない | [Groq Console](https://console.groq.com/keys) で API キーを取得して設定 |
+| `これは Git リポジトリではありません`          | Git が初期化されていないディレクトリで実行 | `git init` で初期化、または Git リポジトリに移動                        |
+| `GitHub CLI (gh) がインストールされていません` | PR 作成に必要な gh コマンドがない          | [GitHub CLI](https://cli.github.com/) をインストール                    |
+| `GitHub CLI の認証が必要です`                  | GitHub にログインしていない                | `gh auth login` で認証                                                  |
+| `ベースブランチを検出できませんでした`         | main/master/develop ブランチが存在しない   | リモートから取得: `git fetch origin`                                    |
+| `413 Request too large` / TPM 超過             | 差分が大きすぎる、またはレート制限         | 自動で縮小して再試行されます。それでも失敗する場合は少し待つ            |
+
+### Git の基本操作
+
+ai-git を使う前に、以下の Git コマンドを覚えておくと便利です：
+
+```bash
+# 現在の状態を確認
+git status
+
+# 変更をステージング
+git add <ファイル名>    # 特定のファイルだけ
+git add .              # すべての変更
+
+# コミット履歴を確認
+git log --oneline
+
+# ブランチの確認
+git branch -a
+
+# リモートの確認
+git remote -v
+```
+
+### 推奨ワークフロー
+
+Git 初心者の方は、以下の流れで使うのがおすすめです：
+
+1. **変更を加える** - ファイルを編集
+2. **状態を確認** - `git status` で変更を確認
+3. **コミット** - `ai-git commit` または `ai-git push`
+4. **PR 作成** - `ai-git pr`（必要に応じて）

package/dist/commands/checkout.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.runCheckoutCommand = runCheckoutCommand;
+const child_process_1 = require("child_process");
+const errors_js_1 = require("../utils/errors.js");
+const ai_js_1 = require("../services/ai.js");
+const branch_js_1 = require("../services/branch.js");
+/**
+ * checkout コマンドの実行
+ */
+async function runCheckoutCommand() {
+    const suggested = await (0, ai_js_1.suggestBranchName)();
+    const branchName = (0, branch_js_1.ensureAvailableBranchName)(suggested);
+    const result = (0, child_process_1.spawnSync)("git", ["checkout", "-b", branchName], {
+        stdio: "inherit",
+    });
+    if (result.status !== 0) {
+        (0, errors_js_1.showFriendlyError)("ブランチ作成に失敗しました", "git checkout -b コマンドが失敗しました（未コミットの変更がある可能性があります）", [
+            "現在の変更を確認: git status",
+            "変更をコミットしてから新しいブランチを作成する",
+            "変更を一時退避: git stash",
+            "または、変更を含めたままブランチを作成: git checkout -b <ブランチ名>",
+        ], [
+            "ai-git commit でまず変更をコミット",
+            "ai-git push でコミット＆プッシュしてから新しいブランチを作成",
+        ]);
+        process.exit(1);
+    }
+    console.log(`✅ ブランチを作成しました: ${branchName}`);
+}

package/dist/commands/commit.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.runCommitCommand = runCommitCommand;
+const git_js_1 = require("../utils/git.js");
+const ui_js_1 = require("../utils/ui.js");
+const errors_js_1 = require("../utils/errors.js");
+const ai_js_1 = require("../services/ai.js");
+/**
+ * commit コマンドの実行
+ */
+async function runCommitCommand(language, noAdd) {
+    if (!noAdd) {
+        console.log("📦 変更をステージしています... (git add .)");
+        (0, git_js_1.stageAllChanges)();
+    }
+    const diff = (0, git_js_1.getStagedDiff)();
+    if (!diff.trim()) {
+        (0, errors_js_1.showFriendlyError)("ステージされた変更が見つかりません", "コミットする変更がステージングエリアにありません", [
+            "変更したファイルを確認: git status",
+            "すべての変更をステージ: git add .",
+            "特定のファイルだけステージ: git add <ファイル名>",
+        ], [
+            "ai-git commit --no-add (手動で git add した後)",
+            "ai-git push (自動で git add してコミット＆プッシュ)",
+        ]);
+        process.exit(1);
+    }
+    console.log("🤖 コミットメッセージを生成中... (compact summary input)");
+    const message = await (0, ai_js_1.generateCommitMessage)(diff, language);
+    console.log(`\n📝 Generated commit message:\n`);
+    message.split("\n").forEach((line) => {
+        console.log(`  ${line}`);
+    });
+    console.log();
+    const answer = await (0, ui_js_1.askUser)("Use this message? [y/n/e(edit)]: ");
+    let finalMessage = message;
+    if (answer === "e" || answer === "edit") {
+        finalMessage = (0, ui_js_1.editInEditor)(message);
+        if (!finalMessage) {
+            console.log("Aborted: empty message.");
+            process.exit(0);
+        }
+        console.log(`\n✏️  Edited message:\n`);
+        finalMessage.split("\n").forEach((line) => {
+            console.log(`  ${line}`);
+        });
+        console.log();
+    }
+    else if (answer !== "y" && answer !== "yes") {
+        console.log("Aborted.");
+        process.exit(0);
+    }
+    (0, git_js_1.doCommit)(finalMessage);
+    console.log(`\n✅ Committed successfully!`);
+}

package/dist/commands/pr.js

@@ -0,0 +1,76 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.runPRCommand = runPRCommand;
+const git_js_1 = require("../utils/git.js");
+const ui_js_1 = require("../utils/ui.js");
+const errors_js_1 = require("../utils/errors.js");
+const github_js_1 = require("../services/github.js");
+const ai_js_1 = require("../services/ai.js");
+/**
+ * pr コマンドの実行
+ */
+async function runPRCommand(language) {
+    (0, github_js_1.checkGHCLI)(language);
+    (0, github_js_1.checkGHAuth)(language);
+    const baseBranch = (0, github_js_1.detectBaseBranch)(language);
+    const currentBranch = (0, git_js_1.getCurrentBranch)();
+    if (currentBranch === baseBranch) {
+        if (language === "ja") {
+            (0, errors_js_1.showFriendlyError)(`ベースブランチ (${baseBranch}) から PR を作成できません`, "PR は異なるブランチから作成する必要があります", [
+                "新しいブランチを作成してください",
+                "または、既存のブランチに切り替えてください: git checkout <ブランチ名>",
+            ], [
+                "ai-git checkout で新しいブランチを作成",
+                "ブランチ作成後に変更をコミット: ai-git commit",
+                "その後 PR を作成: ai-git pr",
+            ]);
+        }
+        else {
+            (0, errors_js_1.showFriendlyError)(`Cannot create PR from base branch (${baseBranch})`, "PRs must be created from a different branch", [
+                "Create a new branch",
+                "Or switch to an existing branch: git checkout <branch-name>",
+            ], [
+                "Use ai-git checkout to create a new branch",
+                "Commit changes after creating branch: ai-git commit",
+                "Then create PR: ai-git pr",
+            ]);
+        }
+        process.exit(1);
+    }
+    // ベースブランチとの同期（コンフリクトチェック・マージ）
+    await (0, github_js_1.syncWithBaseBranch)(baseBranch, currentBranch, language);
+    // ブランチをプッシュ
+    (0, github_js_1.pushBranchForPR)(currentBranch, language);
+    console.log(`🤖 PR説明文を生成中... (${baseBranch}...${currentBranch}) [compact summary input]`);
+    const description = await (0, ai_js_1.generatePRDescription)(baseBranch, language, github_js_1.getBranchDiff);
+    console.log(`\n📝 Generated PR:\n`);
+    console.log(`  Title: ${(0, ai_js_1.extractPRTitle)(description)}`);
+    console.log();
+    (0, ai_js_1.stripTitleLine)(description)
+        .split("\n")
+        .forEach((line) => {
+        console.log(`  ${line}`);
+    });
+    console.log();
+    const answer = await (0, ui_js_1.askUser)("Create PR with this description? [y/n/e(edit)]: ");
+    let finalDescription = description;
+    if (answer === "e" || answer === "edit") {
+        finalDescription = (0, ui_js_1.editInEditor)(description);
+        if (!finalDescription) {
+            console.log("Aborted: empty description.");
+            process.exit(0);
+        }
+        console.log(`\n✏️  Edited description:\n`);
+        finalDescription.split("\n").forEach((line) => {
+            console.log(`  ${line}`);
+        });
+        console.log();
+    }
+    else if (answer !== "y" && answer !== "yes") {
+        console.log("Aborted.");
+        process.exit(0);
+    }
+    const fallbackURL = (0, github_js_1.getPullRequestURL)(currentBranch);
+    (0, github_js_1.createPR)(finalDescription, baseBranch, fallbackURL, language, ai_js_1.extractPRTitle, ai_js_1.stripTitleLine);
+    console.log(`\n✅ PR created successfully!`);
+}

package/dist/commands/push.js

@@ -0,0 +1,78 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.runPushCommand = runPushCommand;
+const child_process_1 = require("child_process");
+const commit_js_1 = require("./commit.js");
+const git_js_1 = require("../utils/git.js");
+/**
+ * 未プッシュのコミットがあるかチェック
+ */
+function hasUnpushedCommits(currentBranch) {
+    try {
+        // upstream が設定されているかチェック
+        (0, child_process_1.execSync)(`git rev-parse --abbrev-ref ${currentBranch}@{upstream}`, {
+            encoding: "utf-8",
+            stdio: "pipe",
+        });
+        // upstream と比較
+        const localCommit = (0, child_process_1.execSync)(`git rev-parse ${currentBranch}`, {
+            encoding: "utf-8",
+            stdio: "pipe",
+        }).trim();
+        const remoteCommit = (0, child_process_1.execSync)(`git rev-parse ${currentBranch}@{upstream}`, {
+            encoding: "utf-8",
+            stdio: "pipe",
+        }).trim();
+        return localCommit !== remoteCommit;
+    }
+    catch {
+        // upstream が設定されていない場合、コミットがあればプッシュすべき
+        try {
+            const commitCount = (0, child_process_1.execSync)("git rev-list --count HEAD", {
+                encoding: "utf-8",
+                stdio: "pipe",
+            }).trim();
+            return parseInt(commitCount, 10) > 0;
+        }
+        catch {
+            return false;
+        }
+    }
+}
+/**
+ * push コマンドの実行
+ */
+async function runPushCommand(language, noAdd) {
+    const currentBranch = (0, git_js_1.getCurrentBranch)();
+    // ステージされた変更をチェック（--no-add の場合は git add をスキップ）
+    if (!noAdd) {
+        console.log("📦 変更をステージしています... (git add .)");
+        (0, git_js_1.stageAllChanges)();
+    }
+    const diff = (0, git_js_1.getStagedDiff)();
+    const hasStagedChanges = diff.trim().length > 0;
+    if (hasStagedChanges) {
+        // ステージされた変更がある場合は、通常のコミットフローを実行
+        await (0, commit_js_1.runCommitCommand)(language, true); // noAdd=true（すでにステージ済み）
+    }
+    else {
+        // ステージされた変更がない場合、未プッシュのコミットがあるかチェック
+        if (hasUnpushedCommits(currentBranch)) {
+            console.log("💡 ステージされた変更はありませんが、未プッシュのコミットがあります");
+            console.log("📤 コミットをプッシュします...");
+        }
+        else {
+            console.error("❌ プッシュするものがありません");
+            console.error("");
+            console.error("📋 原因: ステージされた変更も未プッシュのコミットもありません");
+            console.error("");
+            console.error("💡 解決方法:");
+            console.error("   1. 変更を確認: git status");
+            console.error("   2. 変更をステージ: git add .");
+            console.error("   3. または、まずコミット: ai-git commit");
+            process.exit(1);
+        }
+    }
+    (0, git_js_1.pushCurrentBranch)(currentBranch);
+    console.log(`\n✅ Push 完了!`);
+}