如何在VSCode代码片段中调用扩展配置值？

核心原因 #

VSCode的代码片段系统本身不支持直接引用package.json里定义的扩展配置项，直接写键名只会被当作普通字符串输出。

解决方法 #

方法1：注册自定义代码片段变量 #

在扩展代码中注册自定义变量解析逻辑，让代码片段能通过变量获取实时配置值：

1. 在扩展激活逻辑中添加变量解析器：

import * as vscode from 'vscode';

export function activate(context: vscode.ExtensionContext) {
    // 注册自定义变量解析器，可限定目标语言（替换'*'为具体语言ID）
    vscode.languages.registerCompletionItemProvider('*', {
        provideCompletionItems() { return []; },
        resolveCompletionItem(item: vscode.CompletionItem) {
            if (item.label === '$myUpdateValue') {
                const config = vscode.workspace.getConfiguration('MyProject');
                item.insertText = config.get<string>('UpdateValue') || '默认值';
            }
            return item;
        }
    });
}

2. 在代码片段文件（如.code-snippets）中使用该变量：

{
  "带配置值的代码片段": {
    "prefix": "myConfigSnippet",
    "body": ["当前配置值: $myUpdateValue"],
    "description": "插入扩展配置值的模板"
  }
}

方法2：用命令直接插入配置值 #

如果不需要完整代码片段模板，可注册命令快速插入配置值：

1. 在package.json中添加命令声明：

{
  "contributes": {
    "commands": [
      {
        "command": "MyProject.insertUpdateValue",
        "title": "插入UpdateValue配置值"
      }
    ]
  }
}

2. 在扩展代码中实现命令逻辑：

import * as vscode from 'vscode';

export function activate(context: vscode.ExtensionContext) {
    const disposable = vscode.commands.registerCommand('MyProject.insertUpdateValue', () => {
        const editor = vscode.window.activeTextEditor;
        if (!editor) {
            vscode.window.showErrorMessage('无激活编辑器');
            return;
        }
        const config = vscode.workspace.getConfiguration('MyProject');
        const value = config.get<string>('UpdateValue') || '默认值';
        editor.edit(editBuilder => {
            editBuilder.replace(editor.selection, value);
        });
    });
    context.subscriptions.push(disposable);
}

方法3：动态生成静态代码片段（适合配置少变动场景） #

扩展激活时根据当前配置值生成静态代码片段，配置变动时重新生成：

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

export function activate(context: vscode.ExtensionContext) {
    // 生成代码片段的逻辑
    const generateSnippet = () => {
        const config = vscode.workspace.getConfiguration('MyProject');
        const value = config.get<string>('UpdateValue') || '默认值';
        const snippetContent = {
            "静态配置值片段": {
                "prefix": staticConfigSnippet,
                "body": [`配置值: ${value}`],
                "description": "包含当前配置值的静态片段"
            }
        };
        const snippetPath = path.join(context.extensionPath, 'snippets', 'auto-gen.code-snippets');
        fs.mkdirSync(path.dirname(snippetPath), { recursive: true });
        fs.writeFileSync(snippetPath, JSON.stringify(snippetContent, null, 2));
        // 通知VSCode加载该片段文件
        vscode.workspace.getConfiguration('editor').update('snippets', {
            ...vscode.workspace.getConfiguration('editor').get('snippets'),
            "自动生成片段": snippetPath
        }, vscode.ConfigurationTarget.Global);
    };

    // 首次激活生成片段
    generateSnippet();
    // 监听配置变化，重新生成
    context.subscriptions.push(
        vscode.workspace.onDidChangeConfiguration(event => {
            if (event.affectsConfiguration('MyProject.UpdateValue')) {
                generateSnippet();
            }
        })
    );
}

注意事项 #

• 方法1需要确保扩展已激活，否则自定义变量无法被解析。
• 方法3需处理配置动态更新的场景，避免片段内容过时。

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