Git Souji
English
A VS Code extension for cleaning up Git branches (detect and delete dead/stale/gone branches, with full branch management). "Souji" means "cleaning" in Japanese.
- Command: Git Souji: Open (
gitsouji.openCleaner)
- You can also launch it from the SCM (Source Control) view title bar.
Features
Branch Cleaner Webview
- Shows Local Branches / Remote Branches with status badges (merged/stale/gone)
- Search bar: Filter branches by name (supports case sensitivity and regex)
- Settings button: Quick access to extension settings
- Local:
- Checkout
- Log (opens
git log --oneline --graph --decorate in a terminal)
- Rename (not allowed for protected branches)
- Delete (not allowed for protected branches; confirmation/force are configurable)
- Merge into current (merge into current branch; protected branches cannot be selected)
- Remote:
- Checkout (creates a local tracking branch if it doesn't exist)
- Log
- Delete Remote (not allowed for protected branches)
- Merged: Find and delete branches already merged into the base branch
- Stale: Find and delete branches with no commits for N days (configurable)
- Gone: Find and delete branches whose upstream was deleted
- Cleanup All: Combine all three detections for bulk cleanup
Select Mode
- Toggle select mode to manually pick branches for deletion
- Works for both local and remote branches
- Shows selected count and allows bulk deletion
Force Delete Confirmation
- When deleting unmerged branches (e.g., stale), shows confirmation dialog to force delete
- Also confirms when deleting remote branches with the same name as local (untracked)
Requirements
- Git must be available (
git command executable)
Usage
- Open a folder containing a Git repository in VS Code
- Run Git Souji: Open from the Command Palette
- Or run it from the SCM view menu
- Use the buttons in the webview
Extension Settings
Example settings.json:
{
"gitSouji.baseBranch": "auto",
"gitSouji.staleDays": 30,
"gitSouji.autoFetchPrune": false,
"gitSouji.protectedBranches": ["main", "master", "develop", "release/*"],
"gitSouji.confirmBeforeDelete": true,
"gitSouji.forceDeleteLocal": false,
"gitSouji.allowRemoteBranchDeletion": false,
"gitSouji.includeRemoteInDeadCleanup": false,
"gitSouji.showStatusBadges": true
}
Detection Settings
gitSouji.baseBranch: Base branch for merged-branch detection. Set to auto to use origin/HEAD, or fallback to main/master/develop.gitSouji.staleDays: Number of days since last commit to consider a branch as stale (default: 30).gitSouji.autoFetchPrune: Run git fetch --prune automatically before detecting gone branches.
Protection Settings
gitSouji.protectedBranches: Branches excluded from delete, rename, and merge-source actions. Supports glob patterns (e.g., release/*).
Deletion Settings
gitSouji.confirmBeforeDelete: Show confirmation dialog before delete operations.gitSouji.forceDeleteLocal: Use git branch -D (force) instead of git branch -d when deleting local branches.gitSouji.allowRemoteBranchDeletion: Enable remote branch deletion buttons and cleanup (default: false).gitSouji.includeRemoteInDeadCleanup: Also delete corresponding remote branches when cleaning up local branches.
Display Settings
gitSouji.showStatusBadges: Show merged/stale/gone status badges in the branch list.
Implementation Notes
- The webview HTML is at
media/branchManager.html. CSP/nonce are injected at runtime.
- The core TypeScript logic is in
src/app.ts.
Known Issues
- You may see
Error mutex already exists in test logs; vscode-test can still exit with code 0 (possible VS Code process contention on the machine).
Development
npm install
npm test
日本語
Git ブランチの整理（掃除）に特化した VS Code 拡張です（デッド/古い/削除済みリモートのブランチ検出・削除、その他ブランチ管理機能）。
- コマンド: Git Souji: 開く (
gitsouji.openCleaner)
- SCMビュー（Source Control）のタイトルバーからも起動できます
Features
Branch Cleaner Webview
- Local Branches / Remote Branches をステータスバッジ（マージ済み/古い/削除済み）付きで一覧表示
- 検索バー: ブランチ名でフィルタリング（大文字小文字区別・正規表現対応）
- 設定ボタン: 拡張機能の設定に素早くアクセス
- Local:
- Checkout
- Log（ターミナルで
git log --oneline --graph --decorate を開く）
- Rename（保護ブランチは不可）
- Delete（保護ブランチは不可・設定で確認/force制御）
- Merge into current（現在ブランチへマージ。保護ブランチは不可）
- Remote:
- Checkout（追跡ローカルが無ければ作成してcheckout）
- Log
- Delete Remote（保護ブランチは不可）
整理ツールバー
- Merged: ベースブランチにマージ済みのブランチを検出・削除
- Stale: N日間コミットがないブランチを検出・削除（日数は設定可能）
- Gone: 上流が削除されたブランチを検出・削除
- Cleanup All: 3種類すべての検出をまとめて実行
選択モード
- 選択モードをオンにして、削除するブランチを手動で選択
- ローカル・リモート両方で使用可能
- 選択件数を表示し、一括削除が可能
強制削除確認
- マージされていないブランチ（例: 古いブランチ）を削除する際、強制削除の確認ダイアログを表示
- 同名のリモートブランチ（未追跡）を削除する際も確認を表示
Requirements
- Git が利用可能であること（
git コマンドが実行できる）
Usage
- Gitリポジトリを含むフォルダをVS Codeで開く
- コマンドパレットで Git Souji: 開く を実行
- Webview上のボタンで操作
Extension Settings
settings.json 例：
{
"gitSouji.baseBranch": "auto",
"gitSouji.staleDays": 30,
"gitSouji.autoFetchPrune": false,
"gitSouji.protectedBranches": ["main", "master", "develop", "release/*"],
"gitSouji.confirmBeforeDelete": true,
"gitSouji.forceDeleteLocal": false,
"gitSouji.allowRemoteBranchDeletion": false,
"gitSouji.includeRemoteInDeadCleanup": false,
"gitSouji.showStatusBadges": true
}
検出設定
gitSouji.baseBranch: マージ済みブランチ検出の基準ブランチ。auto の場合は origin/HEAD を使用し、無ければ main/master/develop を順に探索。gitSouji.staleDays: 最終コミットから何日経過したブランチを「古い」と見なすか（デフォルト: 30）。gitSouji.autoFetchPrune: Gone ブランチ検出前に git fetch --prune を自動実行。
保護設定
gitSouji.protectedBranches: 削除・リネーム・マージ元指定の対象外とするブランチ。glob パターン対応（例: release/*）。
削除設定
gitSouji.confirmBeforeDelete: 削除操作前に確認ダイアログを表示。gitSouji.forceDeleteLocal: ローカルブランチ削除時に git branch -D（強制）を使用。gitSouji.allowRemoteBranchDeletion: リモートブランチの削除ボタンと整理機能を有効にする（デフォルト: false）。gitSouji.includeRemoteInDeadCleanup: ローカルブランチ整理時に、対応するリモートブランチも削除。
表示設定
gitSouji.showStatusBadges: ブランチ一覧にマージ済み/古い/削除済みのステータスバッジを表示。
Implementation Notes
- WebviewのHTMLは
media/branchManager.html に置いてあり、起動時にCSP/nonceを差し込んで読み込みます。
- TypeScript側のメインロジックは
src/app.ts に集約しています。
Known Issues
- テスト実行ログに
Error mutex already exists が出る場合がありますが、vscode-test 自体は Exit code 0 で完了します（環境上の既存VS Codeプロセス競合の可能性）。
Development
npm install
npm test
If you find a bug or have a feature request, please open an issue.
