feat(hooks): add preRemoveCmd lifecycle hook (#50)

danielrose7 · claude · web-flow · commit dbf815561c73 · 2026-04-15T05:00:05.000+08:00
* feat(hooks): add preRemoveCmd lifecycle hook

Mirrors the postCreateCmd pattern but runs before worktree removal.
The command executes inside the worktree directory and supports the
same $BASE_PATH / $WORKTREE_PATH variables. If it fails or is
cancelled, removal is aborted so users can react to cleanup errors
(for example, tearing down a per-worktree database).

* feat(l10n): add translations for preRemoveCmd strings

Add zh-cn, zh-tw, and ja translations for the three new
vscode.l10n.t() strings in preRemoveWorktree.ts.

Co-Authored-By: Claude Opus 4.6 (1M context) &lt;noreply@anthropic.com&gt;

---------

Co-authored-by: Claude Opus 4.6 (1M context) &lt;noreply@anthropic.com&gt;
diff --git a/README.md b/README.md
@@ -103,6 +103,14 @@ Customize Git Worktree Manager to fit your workflow:
   (for example, installing dependencies or running setup scripts).  
   **Example:** `"pnpm install"` or `"echo 'Worktree ready'"`
 
+- **`git-worktree-manager.preRemoveCmd`**  
+  Run a command automatically before a worktree is removed  
+  (for example, tearing down side effects such as a per-worktree database  
+  schema or stopping services).  
+  Runs inside the worktree directory. If the command fails or is cancelled,  
+  the removal is aborted.  
+  **Example:** `"pnpm run worktree:teardown-db"`
+
 - **`terminal.external.windowsExec`**  
   Set the external terminal on Windows  
   (e.g. `"C:\\Program Files\\Git\\bin\\bash.exe"` for Git Bash).
diff --git a/README.zh-CN.md b/README.zh-CN.md
@@ -102,6 +102,12 @@ Git Worktree Manager 将 worktree 管理能力直接集成到 VS Code 中，
   （例如安装依赖或运行初始化脚本）。  
   **示例:** `"pnpm install"` 或 `"echo 'Worktree 已就绪'"`
 
+- **`git-worktree-manager.preRemoveCmd`**  
+  在删除 worktree 前自动执行的命令  
+  （例如清理 worktree 产生的副作用，如每个 worktree 专属的数据库 schema，或停止服务）。  
+  命令在 worktree 目录内执行。若命令失败或被取消，则中止删除。  
+  **示例:** `"pnpm run worktree:teardown-db"`
+
 - **`terminal.external.windowsExec`**  
   设置 Windows 系统下的外部终端  
   （例如 Git Bash: `"C:\\Program Files\\Git\\bin\\bash.exe"`）。
diff --git a/l10n/bundle.l10n.ja.json b/l10n/bundle.l10n.ja.json
@@ -150,5 +150,8 @@
     "Delete": "削除",
     "Prune": "整理",
     "Remove": "削除",
-    "Running post-create command...": "post-create コマンドを実行中..."
+    "Running post-create command...": "post-create コマンドを実行中...",
+    "Running pre-remove command...": "pre-remove コマンドを実行中...",
+    "Pre-remove command was cancelled": "pre-remove コマンドがキャンセルされました",
+    "Pre-remove command failed: {0}": "pre-remove コマンドが失敗しました：{0}"
 }
diff --git a/l10n/bundle.l10n.zh-cn.json b/l10n/bundle.l10n.zh-cn.json
@@ -150,5 +150,8 @@
     "Delete": "删除",
     "Prune": "清理",
     "Remove": "移除",
-    "Running post-create command...": "正在运行 post-create 命令..."
+    "Running post-create command...": "正在运行 post-create 命令...",
+    "Running pre-remove command...": "正在运行 pre-remove 命令...",
+    "Pre-remove command was cancelled": "pre-remove 命令已取消",
+    "Pre-remove command failed: {0}": "pre-remove 命令失败：{0}"
 }
