如何在VS Code扩展中通过API调用用户代码片段生成文件

要实现从代码中调用指定名称的代码片段并生成文件内容，你需要完成获取代码片段、展开片段内容这两个核心步骤，以下是具体实现：

核心步骤说明 #

1. 正确获取用户配置 #

原代码中直接通过config["[extensionName]"]读取配置存在风险，应该使用VSCode配置对象的get方法，并添加默认值：

const config = vscode.workspace.getConfiguration();
const options: Array<[string, string, string]> = config.get("[extensionName]") || [];

2. 获取指定语言和名称的代码片段 #

使用VSCode API的vscode.languages.getSnippets(languageId)方法，获取对应语言的所有代码片段，再通过名称匹配目标片段：

const snippets = await vscode.languages.getSnippets(snippetLanguage.toLowerCase()); // 语言ID需小写，比如"javascript"
const targetSnippet = snippets.find(snippet => snippet.name === snippetName);

3. 展开代码片段内容 #

代码片段的body可能是字符串或字符串数组，先统一转为字符串，再处理占位符和自定义变量：

• 替换${n:默认值}格式的占位符为默认值，${n}直接清空
• 替换自定义变量${folderName}为实际文件夹名称
• 如需支持VSCode内置变量（如${TM_FILENAME}），可手动添加替换逻辑

4. 批量处理文件创建 #

将原forEach改为Promise.all，确保所有文件创建完成后再结束流程，避免异步操作导致的问题。

修改后的完整代码 #

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

async function createFolder(folderName: string) {
    // 获取插件配置
    const config = vscode.workspace.getConfiguration();
    const options: Array<[string, string, string]> = config.get("[extensionName]") || [];

    // 让用户选择目标文件夹
    const selectedFolders = await vscode.window.showOpenDialog({
        canSelectFiles: false,
        canSelectFolders: true,
        canSelectMany: false
    });

    if (!selectedFolders || selectedFolders.length === 0) {
        return;
    }

    const selectedFolderUri = selectedFolders[0];
    const selectedFolderPath = selectedFolderUri.fsPath;
    const folderPath = path.join(selectedFolderPath, folderName);

    // 创建目标文件夹
    await fs.promises.mkdir(folderPath, { recursive: true });

    // 批量创建文件并写入代码片段内容
    await Promise.all(options.map(async ([fileName, snippetName, snippetLanguage]) => {
        const filePath = path.join(folderPath, fileName.replace("{folderName}", folderName));
        const languageId = snippetLanguage.toLowerCase();

        // 获取对应语言的代码片段
        const snippets = await vscode.languages.getSnippets(languageId);
        const targetSnippet = snippets.find(s => s.name === snippetName);

        if (!targetSnippet) {
            vscode.window.showWarningMessage(`未找到名为${snippetName}的${snippetLanguage}代码片段`);
            return;
        }

        // 处理代码片段body（数组转字符串）
        let snippetBody = '';
        if (Array.isArray(targetSnippet.body)) {
            snippetBody = targetSnippet.body.join('\n');
        } else {
            snippetBody = targetSnippet.body;
        }

        // 展开代码片段：替换占位符和自定义变量
        function expandSnippet(body: string): string {
            // 替换${n:默认值} → 默认值；${n} → 空
            let expanded = body.replace(/\$\{\d+(?:\:([^}]+))?\}/g, (_match, defaultValue) => defaultValue || '');
            // 替换自定义变量${folderName}
            expanded = expanded.replace(/\$\{folderName\}/g, folderName);
            // 可选：添加VSCode内置变量替换
            const baseFileName = path.basename(filePath);
            const fileNameWithoutExt = path.basename(filePath, path.extname(filePath));
            expanded = expanded
                .replace(/\$\{TM_FILENAME\}/g, baseFileName)
                .replace(/\$\{TM_FILENAME_BASE\}/g, fileNameWithoutExt);
            
            return expanded;
        }

        const fileContent = expandSnippet(snippetBody);
        await fs.promises.writeFile(filePath, fileContent);
    }));

    vscode.window.showInformationMessage(`文件夹${folderName}及相关文件已创建完成`);
}

注意事项 #

• 语言ID正确性：VSCode的语言ID为小写（比如JavaScript是javascript，TypeScript是typescript），建议在配置中直接使用小写，或在代码中统一转换
• 代码片段名称匹配：确保用户配置的snippetName与实际代码片段的name完全一致（区分大小写）
• 内置变量支持：如果需要支持更多VSCode内置变量，可参考官方文档添加对应的替换逻辑
• 错误处理：代码中添加了未找到片段的警告提示，可根据需求扩展其他错误处理逻辑

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