VS Code扩展开发：使用rename API时如何自动更新文件导入？

非正规Hack方式（依赖内部API） #

由于TypeScript的updateImportsOnFileMove功能未暴露公开API，可通过调用TypeScript语言服务的内部方法实现，但需注意该方式依赖VS Code和TS扩展的内部实现，版本更新可能失效。

代码示例 #

import * as vscode from 'vscode';

async function renameWithAutoImportUpdate(oldUri: vscode.Uri, newUri: vscode.Uri) {
    // 执行基础文件重命名
    await vscode.workspace.fs.rename(oldUri, newUri);

    // 获取并激活TypeScript扩展
    const tsExt = vscode.extensions.getExtension('vscode.typescript-language-features');
    if (!tsExt) return;
    if (!tsExt.isActive) await tsExt.activate();

    // 调用内部语言服务的文件重命名处理逻辑
    const tsApi = tsExt.exports;
    if (tsApi?.languageServiceManager) {
        const ls = tsApi.languageServiceManager.getLanguageService(oldUri);
        if (ls) {
            await ls.applyFileRename({
                oldFileName: oldUri.fsPath,
                newFileName: newUri.fsPath
            });
            // 保存所有修改的文件
            await vscode.commands.executeCommand('workbench.action.files.saveAll');
        }
    }
}

注意事项 #

• 内部API无官方维护，VS Code或TS扩展版本迭代后可能出现调用失败
• 仅适用于TypeScript项目，对JavaScript项目需额外适配

最优正规解决方案（基于公开API） #

使用VS Code和TypeScript的公开API手动查找文件引用并更新导入路径，稳定且不受版本变更影响，需自行处理路径解析和导入语句替换逻辑。

代码示例 #

import * as vscode from 'vscode';
import * as ts from 'typescript';

async function renameFileAndUpdateImports(oldUri: vscode.Uri, newUri: vscode.Uri) {
    // 1. 执行文件重命名
    await vscode.workspace.fs.rename(oldUri, newUri);

    const workspaceFolder = vscode.workspace.getWorkspaceFolder(oldUri);
    if (!workspaceFolder) return;

    // 2. 加载项目的TS配置
    const tsConfigFiles = await vscode.workspace.findFiles('tsconfig.json', undefined, 1, workspaceFolder);
    const tsConfigPath = tsConfigFiles[0]?.fsPath;
    if (!tsConfigPath) return;

    // 3. 创建TS程序实例
    const program = ts.createProgram({
        rootNames: [oldUri.fsPath],
        options: ts.getParsedCommandLineOfConfigFile(tsConfigPath, {}, ts.sys).options
    });

    // 4. 获取文件的所有引用位置
    const references = program.getReferencesToFile(oldUri.fsPath);
    if (!references.length) return;

    const edit = new vscode.WorkspaceEdit();
    const oldRelativePath = vscode.workspace.asRelativePath(oldUri, false).replace(/\\/g, '/');
    const newRelativePath = vscode.workspace.asRelativePath(newUri, false).replace(/\\/g, '/');

    // 5. 遍历引用文件，替换导入路径
    for (const ref of references) {
        const sourceFile = program.getSourceFile(ref.fileName);
        if (!sourceFile) continue;

        ts.forEachChild(sourceFile, node => {
            if (!ts.isImportDeclaration(node)) return;

            const specifierText = node.moduleSpecifier.getText().replace(/['"]/g, '');
            if (specifierText === oldRelativePath) {
                // 计算新的导入语句
                const newSpecifier = ts.createLiteral(newRelativePath);
                const updatedNode = ts.updateImportDeclaration(
                    node,
                    node.decorators,
                    node.modifiers,
                    node.importClause,
                    newSpecifier
                );

                // 生成编辑范围并添加到工作区编辑
                const startPos = sourceFile.getLineAndCharacterOfPosition(node.getStart());
                const endPos = sourceFile.getLineAndCharacterOfPosition(node.getEnd());
                const range = new vscode.Range(startPos, endPos);
                edit.replace(vscode.Uri.file(ref.fileName), range, updatedNode.getText());
            }
        });
    }

    // 6. 应用所有编辑并保存
    await vscode.workspace.applyEdit(edit);
    await vscode.commands.executeCommand('workbench.action.files.saveAll');
}

优化建议 #

• 处理TS配置中的paths别名：需结合ts.resolveModuleName解析实际路径
• 支持更多导入类型：如require语句、动态导入、导出语句
• 添加错误处理：捕获文件加载、编辑应用过程中的异常

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