Visual Studio Code 中的 JavaScript

Visual Studio Code 内置了 JavaScript IntelliSense、调试、格式化、代码导航、重构以及许多其他高级语言功能。

这些功能中的大多数都可以开箱即用，而有些功能可能需要基本配置才能获得最佳体验。本页总结了 VS Code 自带的 JavaScript 功能。VS Code Marketplace 中的扩展可以增强或更改这些内置功能中的大部分。有关这些功能如何工作以及如何配置的更深入指南，请参阅使用 JavaScript。

IntelliSense

IntelliSense 为您显示智能代码补全、悬停信息和签名信息，以便您能够更快速、更准确地编写代码。

VS Code 在您的 JavaScript 项目中提供 IntelliSense；适用于许多 npm 库，例如 React、lodash 和 express；以及其他平台，例如 node、无服务器或物联网。

有关 VS Code 的 JavaScript IntelliSense、如何配置它以及帮助解决常见 IntelliSense 问题的更多信息，请参阅使用 JavaScript。

JavaScript 项目 (jsconfig.json)

一个 jsconfig.json 文件在 VS Code 中定义了一个 JavaScript 项目。虽然 jsconfig.json 文件不是必需的，但在某些情况下您会希望创建一个，例如：

• 如果您的工作区中的并非所有 JavaScript 文件都应被视为单个 JavaScript 项目的一部分。jsconfig.json 文件允许您将某些文件从 IntelliSense 的显示中排除。
• 为了确保工作区中的一部分 JavaScript 文件被视为一个项目。如果您正在处理使用隐式全局依赖项而非 imports 来处理依赖关系的旧代码，这会很有用。
• 如果您的工作区包含多个项目上下文，例如前端和后端 JavaScript 代码。对于多项目工作区，请在每个项目的根文件夹中创建一个 jsconfig.json 文件。
• 您正在使用 TypeScript 编译器来降级编译 JavaScript 源代码。

要定义一个基本的 JavaScript 项目，请在工作区的根目录下添加一个 jsconfig.json 文件：

{
  "compilerOptions": {
    "module": "CommonJS",
    "target": "ES6"
  },
  "exclude": ["node_modules"]
}

有关更高级的 jsconfig.json 配置，请参阅使用 JavaScript。

代码片段

VS Code 包含基本的 JavaScript 代码片段，它们会在您输入时被建议；

有许多扩展提供了额外的代码片段，包括针对 Redux 或 Angular 等流行框架的代码片段。您甚至可以定义您自己的代码片段。

JSDoc 支持

VS Code 理解许多标准的 JSDoc 注释，并使用这些注释来提供丰富的 IntelliSense。您甚至可以选择性地使用 JSDoc 注释中的类型信息来对您的 JavaScript 进行类型检查。