diff --git a/l10n/bundle.l10n.zh-tw.json b/l10n/bundle.l10n.zh-tw.json
@@ -150,5 +150,8 @@
     "Delete": "刪除",
     "Prune": "清理",
     "Remove": "移除",
-    "Running post-create command...": "正在運行 post-create 命令..."
+    "Running post-create command...": "正在運行 post-create 命令...",
+    "Running pre-remove command...": "正在運行 pre-remove 命令...",
+    "Pre-remove command was cancelled": "pre-remove 命令已取消",
+    "Pre-remove command failed: {0}": "pre-remove 命令失敗：{0}"
 }
diff --git a/package.json b/package.json
@@ -960,9 +960,15 @@
             "default": "",
             "markdownDescription": "%config.postCreateCmd.description%"
           },
-          "git-worktree-manager.terminalNameTemplate": {
+          "git-worktree-manager.preRemoveCmd": {
             "order": 14,
             "type": "string",
+            "default": "",
+            "markdownDescription": "%config.preRemoveCmd.description%"
+          },
+          "git-worktree-manager.terminalNameTemplate": {
+            "order": 15,
+            "type": "string",
             "default": "$LABEL ⇄ $FULL_PATH",
             "markdownDescription": "%config.terminalNameTemplate.description%"
           }
diff --git a/package.nls.ja.json b/package.nls.ja.json
@@ -104,6 +104,7 @@
     "config.worktreeSubdirectoryTemplate.description": "ワークツリーサブディレクトリ名のテンプレートです。使用可能な変数：\n\n- `$BASE_NAME`（リポジトリフォルダ名）\n- `$INDEX`（増分番号）。\n- `$REF_NAME` （参照名、ブランチ名やタグ名など）\n\n使用できない文字：/ \\ : * ? \" < > |",
     "config.worktreeSubdirectoryTemplate.patternErrorMessage": "テンプレートに次の文字は使用できません：/ \\ : * ? \" < > |",
     "config.postCreateCmd.description": "ワークツリー作成後に実行するコマンド。デフォルトでは、新しいワークツリーのディレクトリ内で実行されます。コマンドで使用できる変数：\n\n- `$BASE_PATH`：ワークツリーの完全パス\n- `$WORKTREE_PATH`：ワークツリーの完全パス\n- `$BASE_NAME`：ワークツリーのフォルダ名\n\n例：\n`git submodule update --init --recursive`",
+    "config.preRemoveCmd.description": "ワークツリー削除前に実行するコマンド。ワークツリーのディレクトリ内で実行されます。コマンドが失敗またはキャンセルされた場合、削除は中止されます。コマンドで使用できる変数：\n\n- `$BASE_PATH`：メインリポジトリの完全パス\n- `$WORKTREE_PATH`：削除対象ワークツリーの完全パス\n\n例：\n`pnpm run worktree:teardown-db`",
     "config.worktreeDescriptionTemplate.description": "ワークツリーの説明テンプレートです。使用可能な変数：\n\n- `$FULL_PATH`：ワークツリーの完全パス\n- `$BASE_NAME`：ワークツリーのフォルダ名\n- `$RELATIVE_PATH`：相対パス（メインリポジトリのルートからの相対パス）",
     "config.terminalNameTemplate.description": "内蔵ターミナルの名称テンプレートです。使用可能な変数：\n\n- `$FULL_PATH`：フォルダの完全パス\n- `$BASE_NAME`：フォルダ名\n- `$LABEL`：表示名、フォルダ名またはワークツリーの表示名"
 }
diff --git a/package.nls.json b/package.nls.json
@@ -104,6 +104,7 @@
     "config.worktreeSubdirectoryTemplate.description": "Template for worktree subdirectory names. Available variables:\n\n- `$BASE_NAME` (repo folder name)\n- `$INDEX` (incrementing number).\n- `$REF_NAME` (reference name, such as branch name, tag name)\n\nCannot contain characters: / \\ : * ? \" < > |",
     "config.worktreeSubdirectoryTemplate.patternErrorMessage": "Template cannot contain characters: / \\ : * ? \" < > |",
     "config.postCreateCmd.description": "Command to execute after creating a worktree. The default execution path is the directory of the newly created worktree. You can use the following variables in the command:\n\n- `$BASE_PATH`: The full path of the worktree.\n- `$WORKTREE_PATH`: The full path of the worktree.\n\nExample:\n`git submodule update --init --recursive`",
