VS Code TypeScript扩展：如何用API自动插入符合缩进设置的文本

我正在用TypeScript开发VS Code扩展，需要根据TextEditorOptions的设置，在TextDocument中插入带缩进的文本（用制表符或空格）。我可以手动处理制表符转换，但想知道有没有VS Code API的惯用做法。

缩进位置取自TextEditor.selection.end.character，如果用制表符，不根据TextEditorOptions.tabSize调整的话，这个值就不是实际的插入位置。

示例代码场景：

int main(int argc, const char *argv[]) {
        int countdown = -1;

        Text to be inserted here.
^^^^^^^^Need to indent with tabs.

        static const char invalid[] = "Invalid countdown %s, try again...\n";
        if (argc > 1) {
                char* end;
                countdown = strtol(argv[1], &end, 10);

请问VS Code API里有没有自动处理制表符/空格插入的功能，还是必须手动实现？

答案：用VS Code内置API即可实现，无需手动处理 #

VS Code API提供了现成的能力来自动适配编辑器的缩进设置，推荐以下两种方式：

1. 优先使用TextEditor.insertSnippet()

这是最省心的方案，insertSnippet()会自动读取当前编辑器的insertSpaces和tabSize配置，将代码片段中的制表符自动转换为对应数量的空格（或保留制表符），完全不用自己处理转换逻辑。

示例代码：

import * as vscode from 'vscode';

async function insertIndentedText() {
    const editor = vscode.window.activeTextEditor;
    if (!editor) return;

    // 构造带缩进的代码片段，用\t表示缩进
    const snippet = new vscode.SnippetString('\tText to be inserted here.\n');
    // 在光标位置插入，API自动适配缩进设置
    await editor.insertSnippet(snippet, editor.selection.end);
}

2. 手动利用编辑器配置生成缩进字符串（如需精细控制）

如果不需要代码片段的其他特性，也可以直接获取编辑器的缩进配置，生成符合要求的缩进字符串后插入：

import * as vscode from 'vscode';

// 根据编辑器配置生成对应的缩进字符串
function getIndent(editor: vscode.TextEditor): string {
    const { insertSpaces, tabSize } = editor.options;
    return insertSpaces ? ' '.repeat(tabSize as number) : '\t';
}

async function insertIndentedTextManually() {
    const editor = vscode.window.activeTextEditor;
    if (!editor) return;

    const indent = getIndent(editor);
    const text = `${indent}Text to be inserted here.\n`;
    
    await editor.edit(builder => {
        builder.insert(editor.selection.end, text);
    });
}

关于selection.end.character的位置问题

当使用制表符时，selection.end.character是按制表符的个数计数的，而非实际字符宽度。如果需要换算成实际的列宽度（按空格计算），可以用tabSize直接相乘：

const tabSize = editor.options.tabSize as number;
const actualColumn = editor.selection.end.character * tabSize;

不过使用上述两种插入方案时，通常不需要手动处理这个换算，API会自动处理位置的准确性。

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