通过在函数声明前输入 /** 并选择 JSDoc 注释代码片段建议，可以快速为函数创建 JSDoc 注释。

要禁用 JSDoc 注释建议，请设置 "javascript.suggest.completeJSDocs": false。

悬停信息

将鼠标悬停在 JavaScript 符号上，可以快速查看其类型信息和相关文档。

键盘快捷键 ⌘K ⌘I (Windows、Linux 为 Ctrl+K Ctrl+I) 可以在当前光标位置显示此悬停信息。

签名帮助

当您编写 JavaScript 函数调用时，VS Code 会显示有关函数签名的信息，并高亮显示您当前正在完成的参数。

当您在函数调用中输入 ( 或 , 时，签名帮助会自动显示。按 ⇧⌘Space (Windows、Linux 为 Ctrl+Shift+Space) 可以手动触发签名帮助。

自动导入

自动导入通过建议整个项目及其依赖项中的可用变量来加快编码速度。当您选择其中一个建议时，VS Code 会自动在文件顶部为其添加一个 import 语句。

只需开始输入，即可查看当前项目中所有可用 JavaScript 符号的建议。自动导入建议会显示它们将从何处导入。

如果您选择了其中一个自动导入建议，VS Code 会为其添加一个 import 语句。

在此示例中，VS Code 将来自 material-ui 的 Button 的 import 语句添加到了文件顶部。

要禁用自动导入，请将 "javascript.suggest.autoImports" 设置为 false。

粘贴时添加导入

当您在编辑器之间复制和粘贴代码时，VS Code 可以在粘贴代码时自动添加导入。当您粘贴包含未定义符号的代码时，会显示一个粘贴控件，让您选择是作为纯文本粘贴还是添加导入。

此功能默认启用，但您可以通过切换 javascript.updateImportsOnPaste.enabled 设置来禁用它。

您可以通过配置 editor.pasteAs.preferences 设置，将带导入的粘贴作为默认行为，而不显示粘贴控件。包含 text.updateImports.jsts 或 text.updateImports 可以在粘贴时始终添加导入。

组织导入

组织导入源操作可以对 JavaScript 文件中的 import 语句进行排序，并移除任何未使用的导入。

您可以从源操作上下文菜单运行组织导入，或者使用键盘快捷键 ⇧⌥O (Windows、Linux 为 Shift+Alt+O)。

通过设置以下选项，也可以在保存 JavaScript 文件时自动组织导入：

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

文件移动时更新导入

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

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

• "prompt" - 默认值。每次移动文件时询问是否应更新路径。
• "always" - 总是自动更新路径。
• "never" - 不自动更新路径，也不提示。

格式化

VS Code 的内置 JavaScript 格式化程序提供了具有合理默认值的基本代码格式化功能。

javascript.format.* 设置可配置内置格式化程序。或者，如果内置格式化程序造成了妨碍，请将 "javascript.format.enable" 设置为 false 以禁用它。

对于更特殊的代码格式化样式，请尝试从 Marketplace 安装其中一个 JavaScript 格式化扩展。

JSX 和自动闭合标签

VS Code 的所有 JavaScript 功能也适用于 JSX。

您可以在普通的 *.js 文件和 *.jsx 文件中使用 JSX 语法。

VS Code 还包含 JSX 特定的功能，例如 JSX 标签的自动闭合。

将 "javascript.autoClosingTags" 设置为 false 以禁用 JSX 标签闭合。

代码导航

代码导航让您可以快速浏览 JavaScript 项目。

• 转到定义 F12 - 转到符号定义的源代码。
• 速览定义 ⌥F12 (Windows 为 Alt+F12，Linux 为 Ctrl+Shift+F10) - 弹出一个速览窗口，显示符号的定义。
• 转到引用 ⇧F12 (Windows、Linux 为 Shift+F12) - 显示符号的所有引用。
• 转到类型定义 - 转到定义符号的类型。对于类的实例，这将显示类本身，而不是实例的定义位置。

您可以通过命令面板 (⇧⌘P (Windows、Linux 为 Ctrl+Shift+P)) 中的转到符号命令来进行符号搜索导航。

• 转到文件中的符号 ⇧⌘O (Windows、Linux 为 Ctrl+Shift+O)
• 转到工作区中的符号 ⌘T (Windows、Linux 为 Ctrl+T)

重命名

按 F2 可在您的 JavaScript 项目中重命名光标下的符号。

重构

VS Code 为 JavaScript 提供了一些方便的重构功能，例如提取函数和提取常量。只需选择您想要提取的源代码，然后单击编辑器边栏中的灯泡图标或按 (⌘. (Windows、Linux 为 Ctrl+.)) 来查看可用的重构。

可用的重构包括：

• 提取到方法或函数。
• 提取为常量。
• 在命名导入和命名空间导入之间转换。
• 移动到新文件。

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

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

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

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

未使用的 JavaScript 代码，例如一个恒为 true 的 if 语句的 else 块或一个未被引用的导入，会在编辑器中以淡化形式显示。

您可以通过将光标放在这些未使用的代码上并触发快速修复命令 (⌘. (Windows、Linux 为 Ctrl+.)) 或点击灯泡图标来快速移除它们。

要禁用淡化显示未使用的代码，请将 "editor.showUnused" 设置为 false。您也可以通过以下设置仅在 JavaScript 中禁用淡化显示未使用的代码：

"[javascript]": {
    "editor.showUnused":  false
},
"[javascriptreact]": {
    "editor.showUnused":  false
},

保存时代码操作

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" - 在保存时添加所有缺失的导入。

更多信息请参阅 Node.js/JavaScript。

代码建议

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

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

使用 AI 增强补全

GitHub Copilot 是一款由 AI 驱动的代码补全工具，可以帮助你更快、更智能地编写代码。你可以在 VS Code 中使用 GitHub Copilot 扩展来生成代码，或从其生成的代码中学习。

GitHub Copilot 为多种语言和各种框架提供建议，在 Python、JavaScript、TypeScript、Ruby、Go、C# 和 C++ 方面表现尤为出色。

你可以在Copilot 文档中了解更多关于如何开始使用 Copilot 的信息。

一旦您安装并启用了 Copilot 扩展，就可以在您的 JavaScript 项目中进行测试。

创建一个新文件 - 您可以在命令面板 (F1) 中使用文件：新建文件命令。

在 JavaScript 文件中，输入以下函数头：

function calculateDaysBetweenDates(begin, end) {

Copilot 将提供如下建议 - 使用 Tab 键接受建议。

内联提示

内联提示向源代码中添加额外的内联信息，以帮助您理解代码的功能。

参数名称内联提示显示函数调用中参数的名称。

这可以帮助您一目了然地理解每个参数的含义，这对于接受布尔标志或参数容易混淆的函数特别有用。

要启用参数名称提示，请设置 javascript.inlayHints.parameterNames。有三个可能的值：

• none — 禁用参数内联提示。
• literals — 仅为字面量（字符串、数字、布尔值）显示内联提示。
• all — 为所有参数显示内联提示。

变量类型内联提示显示没有显式类型注释的变量的类型。

设置：javascript.inlayHints.variableTypes.enabled

属性类型内联提示显示没有显式类型注释的类属性的类型。

设置：javascript.inlayHints.propertyDeclarationTypes.enabled

参数类型提示显示隐式类型参数的类型。

设置：javascript.inlayHints.parameterTypes.enabled

返回类型内联提示显示没有显式类型注释的函数的返回类型。

设置：javascript.inlayHints.functionLikeReturnTypes.enabled

引用 CodeLens

JavaScript 引用 CodeLens 为类、方法、属性和导出的对象显示内联的引用计数。

要启用引用 CodeLens，请将 "javascript.referencesCodeLens.enabled" 设置为 true。

点击引用计数可以快速浏览引用列表。

Linter

Linter 会对可疑代码提供警告。虽然 VS Code 不包含内置的 JavaScript linter，但市场上有许多 JavaScript linter 扩展可用。

类型检查

您也可以在常规的 JavaScript 文件中利用 TypeScript 的一些高级类型检查和错误报告功能。这是捕捉常见编程错误的好方法。这些类型检查还为 JavaScript 启用了一些令人兴奋的快速修复功能，包括添加缺失的导入和添加缺失的属性。

TypeScript 尝试像在 .ts 文件中一样在 .js 文件中推断类型。当无法推断类型时，可以使用 JSDoc 注释明确指定。您可以在使用 JavaScript中阅读更多关于 TypeScript 如何使用 JSDoc 进行 JavaScript 类型检查的内容。

JavaScript 的类型检查是可选的，并且需要手动开启。现有的 JavaScript 验证工具（如 ESLint）可以与内置的类型检查功能一起使用。

调试

VS Code 对 JavaScript 提供了出色的调试支持。可以设置断点、检查对象、导航调用堆栈以及在调试控制台中执行代码。请参阅调试主题了解更多信息。

调试客户端

您可以使用浏览器调试器来调试您的客户端代码，例如我们为 Edge 和 Chrome 内置的调试器，或者 Debugger for Firefox。

调试服务器端

使用内置调试器在 VS Code 中调试 Node.js。设置很简单，并且有一个Node.js 调试教程来帮助您。

热门扩展

VS Code 自带对 JavaScript 的出色支持，但您还可以通过扩展安装调试器、代码片段、linter 和其他 JavaScript 工具。

后续步骤

继续阅读以了解：

• 使用 JavaScript - 关于 VS Code 的 JavaScript 支持以及如何解决常见问题的更详细信息。
• jsconfig.json - jsconfig.json 项目文件的详细描述。
• IntelliSense - 了解更多关于 IntelliSense 以及如何为您的语言有效使用它。
• 调试 - 了解如何为你的应用程序设置调试。
• Node.js - 创建 Express Node.js 应用程序的演练。
• TypeScript - VS Code 对 TypeScript 有很好的支持，它为您的 JavaScript 代码带来了结构和强类型。

常见问题

VS Code 支持 JSX 和 React Native 吗？

VS Code 支持 JSX 和 React Native。您将通过从 npmjs 类型声明文件仓库自动下载的类型声明 (typings) 文件获得 React/JSX 和 React Native 的 IntelliSense。此外，您还可以从 Marketplace 安装流行的 React Native 扩展。

要为 React Native 启用 ES6 导入语句，您需要将 allowSyntheticDefaultImports 编译器选项设置为 true。这会告诉编译器创建合成的默认成员，然后您就可以获得 IntelliSense。React Native 在后台使用 Babel 来创建带有默认成员的正确运行时代码。如果您还想调试 React Native 代码，可以安装 React Native 扩展。

VS Code 是否支持 Dart 编程语言和 Flutter 框架？

是的，有适用于 Dart 和 Flutter 开发的 VS Code 扩展。您可以在 Flutter.dev 文档中了解更多信息。

IntelliSense 对外部库不起作用

自动类型获取适用于通过 npm (在 package.json 中指定)、Bower (在 bower.json 中指定) 下载的依赖项，以及您文件夹结构中列出的许多最常见的库 (例如 jquery-3.1.1.min.js)。

ES6 风格的导入不起作用。

当您想使用 ES6 风格的导入，但某些类型声明 (typings) 文件尚未使用 ES6 风格的导出时，请将 TypeScript 编译器选项 allowSyntheticDefaultImports 设置为 true。

{
  "compilerOptions": {
    "module": "CommonJS",
    "target": "ES6",
    // This is the line you want to add
    "allowSyntheticDefaultImports": true
  },
  "exclude": ["node_modules", "**/node_modules/*"]
}

我可以调试被压缩/混淆过的 JavaScript 吗？

是的，可以。您可以在 Node.js 调试主题中看到使用 JavaScript source map 实现这一点。

当我使用非 ES6 结构时，如何禁用语法验证？

一些用户希望使用像提议中的管道 (|>) 操作符这样的语法结构。然而，这些目前不被 VS Code 的 JavaScript 语言服务支持，并被标记为错误。对于仍希望使用这些未来功能的用户，我们提供了 javascript.validate.enable 设置。

通过设置 javascript.validate.enable: false，您可以禁用所有内置的语法检查。如果您这样做，我们建议您使用像 ESLint 这样的 linter 来验证您的源代码。

我可以使用像 Flow 这样的其他 JavaScript 工具吗？

可以，但 Flow 的一些语言功能（如类型和错误检查）可能会干扰 VS Code 内置的 JavaScript 支持。要了解如何禁用 VS Code 内置的 JavaScript 支持，请参阅禁用 JavaScript 支持。