如何在VSCode API中实现用户主动触发provideInlineCompletionItems？

核心逻辑是利用InlineCompletionContext.triggerKind区分用户的触发场景，VSCode会在用户主动触发补全时自动调用你的provideInlineCompletionItems方法，你只需要根据触发类型返回对应的补全列表即可。

步骤1：理解触发类型枚举 #

VSCode提供的InlineCompletionTriggerKind包含四个关键值，对应不同触发场景：

• Automatic：用户停止输入时自动触发（默认场景）
• Invoke：用户主动触发补全（比如按默认快捷键Ctrl+I/Cmd+I）
• Next：用户请求切换到下一个补全项
• Previous：用户请求切换到上一个补全项

步骤2：在Provider中处理主动触发逻辑 #

在你的InlineCompletionItemProvider实现里，通过判断context.triggerKind分支处理场景，主动触发/切换时返回所有可用补全项，让用户可以选择切换：

import * as vscode from 'vscode';

export class CustomInlineCompletionProvider implements vscode.InlineCompletionItemProvider {
    provideInlineCompletionItems(
        document: vscode.TextDocument,
        position: vscode.Position,
        context: vscode.InlineCompletionContext,
        token: vscode.CancellationToken
    ): vscode.ProviderResult<vscode.InlineCompletionList | vscode.InlineCompletionItem[]> {
        // 根据触发类型分配处理逻辑
        switch (context.triggerKind) {
            case vscode.InlineCompletionTriggerKind.Invoke:
            case vscode.InlineCompletionTriggerKind.Next:
            case vscode.InlineCompletionTriggerKind.Previous:
                // 主动触发或切换时返回完整补全列表
                return this.getFullCompletions(document, position);
            case vscode.InlineCompletionTriggerKind.Automatic:
                // 自动触发时返回最优单个补全（可选优化）
                return this.getTopCompletion(document, position);
            default:
                return [];
        }
    }

    // 主动触发时返回所有候选补全
    private getFullCompletions(doc: vscode.TextDocument, pos: vscode.Position): vscode.InlineCompletionItem[] {
        const linePrefix = doc.lineAt(pos).text.slice(0, pos.character);
        const completions: vscode.InlineCompletionItem[] = [];

        // 示例：根据前缀生成多候选补全
        if (linePrefix.endsWith('func ')) {
            completions.push(
                new vscode.InlineCompletionItem(`() => { /* 无参箭头函数 */ }`),
                new vscode.InlineCompletionItem(`(param: string) => { /* 带参数箭头函数 */ }`),
                new vscode.InlineCompletionItem(`function() { /* 普通函数声明 */ }`)
            );
        }
        return completions;
    }

    // 自动触发时返回最匹配的单个补全
    private getTopCompletion(doc: vscode.TextDocument, pos: vscode.Position): vscode.InlineCompletionItem[] {
        const linePrefix = doc.lineAt(pos).text.slice(0, pos.character);
        if (linePrefix.endsWith('console.')) {
            return [new vscode.InlineCompletionItem(`log('debug info');`)];
        }
        return [];
    }
}

步骤3：注册Provider（必做） #

在插件激活时注册你的补全Provider，指定目标语言或文件范围：

export function activate(context: vscode.ExtensionContext) {
    const provider = new CustomInlineCompletionProvider();
    const disposable = vscode.languages.registerInlineCompletionItemProvider(
        { scheme: 'file', language: 'typescript' }, // 替换为你的目标语言/范围
        provider
    );
    context.subscriptions.push(disposable);
}

步骤4：自定义主动触发快捷键（可选） #

如果默认快捷键（Ctrl+I/Cmd+I）不符合需求，可在package.json中绑定自定义快捷键：

{
    "contributes": {
        "keybindings": [
            {
                "command": "editor.action.inlineSuggest.trigger",
                "key": "ctrl+shift+space",
                "mac": "cmd+shift+space",
                "when": "editorTextFocus && !suggestWidgetVisible"
            }
        ]
    }
}

关键注意点 #

• 主动触发时必须返回所有可用补全项，VSCode会自动处理切换逻辑
• 无需手动调用Provider方法，VSCode会在用户触发时自动触发调用
• 可根据triggerKind调整补全策略，比如主动触发展示更多候选，自动触发只展示最优结果

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