+    "config.preRemoveCmd.description": "Command to execute before removing a worktree. Runs inside the worktree directory. If the command fails or is cancelled, removal is aborted. You can use the following variables in the command:\n\n- `$BASE_PATH`: The full path of the main repository.\n- `$WORKTREE_PATH`: The full path of the worktree being removed.\n\nExample:\n`pnpm run worktree:teardown-db`",
     "config.worktreeDescriptionTemplate.description": "Template for the worktree description. Available variables:\n\n- `$FULL_PATH`: The full path of the worktree.\n- `$BASE_NAME`: The folder name of the worktree.\n- `$RELATIVE_PATH`: The relative path (relative to the main repo directory).",
     "config.terminalNameTemplate.description": "Template for the terminal name. Available variables:\n\n- `$FULL_PATH`: The full path of the folder.\n- `$BASE_NAME`: The folder name.\n- `$LABEL`: The display name, the folder name or the worktree display name."
 }
diff --git a/package.nls.zh-cn.json b/package.nls.zh-cn.json
@@ -104,6 +104,7 @@
     "config.worktreeSubdirectoryTemplate.description": "Worktree 子目录名称的模板。可用的变量：\n\n- `$BASE_NAME`（仓库文件夹名称）\n- `$INDEX`（递增数字）。\n- `$REF_NAME` （引用名称，如分支名、标签名）\n\n不能包含字符：/ \\ : * ? \" < > |",
     "config.worktreeSubdirectoryTemplate.patternErrorMessage": "模板不能包含以下字符：/ \\ : * ? \" < > |",
     "config.postCreateCmd.description": "创建 Worktree 后执行的命令，默认执行路径是新创建的 Worktree 的目录内。你可以在命令中使用以下变量：\n\n- `$BASE_PATH`：仓库的完整路径。\n- `$WORKTREE_PATH`：Worktree 的完整路径。\n\n示例：\n`git submodule update --init --recursive`",
+    "config.preRemoveCmd.description": "删除 Worktree 前执行的命令，在 Worktree 目录内执行。如果命令执行失败或被取消，则中止删除操作。你可以在命令中使用以下变量：\n\n- `$BASE_PATH`：主仓库的完整路径。\n- `$WORKTREE_PATH`：即将被删除的 Worktree 的完整路径。\n\n示例：\n`pnpm run worktree:teardown-db`",
     "config.worktreeDescriptionTemplate.description": "Worktree 描述的模板。可用的变量：\n\n- `$FULL_PATH`：Worktree 的完整路径。\n- `$BASE_NAME`：Worktree 的文件夹名称。\n- `$RELATIVE_PATH`：相对路径（相对于主仓库目录）。",
     "config.terminalNameTemplate.description": "打开内置终端时显示的名称模板。可用的变量：\n\n- `$FULL_PATH`：文件夹的完整路径。\n- `$BASE_NAME`：文件夹名称。\n- `$LABEL`：展示的名称、文件夹名称或者 Worktree 展示的名称"
 }
diff --git a/package.nls.zh-tw.json b/package.nls.zh-tw.json
@@ -104,6 +104,7 @@
     "config.worktreeSubdirectoryTemplate.description": "Worktree 子目錄名稱的模板。可用的變數：\n\n- `$BASE_NAME`（倉庫資料夾名稱）\n- `$INDEX`（遞增數字）。\n- `$REF_NAME` （引用名稱，如分支名、標籤名）\n\n不能包含字元：/ \\ : * ? \" < > |",
     "config.worktreeSubdirectoryTemplate.patternErrorMessage": "範本不能包含以下字元：/ \\ : * ? \" < > |",
     "config.postCreateCmd.description": "建立 Worktree 後執行的命令。預設執行路徑是新建立的 Worktree 的目錄內。你可以在命令中使用以下變數：\n\n- `$BASE_PATH`：Worktree 的完整路徑。\n- `$WORKTREE_PATH`：Worktree 的完整路徑。\n\n範例：\n`git submodule update --init --recursive`",
