编辑

重构 TypeScript

源代码重构可以通过在不修改运行时行为的情况下重组代码来提高项目的质量和可维护性。Visual Studio Code 支持重构操作（重构），例如提取方法和提取变量，以从编辑器内部改进你的代码库。

Visual Studio Code 通过 TypeScript 语言服务内置了对 TypeScript 重构的支持，在本主题中，我们将演示使用 TypeScript 语言服务的重构支持。

重命名

最简单的重构之一是重命名方法或变量。按 F2 以在你的 TypeScript 项目中重命名光标下的符号

Renaming a method

重构

要查看可用的 TypeScript 重构，请将光标放在源代码区域，然后右键单击以调出编辑器上下文菜单并选择重构，或直接按 ⌃⇧R (Windows、Linux Ctrl+Shift+R)。

TypeScript refactoring

有关重构以及如何为单个重构配置键盘快捷键的更多信息，请参阅重构。

可用的 TypeScript 重构包括

提取到方法或函数 - 将选定的语句或表达式提取到文件中的新方法或新函数。

选择 提取到方法 或 提取到函数 重构后，输入提取的方法/函数的名称。
提取到常量 - 将选定的表达式提取到文件中的新常量。
将类型提取到接口或类型别名 - 将选定的复杂类型提取到接口或类型别名。
移动到新文件 - 将文件中顶层作用域中的一个或多个类、函数、常量或接口移动到新文件。新文件的名称从所选符号的名称推断而来。
在命名导入和命名空间导入之间转换 - 在命名导入 (import { Name } from './foo') 和命名空间导入 (import * as foo from './foo') 之间转换。
在默认导出和命名导出之间转换 - 从使用 export default 转换为具有命名导出 (export const Foo = ...)。
将参数转换为解构对象 - 重写一个接受长参数列表的函数，使其接受单个参数对象。
生成 get 和 set 访问器 - 通过为其生成 getter 和 setter 来封装选定的类属性。
推断函数返回类型 - 向函数添加显式返回类型注释。
从箭头函数添加/删除大括号 - 将单行箭头函数转换为多行，然后再转换回来。

快速修复

快速修复是建议的编辑，用于解决简单的编码错误。快速修复示例包括

向成员访问添加缺少的 this。
修复拼写错误的属性名称。
删除无法访问的代码或未使用的导入
声明

当您将光标移动到 TypeScript 错误上时，VS Code 会显示一个灯泡，指示快速修复可用。单击灯泡或按 ⌘. (Windows、Linux Ctrl+.) 以显示可用快速修复和重构的列表。

此外，代码操作小部件：包括附近的快速修复 (editor.codeActionWidget.includeNearbyQuickFixes) 是默认启用的设置，它将从 ⌘. (Windows、Linux Ctrl+.) (命令 ID editor.action.quickFix) 激活行中最接近的快速修复，无论光标在该行中的哪个位置。

该命令突出显示将使用快速修复进行重构或修复的源代码。正常的代码操作和非修复重构仍然可以在光标位置激活。

未使用的变量和无法访问的代码

未使用的 TypeScript 代码，例如始终为真的 if 语句的 else 块或未被引用的导入，在编辑器中会变淡

Unreachable source code faded out

您可以通过将光标放在未使用的代码上并触发快速修复命令 (⌘. (Windows、Linux Ctrl+.)) 或单击灯泡来快速删除此未使用的代码。

要禁用未使用的代码的淡出，请将 "editor.showUnused" 设置为 false。您还可以通过设置仅禁用 TypeScript 中未使用代码的淡出

"[typescript]": {
    "editor.showUnused":  false
},
"[typescriptreact]": {
    "editor.showUnused":  false
},

整理导入

整理导入 源代码操作对 TypeScript 文件中的导入进行排序并删除未使用的导入

您可以从 源代码操作 上下文菜单或使用 ⇧⌥O (Windows、Linux Shift+Alt+O) 键盘快捷键运行 整理导入。

通过设置以下内容，也可以在保存 TypeScript 文件时自动完成整理导入

"editor.codeActionsOnSave": {
    "source.organizeImports": "explicit"
}

在文件移动时更新导入

当您移动或重命名 TypeScript 项目中其他文件导入的文件时，VS Code 可以自动更新引用移动文件的所有导入路径。

typescript.updateImportsOnFileMove.enabled 设置控制此行为。有效的设置值是

"prompt" - 默认值。询问是否应为每个文件移动更新路径。
"always" - 始终自动更新路径。
"never" - 不自动更新路径，也不提示。

保存时代码操作

editor.codeActionsOnSave 设置允许您配置一组在保存文件时运行的代码操作。例如，您可以通过设置以下内容在保存时启用整理导入

// On explicit save, run fixAll source action. On auto save (window or focus change), run organizeImports source action.
"editor.codeActionsOnSave": {
    "source.fixAll": "explicit",
    "source.organizeImports": "always",
}

截至今天，支持以下枚举

explicit (默认值)：显式保存时触发代码操作。与 true 相同。
always：显式保存以及从窗口或焦点更改进行自动保存时触发代码操作。
never：永不触发保存时代码操作。与 false 相同。

您还可以将 editor.codeActionsOnSave 设置为要按顺序执行的代码操作数组。

以下是一些源代码操作

"organizeImports" - 在保存时启用整理导入。
"fixAll" - 保存时自动修复计算一轮中所有可能的修复（适用于包括 ESLint 在内的所有提供程序）。
"fixAll.eslint" - 仅 ESLint 自动修复。
"addMissingImports" - 在保存时添加所有缺失的导入。

有关更多信息，请参阅 TypeScript。

代码建议

VS Code 自动建议一些常见的代码简化，例如将 Promise 上的 .then 调用链转换为使用 async 和 await

将 "typescript.suggestionActions.enabled" 设置为 false 以禁用建议。

后续步骤

继续阅读以了解

编辑 TypeScript - 了解 VS Code 中用于 TypeScript 的编辑功能。
调试 TypeScript - 为你的 TypeScript 项目配置调试器。

03/05/2025