ai-git-tool 1.1.0 → 1.3.0

package/README.md

@@ -1,122 +1,154 @@
-# ai-git
+# ai-git-tool
 
 Groq API を使って、ステージ済み差分からコミットメッセージと PR 説明文を自動生成する TypeScript 製 CLI です。
 
-## 必要環境
-
-- Node.js `18` 以上
-- `git`
-- Groq API キー（`GROQ_API_KEY`）
-
 ## セットアップ
 
-### npm からインストール（推奨）
-
 ```bash
 npm install -g ai-git-tool
 ```
 
-### ローカル開発版をリンク
+### 環境変数
+
+API キーの取得先: [Groq Console](https://console.groq.com/keys)
+
+**macOS / Linux (bash/zsh):**
 
 ```bash
-npm install
-npm run build
-npm link
+export GROQ_API_KEY="your_api_key"
 ```
 
-`npm link` 後は、どの Git リポジトリでも `ai-git` が使えます。
+永続化する場合は `~/.bashrc` や `~/.zshrc` に追記してください。
 
-## 環境変数
+**Windows (コマンドプロンプト):**
 
-```bash
-export GROQ_API_KEY="your_api_key"
+```cmd
+setx GROQ_API_KEY "your_api_key"
 ```
 
-任意でモデル指定も可能です。
+**Windows (PowerShell):**
+
+```powershell
+[System.Environment]::SetEnvironmentVariable("GROQ_API_KEY", "your_api_key", "User")
+```
+
+> `setx` / `SetEnvironmentVariable` はユーザー環境変数として永続保存されます。設定後は**ターミナルを再起動**してください。
+
+**Windows (Git Bash):**
 
 ```bash
-export GROQ_MODEL="llama-3.1-8b-instant"
+echo 'export GROQ_API_KEY="your_api_key"' >> ~/.bashrc
+source ~/.bashrc
 ```
 
-API キーの取得先: [Groq Console](https://console.groq.com/keys)
+任意でモデル指定も可能です（デフォルト: `Llama 3.3 70B Versatile`）。
+
+```bash
+# macOS / Linux / Git Bash
+export GROQ_MODEL="llama-3.3-70b-versatile"
+
+# Windows コマンドプロンプト
+setx GROQ_MODEL "llama-3.3-70b-versatile"
+```
 
 ## 使い方
 
 ### コミットメッセージ生成
 
-1. コミットメッセージを生成
-
 ```bash
-# 通常（タイトル + 箇条書き本文）
 ai-git commit
 ```
 
-`ai-git commit` はデフォルトで `git add .` を実行してから生成します。
+デフォルトで `git add .` を実行してからコミットメッセージを生成します。
 
 ```bash
-# 自動 add を無効化（手動でステージした差分のみ使う）
+# 手動でステージした差分のみ使う
 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
 ```
 
-2. 確認プロンプトで選択
+`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 を作成
+
+確認プロンプトで操作を選択できます。
+
+| 入力 | 動作                       |
+| ---- | -------------------------- |
+| `y`  | PR を作成                  |
+| `n`  | 中止                       |
+| `e`  | エディタで編集してから作成 |
+
+**生成される PR 説明文の形式:**
+
+```markdown
+## Summary
+
+変更の全体像を 1〜2 文で説明
 
-- ブランチがまだpushされていない場合、`git push -u origin <branch>` を実行
-- ローカルに新しいコミットがある場合、`git push` を実行
-- PR説明文を生成してPRを作成
+## Changes
 
-3. 確認プロンプトで選択
+- 具体的な変更内容（3〜7 項目）
 
-- `y`: PRを作成
-- `n`: 中止
-- `e`: エディタで編集してから作成
+## Test plan
+
+- テスト・確認方法（2〜4 項目）
+```
 
 **前提条件:**
 
 - GitHub CLI (`gh`) がインストール済み ([インストール方法](https://cli.github.com/))
 - `gh auth login` で認証済み
 
-**生成されるPR説明文のフォーマット:**
-
-- ## Summary: 変更の概要（2-3文）
-- ## Changes: 具体的な変更内容（箇条書き）
-- ## Test plan: テスト方法（箇条書き）
-
 ### ブランチ作成（自動命名）
 
 変更差分（ステージ済み + 未ステージ）からブランチ名を推定して作成します。
@@ -127,21 +159,94 @@ 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` でステージを分割
+### エラーメッセージについて
+
+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,74 @@
+"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);
+    }
+    // ブランチをプッシュ
+    (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 完了!`);
+}