VS Code扩展开发：如何在代码片段中获取父函数名称

普通VS Code用户代码片段（snippets.json）仅支持静态模板和有限内置变量（如${TM_FILENAME}），无法动态分析当前光标位置的父函数名称。要实现需求，需结合VS Code扩展API编写命令，搭配代码片段触发。

步骤1：创建基础扩展项目 #

• 打开VS Code，按Ctrl+Shift+P（Mac为Cmd+Shift+P）执行Yeoman Generator，选择code生成扩展项目。
• 项目生成后，编辑extension.js（或extension.ts）编写核心逻辑。

步骤2：编写获取父函数名的核心代码 #

在extension.js中添加以下JavaScript代码：

const vscode = require('vscode');

function activate(context) {
    let disposable = vscode.commands.registerCommand('extension.logParentFunction', function () {
        const editor = vscode.window.activeTextEditor;
        if (!editor) return;

        const document = editor.document;
        const position = editor.selection.active;
        
        // 调用VS Code语言服务获取文档符号
        vscode.commands.executeCommand('vscode.executeDocumentSymbolProvider', document.uri).then(symbols => {
            let parentFunctionName = '';
            // 遍历符号树，定位包含光标位置的最内层函数
            function findParentFunction(symbols) {
                for (const symbol of symbols) {
                    if (symbol.range.contains(position) && symbol.kind === vscode.SymbolKind.Function) {
                        parentFunctionName = symbol.name;
                        return;
                    }
                    if (symbol.children.length > 0) {
                        findParentFunction(symbol.children);
                    }
                }
            }
            findParentFunction(symbols);

            // 插入带父函数名的console.log语句
            if (parentFunctionName) {
                const snippet = new vscode.SnippetString(`console.log('${parentFunctionName}')`);
                editor.insertSnippet(snippet);
            } else {
                vscode.window.showInformationMessage('未找到父函数');
            }
        });
    });

    context.subscriptions.push(disposable);
}

function deactivate() {}

module.exports = {
    activate,
    deactivate
};

步骤3：配置命令与触发方式 #

1. 在package.json中添加命令声明和快捷键：

"contributes": {
    "commands": [
        {
            "command": "extension.logParentFunction",
            "title": "Log Parent Function Name"
        }
    ],
    "keybindings": [
        {
            "command": "extension.logParentFunction",
            "key": "ctrl+shift+l",
            "mac": "cmd+shift+l",
            "when": "editorTextFocus"
        }
    ]
}

2. 关联代码片段触发词：
   在你的代码片段文件（如javascript.json）中添加：

"Log Parent Function": {
    "prefix": "tces",
    "body": [
        "${command:extension.logParentFunction}"
    ],
    "description": "打印当前位置的父函数名称"
}

步骤4：测试扩展 #

• 按F5启动扩展开发宿主窗口。
• 在JS/TS等支持符号解析的语言文件的函数内部，输入tces触发代码片段，即可自动插入带有父函数名的console.log语句。

注意：该逻辑依赖VS Code语言服务，仅对有完善符号解析的语言生效。

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