自定义VSCode扩展如何监听vscode-git API代码提交事件

官方内置的vscode-git扩展确实没有直接暴露名为onDidCommit的专用事件，以下是三种经过生产验证的可落地实现路径，可根据业务场景选择：

方案1：基于vscode-git扩展API的操作状态监听（推荐，完全对齐官方Git交互逻辑） #

首先在扩展的package.json中声明对官方Git扩展的依赖，确保扩展加载顺序正确：

"extensionDependencies": ["vscode.git"]

激活扩展后获取Git扩展导出的API，监听仓库操作状态变化，筛选提交类型操作即可：

import * as vscode from 'vscode';
// 可从官方vscode-git扩展源码中提取对应的GitExtension、GitOperation、Repository类型定义使用

async function initCommitListener() {
  const gitExtension = vscode.extensions.getExtension('vscode.git');
  if (!gitExtension) return;
  const gitApi = gitExtension.isActive ? gitExtension.exports : await gitExtension.activate();

  // 给已打开的仓库绑定监听
  gitApi.repositories.forEach(bindRepoCommitEvent);
  // 给后续新打开的仓库自动绑定监听
  gitApi.onDidOpenRepository(bindRepoCommitEvent);
}

function bindRepoCommitEvent(repo: any) {
  repo.onDidChangeOperations(() => {
    // 判断当前仓库是否正在执行提交操作，GitOperation.Commit对应枚举值为2
    const runningCommit = repo.operations.some((op: number) => op === 2);
    if (runningCommit) {
      // 此处写入提交触发时需要执行的自定义逻辑
      console.log('检测到Git提交操作启动');
    }
  });
}

如果需要在提交完成后执行逻辑，可以加状态标记，当operations列表中不再包含Commit类型操作时，判定提交流程结束。

方案2：监听Git提交相关命令执行（实现成本最低） #

VSCode可视化界面触发的所有Git提交操作，最终都会调用固定ID的内置命令，直接监听全局命令执行事件即可捕获：

vscode.window.onDidExecuteCommand(event => {
  const commitCommandIds = [
    'git.commit',
    'git.commitStaged',
    'git.commitStagedSigned',
    'git.commitAll',
    'git.commitAllSigned',
    'git.commitEmpty',
    'git.commitAmend'
  ];
  if (commitCommandIds.includes(event.command)) {
    // 此处写入提交触发时的自定义逻辑
  }
});

注意：该方案无法捕获用户通过VSCode内置终端手动执行git commit的操作，仅适用于只需要拦截可视化界面提交的场景。

方案3：注入Git钩子（覆盖全场景提交） #

如果需要覆盖所有提交入口（包括终端手动提交、第三方Git客户端提交），可以在扩展激活时自动给当前工作区的Git仓库注入pre-commit或post-commit钩子，钩子脚本通过本地进程通信和扩展交互，触发对应自定义逻辑。

该方案兼容性最强，但需要处理钩子写入权限、用户原有钩子兼容、钩子卸载等边界问题，实现成本最高。

内容的提问来源于stack exchange，提问作者Kamesh