VS Code扩展开发：高效检测Git分支切换的实现策略

npm install chokidar
npm install --save-dev @types/chokidar

import * as vscode from 'vscode';
import * as path from 'path';
import * as fs from 'fs';
import * as chokidar from 'chokidar';

// 定义一个变量来存储watcher实例，以便在扩展停用时进行清理
let gitHeadWatcher: chokidar.FSWatcher | undefined;

/**
 * 从 .git/HEAD 文件中获取当前分支名称或提交哈希。
 * @param repoPath Git仓库的根路径。
 * @returns 当前分支名称（字符串）或提交哈希（字符串），如果不是Git仓库或无法解析则返回null。
 */
function getCurrentBranchOrCommit(repoPath: string): string | null {
    const headFilePath = path.join(repoPath, '.git', 'HEAD');
    if (!fs.existsSync(headFilePath)) {
        return null; // .git/HEAD 不存在，可能不是Git仓库
    }
    try {
        const headContent = fs.readFileSync(headFilePath, 'utf-8').trim();
        const match = headContent.match(/^ref: refs\/heads\/(.*)$/);
        if (match && match[1]) {
            return match[1]; // 返回分支名称
        }
        // 如果是分离头指针，则直接是提交哈希
        if (headContent.match(/^[0-9a-fA-F]{40}$/)) {
            return headContent.substring(0, 7); // 返回短哈希
        }
        return null; // 无法解析的HEAD内容
    } catch (error) {
        console.error(`Error reading .git/HEAD: ${error}`);
        return null;
    }
}

export function activate(context: vscode.ExtensionContext) {
    console.log('Git分支检测扩展已激活！');

    const workspaceFolders = vscode.workspace.workspaceFolders;
    if (!workspaceFolders || workspaceFolders.length === 0) {
        vscode.window.showWarningMessage('未打开工作区文件夹，无法监控Git变化。');
        return;
    }

    // 假设我们只处理第一个工作区文件夹
    const repoPath = workspaceFolders[0].uri.fsPath;
    const gitHeadPath = path.join(repoPath, '.git', 'HEAD');

    // 初始化时获取当前分支/提交
    let currentActiveRef = getCurrentBranchOrCommit(repoPath);
    console.log(`初始分支/提交: ${currentActiveRef || '未检测到或分离头指针'}`);
    // 在这里可以调用你的自定义函数，处理初始状态
    // yourCustomFunction(currentActiveRef);

    // 初始化chokidar watcher
    gitHeadWatcher = chokidar.watch(gitHeadPath, {
        persistent: true,    // 保持监听
        ignoreInitial: true, // 忽略初次启动时的 'add'/'change' 事件
        awaitWriteFinish: {  // 等待文件写入完成，避免读取不完整的文件
            stabilityThreshold: 50,
            pollInterval: 10
        }
    });

    // 监听文件变化事件
    gitHeadWatcher.on('change', () => {
        const newActiveRef = getCurrentBranchOrCommit(repoPath);

        if (newActiveRef && newActiveRef !== currentActiveRef) {
            console.log(`Git分支/提交从 ${currentActiveRef || '未知'} 切换到 ${newActiveRef}`);
            vscode.window.showInformationMessage(`Git分支/提交已切换到: ${newActiveRef}`);
            // TODO: 在这里调用你的自定义扩展逻辑，例如：
            // yourCustomExtensionLogic(newActiveRef);
            currentActiveRef = newActiveRef; // 更新当前活跃引用
        } else if (newActiveRef === null) {
            console.log('.git/HEAD 文件不存在或Git仓库未初始化。');
        } else if (newActiveRef === currentActiveRef) {
            // 文件可能被触摸但内容没有实际改变（例如，某些Git操作可能会重写HEAD文件）
            console.log('Git HEAD文件发生变化，但分支/提交引用未改变。');
        }
    });

    // 监听错误事件
    gitHeadWatcher.on('error', error => {
        console.error(`Git HEAD文件监听器发生错误: ${error}`);
        vscode.window.showErrorMessage(`监控Git HEAD时发生错误: ${error.message}`);
    });

    // 将watcher添加到订阅中，确保在扩展停用时清理资源
    context.subscriptions.push({
        dispose() {
            if (gitHeadWatcher) {
                gitHeadWatcher.close();
                console.log('Git HEAD文件监听器已关闭。');
            }
        }
    });
}

// 扩展停用时执行的函数
export function deactivate() {
    console.log('Git分支检测扩展已停用！');
    // chokidar watcher 会在 context.subscriptions.push 的 dispose 方法中被关闭
}