VSCode扩展：如何根据右键光标位置显示editor/context命令？

你遇到的核心问题是setContext的异步特性导致右键事件中临时设置上下文赶不上菜单渲染。正确的思路是提前跟踪光标位置和文档状态，实时更新上下文标记，这样右键触发时菜单的when条件能直接读取已准备好的状态。

实现步骤 #

1. 监听光标与文档变化：通过VS Code的事件API，实时捕获光标移动、选中范围变更或文档内容修改的事件。
2. 实时判断条件并更新上下文：在事件回调中，检查当前光标位置是否符合显示特殊菜单的条件（比如是否处于特定方法调用处），调用setContext更新状态。
3. 配置菜单的显示条件：在package.json中，将菜单的when条件关联到之前设置的上下文标记。

代码示例 #

扩展主逻辑（extension.ts）

import * as vscode from 'vscode';

export function activate(context: vscode.ExtensionContext) {
    // 初始化上下文状态
    vscode.commands.executeCommand('setContext', 'showSpecialCommand', false);

    // 监听光标选择变化
    const trackSelection = vscode.window.onDidChangeTextEditorSelection(event => {
        updateContextStatus(event.textEditor);
    });

    // 监听文档内容变化（处理光标不动但内容修改的场景）
    const trackDocChange = vscode.workspace.onDidChangeTextDocument(event => {
        const activeEditor = vscode.window.activeTextEditor;
        if (activeEditor?.document === event.document) {
            updateContextStatus(activeEditor);
        }
    });

    // 注册目标命令
    const specialCommand = vscode.commands.registerCommand('extension.specialMethodCommand', () => {
        vscode.window.showInformationMessage('仅在特定方法处可见的命令已执行');
    });

    context.subscriptions.push(trackSelection, trackDocChange, specialCommand);
}

// 封装上下文更新逻辑
function updateContextStatus(editor: vscode.TextEditor | undefined) {
    if (!editor) return;

    // 示例：判断当前行是否包含目标方法调用（可替换为更精准的语言服务判断）
    const currentLine = editor.document.lineAt(editor.selection.active.line);
    const isTargetMethod = currentLine.text.includes('targetMethod()');

    // 更新上下文标记
    vscode.commands.executeCommand('setContext', 'showSpecialCommand', isTargetMethod);
}

菜单配置（package.json）

{
    "contributes": {
        "commands": [
            {
                "command": "extension.specialMethodCommand",
                "title": "针对targetMethod的特殊操作"
            }
        ],
        "menus": {
            "editor/context": [
                {
                    "command": "extension.specialMethodCommand",
                    "when": "editorTextFocus && showSpecialCommand"
                }
            ]
        }
    }
}

进阶优化 #

• 精准条件判断：如果需要更准确的语法级判断（比如确认是方法调用而非字符串中的文本），可以使用VS Code的语言服务API（如vscode.languages.getHover、vscode.languages.getDocumentSymbols）分析光标位置的语法节点。
• 性能优化：添加防抖逻辑，避免光标快速移动时频繁触发setContext，比如延迟100ms再执行状态更新。

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