VS Code中设置WorkspaceEdit预览复选框默认全选的方法

VS Code 默认情况下，当给WorkspaceEdit的元数据设置needsConfirmation: true时，重构预览里的复选框都是未勾选状态。要实现默认全选同时保留预览窗口，不能直接依赖WorkspaceEdit的内置确认逻辑，得手动调用内部的BulkEditService并配置选项。

代码示例 #

import * as vscode from 'vscode';

export function activate(context: vscode.ExtensionContext) {
    let disposable = vscode.commands.registerCommand('extension.demoBulkEdit', async () => {
        // 1. 创建要执行的WorkspaceEdit
        const edit = new vscode.WorkspaceEdit();
        // 示例：修改当前打开的文件内容
        const activeEditor = vscode.window.activeTextEditor;
        if (!activeEditor) return;
        
        const document = activeEditor.document;
        edit.replace(document.uri, new vscode.Range(0, 0, 0, 5), '// 替换后的内容');
        // 可添加更多编辑操作...

        // 2. 获取VS Code内部的BulkEditService
        const bulkEditExt = vscode.extensions.getExtension<{ bulkEditService: vscode.BulkEditService }>('vscode.bulkEdit');
        if (!bulkEditExt?.isActive || !bulkEditExt.exports.bulkEditService) {
            vscode.window.showErrorMessage('无法获取BulkEditService');
            return;
        }
        const bulkEditService = bulkEditExt.exports.bulkEditService;

        // 3. 配置批量编辑选项：显示预览 + 默认全选所有变更
        const options: vscode.BulkEditOptions = {
            showPreview: true,
            defaultCheckState: true,
            title: '自定义批量编辑预览' // 可选：设置预览窗口标题
        };

        // 4. 调用服务执行编辑，会弹出默认全选的预览窗口
        await bulkEditService.apply([edit], options);
    });

    context.subscriptions.push(disposable);
}

关键说明 #

• BulkEditService是VS Code的内部服务，需要通过vscode.extensions.getExtension('vscode.bulkEdit')获取，确保扩展激活后再使用。
• BulkEditOptions中的defaultCheckState: true直接控制预览窗口中所有变更复选框的初始勾选状态。
• showPreview: true保证预览窗口正常显示，替代原WorkspaceEdit元数据中的needsConfirmation逻辑。
• 这种方式完全绕过了WorkspaceEdit自带的确认流程，直接通过底层服务实现自定义的预览行为。

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