在 VS Code 中试用

重构 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 重构包括:

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

    Triggering the extract method refactoring on a selection

    选择“提取到方法”或“提取到函数”重构后,输入提取的方法/函数的名称。

  • 提取到常量 - 将选定的表达式提取到文件中的新常量。

    Extracting a constant from a selection

  • 将类型提取到接口或类型别名 - 将选定的复杂类型提取到接口或类型别名。

    Extract an inline type to an interface

  • 移动到新文件 - 将文件顶层范围中的一个或多个类、函数、常量或接口移动到新文件。新文件的名称是根据所选符号的名称推断的。

    Moving a class to a new file

  • 在命名导入和命名空间导入之间转换 - 在命名导入(import { Name } from './foo')和命名空间导入(import * as foo from './foo')之间转换。

    Converting a named import to a namespace import

  • 在默认导出和命名导出之间转换 - 从使用 export default 转换为具有命名导出(export const Foo = ...)。

  • 将参数转换为解构对象 - 重写一个接受长参数列表的函数,使其接受单个参数对象。

  • 生成 get 和 set 访问器 - 通过为其生成 getter 和 setter 来封装选定的类属性。

    Generating getters and setters from class property

  • 推断函数返回类型 - 为函数添加显式返回类型注解。

    The Infer function return type refactoring in action

  • 从箭头函数添加/移除大括号 - 将单行箭头函数转换为多行,反之亦然。

快速修复

快速修复是针对简单编码错误的建议编辑。快速修复示例包括:

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

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

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

该命令会高亮显示将通过快速修复进行重构或修复的源代码。普通的代码操作和非修复重构仍可在光标位置激活。

未使用的变量和不可达代码

未使用的 TypeScript 代码,例如始终为 true 的 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 调用链转换为使用 asyncawait

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

后续步骤

继续阅读以了解: