如何在VS Code扩展的extension.ts文件中获取指定函数的运行结果

以下按需求拆分三个核心环节实现：

1. 检索目标代码库中的指定文件 #

调用VS Code官方vscode.workspace模块的API实现文件检索，无需手动遍历目录：

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

async function findTargetFile(targetFileName: string): Promise<vscode.Uri | undefined> {
    // 先校验是否已打开工作区
    if (!vscode.workspace.workspaceFolders?.length) {
        return undefined;
    }
    // 第一个参数为glob匹配规则，第二个参数为排除路径规则
    const matchedFiles = await vscode.workspace.findFiles(
        `**/${targetFileName}`,
        '**/{node_modules,dist,build}/**'
    );
    // 取第一个匹配的文件返回，可根据需求调整多文件处理逻辑
    return matchedFiles[0];
}

如果是用户手动指定的文件路径，可直接调用vscode.workspace.openTextDocument(absolutePath)直接读取文件。

2. 在文件内定位特定函数 #

根据你要解析的文件语言选择解析方案，以最常见的JS/TS文件为例：

• 简单场景可直接用正则匹配目标函数代码段
• 复杂场景推荐引入ts-morph这类AST解析库，精准识别函数定义、参数、返回值等信息

简单正则匹配示例：

async function getTargetFunctionCode(fileUri: vscode.Uri, functionName: string): Promise<string | undefined> {
    const doc = await vscode.workspace.openTextDocument(fileUri);
    const fileContent = doc.getText();
    // 匹配普通函数/箭头函数定义，可根据实际函数格式调整正则规则
    const funcReg = new RegExp(`(?:function\\s+${functionName}\\s*\\([\\s\\S]*?\\)\\s*{[\\s\\S]*?})|(?:const\\s+${functionName}\\s*=\\s*\\([\\s\\S]*?\\)\\s*=>\\s*{[\\s\\S]*?})`);
    const matchResult = fileContent.match(funcReg);
    return matchResult?.[0];
}

3. 获取函数运行结果 #

如果目标函数属于工作区项目代码，可通过动态转译+加载的方式执行获取结果，以TS文件为例，引入esbuild做代码转译：

import { transform } from 'esbuild';
import * as fs from 'fs';

async function runTargetFunction(funcCode: string, functionName: string, inputArgs: any[] = []): Promise<any> {
    // 把TS代码转译为Node可执行的JS代码
    const { code: jsCode } = await transform(funcCode, {
        loader: 'ts',
        target: 'es2020'
    });
    // 构造临时模块代码，导出目标函数
    const tempModuleCode = `${jsCode}\nmodule.exports = ${functionName};`;
    // 写入临时文件
    const tempFilePath = path.resolve(__dirname, './temp_func.js');
    fs.writeFileSync(tempFilePath, tempModuleCode);
    // 加载模块执行函数
    const targetFunc = require(tempFilePath);
    const runResult = targetFunc(...inputArgs);
    // 清理临时文件和模块缓存
    delete require.cache[require.resolve(tempFilePath)];
    fs.unlinkSync(tempFilePath);
    return runResult;
}

如果目标函数需要运行在用户项目的特定环境中，可通过vscode.tasksAPI执行用户项目的npm脚本，把结果输出到临时文件后读取即可。

注意事项 #

• 所有文件操作前优先校验vscode.workspace.workspaceFolders非空，避免无工作区时报错
• 动态执行外部项目代码存在安全风险，建议添加必要的输入校验规则
• 如果目标函数有外部依赖，需要保证依赖在扩展运行环境或者用户项目环境中可正常加载

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