+    "config.preRemoveCmd.description": "移除 Worktree 前執行的命令，在 Worktree 目錄內執行。若命令執行失敗或被取消，則中止移除。你可以在命令中使用以下變數：\n\n- `$BASE_PATH`：主倉庫的完整路徑。\n- `$WORKTREE_PATH`：即將被移除的 Worktree 的完整路徑。\n\n範例：\n`pnpm run worktree:teardown-db`",
     "config.worktreeDescriptionTemplate.description": "Worktree 描述的模板。可用的變數：\n\n- `$FULL_PATH`：Worktree 的完整路徑。\n- `$BASE_NAME`：Worktree 的資料夾名稱。\n- `$RELATIVE_PATH`：相對路徑（相對於主倉庫目錄）。",
     "config.terminalNameTemplate.description": "開啟內建終端機時顯示的名稱模板。可用的變數：\n\n- `$FULL_PATH`：資料夾的完整路徑。\n- `$BASE_NAME`：資料夾名稱。\n- `$LABEL`：展示的名稱、資料夾名稱或者 Worktree 展示的名稱"
 }
diff --git a/src/core/command/removeWorktreeCmd.ts b/src/core/command/removeWorktreeCmd.ts
@@ -10,6 +10,7 @@ import logger from '@/core/log/logger';
 import { Config } from '@/core/config/setting';
 import { actionProgressWrapper } from '@/core/ui/progress';
 import { withResolvers } from '@/core/util/promise';
