VS Code扩展中registerCompletionItemProvider无法触发provideCompletionItems

我尝试在VS Code中动态注册代码片段，通过遍历多个文件收集片段数据后，调用自定义的registerCompletionItemProvider函数为每个文件注册。但发现provideCompletionItems方法在.js文件中从未执行，预期输入片段名称或prefix时该方法会触发。

相关代码：

const registerCompletionItemProvider = (
    snippetLanguage: string | string[],
    snippetObject: any,
    name: string
) => {
    console.log(snippetLanguage);
    console.log(snippetObject);
    console.log(name); // 这段代码能执行
    vscode.languages.registerCompletionItemProvider(
        // snippetLanguage,
        [{ scheme: 'file', language: 'javascript' }], // 调试时硬编码在这里
        {
            provideCompletionItems(document, position) {
                // 这段代码从未执行
                const start = new vscode.Position(position.line, 0);
                const range = new vscode.Range(start, position);
                const completionItems = Object.keys(snippetObject).map((key) => {
                    const snippet = new vscode.SnippetString(snippetObject[key]);
                    const completionItem = new vscode.CompletionItem(
                        key,
                        vscode.CompletionItemKind.Snippet
                    );
                    completionItem.range = range;
                    completionItem.insertText = snippet;
                    return completionItem;
                });
                return completionItems;
            },
        },
        name
    );
};

片段数据示例：

{
    "First": { // First是片段名称
        "prefix": [
            "test1" // 触发前缀
        ],
        "body": [
            "function ${1:myFunction}($2) {",
            "\t$0",
            "}"
        ],
        "description": "任意函数模板"
    },
    "Secondary": {
        "prefix": [
            "test"
        ],
        "body": [
            "function ${1:myFunction}($2) {",
            "\t$0",
            "}"
        ],
        "description": "任意函数模板"
    }
}

1. 修正触发字符参数 #

registerCompletionItemProvider的第三个参数是触发字符，你现在传的是片段名称（比如"First"），只有输入这个名称开头的内容才会触发补全逻辑。但你预期的是输入prefix（比如"test1"）时触发，直接移除这个参数即可——VS Code会自动在用户输入过程中发起补全请求，无需指定触发字符。

2. 正确构造代码片段字符串 #

你直接把包含prefix、body的完整对象传给SnippetString，这是错误的。SnippetString需要的是代码片段的内容，也就是body数组拼接后的字符串，得把数组转成换行分隔的字符串再传入。

3. 完善补全项匹配逻辑 #

给补全项设置filterText属性，把prefix数组里的内容传进去，让VS Code能根据用户输入的前缀匹配到对应的片段；同时补充描述信息，提升使用体验。

修复后的代码：

const registerCompletionItemProvider = (
    snippetLanguage: string | string[],
    snippetObject: any
) => {
    console.log(snippetLanguage);
    console.log(snippetObject);

    vscode.languages.registerCompletionItemProvider(
        [{ scheme: 'file', language: 'javascript' }],
        {
            provideCompletionItems(document, position) {
                const start = new vscode.Position(position.line, 0);
                const range = new vscode.Range(start, position);
                
                const completionItems = Object.entries(snippetObject).map(([name, snippetData]) => {
                    // 将body数组转为带换行的字符串，构造正确的SnippetString
                    const snippetBody = snippetData.body.join('\n');
                    const snippet = new vscode.SnippetString(snippetBody);

                    const completionItem = new vscode.CompletionItem(
                        name,
                        vscode.CompletionItemKind.Snippet
                    );
                    
                    completionItem.insertText = snippet;
                    completionItem.range = range;
                    completionItem.detail = snippetData.description;
                    // 设置匹配前缀，支持多个prefix用空格分隔
                    completionItem.filterText = snippetData.prefix.join(' ');

                    return completionItem;
                });

                return completionItems;
            },
        }
        // 移除触发字符参数，让VS Code自动触发补全
    );
};

额外提示 #

• 如果需要更精确的前缀匹配，可以在provideCompletionItems里先获取当前行输入的文本currentText = document.getText(range)，然后过滤出前缀包含currentText的片段，只返回这些匹配项，减少不必要的计算。
• 确保你的扩展激活事件配置正确，比如在package.json里添加"activationEvents": ["onLanguage:javascript"]，保证扩展在打开.js文件时能正常激活并注册补全提供者。

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