+import { preRemoveWorktree } from '@/core/util/preRemoveWorktree';
 import { IBranchForWorktree, IWorktreeLess } from '@/types';
 
 async function showDeleteConfirmation(worktreePath: string): Promise<'remove' | 'force' | undefined> {
@@ -54,6 +55,9 @@ export const removeWorktreeCmd = async (item?: IWorktreeLess): Promise<void> =>
         const needDeleteBranch = Config.get('promptDeleteBranchAfterWorktreeDeletion', false);
         const mainFolder = await getMainFolder(worktreePath);
 
+        // Run user-configured pre-remove command. If it fails, abort removal.
+        await preRemoveWorktree({ worktreePath, basePath: mainFolder });
+
         actionProgressWrapper(
             vscode.l10n.t('Removing worktree {path}', { path: worktreePath }),
             () => promise,
diff --git a/src/core/config/setting.ts b/src/core/config/setting.ts
@@ -71,6 +71,9 @@ export class Config {
 
     // Post-creation command configuration
     static get(key: 'postCreateCmd', defaultValue: ''): string;
+
+    // Pre-removal command configuration
+    static get(key: 'preRemoveCmd', defaultValue: ''): string;
     /**
      * Get configuration value
      * @param key Configuration key name
diff --git a/src/core/util/preRemoveWorktree.ts b/src/core/util/preRemoveWorktree.ts
@@ -0,0 +1,69 @@
+import * as vscode from 'vscode';
+import { Config } from '@/core/config/setting';
+import { exec } from 'child_process';
+import { promisify } from 'util';
+import { withResolvers } from '@/core/util/promise';
+import { actionProgressWrapper } from '@/core/ui/progress';
+import logger from '@/core/log/logger';
+
+interface IPreRemoveWorktreeInfo {
+    worktreePath: string;
+    basePath: string;
+}
+
+/**
+ * Runs the user-configured `preRemoveCmd` inside the worktree directory
+ * before it is removed. Throws on failure so the caller can abort removal.
+ */
+export async function preRemoveWorktree(info: IPreRemoveWorktreeInfo) {
+    const { worktreePath, basePath } = info;
+    const preRemoveCmd = Config.get('preRemoveCmd', '');
+
+    if (!preRemoveCmd) return;
+
+    const waiting = withResolvers<void>();
+    const abortController = new AbortController();
+    const tokenSource = new vscode.CancellationTokenSource();
+    const disposeAbortSignal = tokenSource.token.onCancellationRequested(() => {
+        abortController.abort();
+    });
+
+    try {
+        const cmdStr = preRemoveCmd.replace('$BASE_PATH', basePath).replace('$WORKTREE_PATH', worktreePath);
+
+        actionProgressWrapper(
+            vscode.l10n.t('Running pre-remove command...'),
+            () => waiting.promise,
+            () => {},
+            tokenSource,
+        );
+
+        const execPromise = promisify(exec);
+
+        const execChild = execPromise(cmdStr, {
+            cwd: worktreePath,
+            env: process.env,
+            signal: abortController.signal,
+            encoding: 'buffer',
+        });
+        execChild.child.stdout?.on('data', (data) => {
+            logger.log(`[preRemoveWorktree] ${data.toString()}`);
+        });
+        execChild.child.stderr?.on('data', (data) => {
+            logger.error(`[preRemoveWorktree] ${data.toString()}`);
+        });
+
+        await execChild;
+        logger.log(`[preRemoveWorktree] done`);
+    } catch (error: any) {
+        logger.error(`[preRemoveWorktree] ${error}`);
+        if (error?.name === 'AbortError') {
+            throw new Error(vscode.l10n.t('Pre-remove command was cancelled'));
+        }
+        throw new Error(vscode.l10n.t('Pre-remove command failed: {0}', error?.message ?? String(error)));
+    } finally {
+        waiting.resolve();
+        disposeAbortSignal.dispose();
+        tokenSource.dispose();
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -104,6 +104,7 @@`
`104`	`104`	"config.worktreeSubdirectoryTemplate.description": "ワークツリーサブディレクトリ名のテンプレートです。使用可能な変数：\n\n- `$BASE_NAME`（リポジトリフォルダ名）\n- `$INDEX`（増分番号）。\n- `$REF_NAME` （参照名、ブランチ名やタグ名など）\n\n使用できない文字：/ \\ : * ? \" < > \|",
`105`	`105`	`"config.worktreeSubdirectoryTemplate.patternErrorMessage": "テンプレートに次の文字は使用できません：/ \\ : * ? \" < > \|",`
`106`	`106`	"config.postCreateCmd.description": "ワークツリー作成後に実行するコマンド。デフォルトでは、新しいワークツリーのディレクトリ内で実行されます。コマンドで使用できる変数：\n\n- `$BASE_PATH`：ワークツリーの完全パス\n- `$WORKTREE_PATH`：ワークツリーの完全パス\n- `$BASE_NAME`：ワークツリーのフォルダ名\n\n例：\n`git submodule update --init --recursive`",
	`107`	+ "config.preRemoveCmd.description": "ワークツリー削除前に実行するコマンド。ワークツリーのディレクトリ内で実行されます。コマンドが失敗またはキャンセルされた場合、削除は中止されます。コマンドで使用できる変数：\n\n- `$BASE_PATH`：メインリポジトリの完全パス\n- `$WORKTREE_PATH`：削除対象ワークツリーの完全パス\n\n例：\n`pnpm run worktree:teardown-db`",
`107`	`108`	"config.worktreeDescriptionTemplate.description": "ワークツリーの説明テンプレートです。使用可能な変数：\n\n- `$FULL_PATH`：ワークツリーの完全パス\n- `$BASE_NAME`：ワークツリーのフォルダ名\n- `$RELATIVE_PATH`：相対パス（メインリポジトリのルートからの相対パス）",
`108`	`109`	"config.terminalNameTemplate.description": "内蔵ターミナルの名称テンプレートです。使用可能な変数：\n\n- `$FULL_PATH`：フォルダの完全パス\n- `$BASE_NAME`：フォルダ名\n- `$LABEL`：表示名、フォルダ名またはワークツリーの表示名"
`109`	`110`	`}`