现已推出!阅读有关 11 月的新功能和修复。

Visual Studio Code 中的 JavaScript

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

Working with JavaScript in Visual Studio Code

大多数这些功能都可以直接使用,而某些功能可能需要基本配置才能获得最佳体验。此页面概述了 VS Code 附带的 JavaScript 功能。VS Code 市场中的扩展可以增强或更改这些内置功能中的大多数。有关这些功能如何工作以及如何配置的更深入指南,请参阅使用 JavaScript

IntelliSense

IntelliSense 向您显示智能代码补全、悬停信息和签名信息,以便您可以更快、更正确地编写代码。

VS Code 在您的 JavaScript 项目中提供 IntelliSense;对于许多 npm 库(如 Reactlodashexpress)以及其他平台(如 node、serverless 或 IoT)。

有关 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

提示

要检查 JavaScript 文件是否属于 JavaScript 项目的一部分,只需在 VS Code 中打开该文件并运行JavaScript:转到项目配置命令。此命令将打开引用 JavaScript 文件的 jsconfig.json。如果该文件不属于任何 jsconfig.json 项目,则会显示通知。

代码片段

VS Code 包括在您键入时建议的基本 JavaScript 代码片段

有许多扩展提供了其他代码片段,包括针对 Redux 或 Angular 等常用框架的代码片段。您甚至可以定义自己的代码片段

提示

要禁用代码片段建议,请在您的设置文件中将editor.snippetSuggestions设置为 "none"editor.snippetSuggestions 设置还允许您更改代码片段在建议中的显示位置:顶部 ("top")、底部 ("bottom") 或内联按字母顺序排序 ("inline")。默认值为 "inline"

JSDoc 支持

VS Code 了解许多标准JSDoc 注释,并使用这些注释提供丰富的IntelliSense。您可以选择使用 JSDoc 注释中的类型信息来类型检查您的 JavaScript

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

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

悬停信息

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

Hovering over a JavaScript variable to see its type information

⌘K ⌘I(Windows,Linux Ctrl+K Ctrl+I键盘快捷方式会在当前光标位置显示此悬停信息。

签名帮助

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

Signature help for some DOM methods

当您在函数调用中键入 (, 时,会自动显示签名帮助。按 ⇧⌘Space(Windows,Linux Ctrl+Shift+Space 手动触发签名帮助。

自动导入

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

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

Global symbols are shown in the suggestion list

如果您选择这些自动导入建议之一,VS Code 将为其添加一个导入。

在此示例中,VS Code 从 material-uiButton 添加一个导入到文件的顶部

After selecting a symbol from a different file, an import is added for it automatically

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

提示

VS Code 尝试推断要使用的最佳导入样式。您可以使用javascript.preferences.quoteStylejavascript.preferences.importModuleSpecifier设置来显式配置添加到代码的导入的首选引号样式和路径样式。

粘贴时添加导入

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

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

您可以配置 editor.pasteAs.preferences 设置,使粘贴时自动添加导入成为默认行为,而无需显示粘贴控件。包含 text.updateImports.jststext.updateImports 以在粘贴时始终添加导入。

组织导入

整理导入 源操作会对 JavaScript 文件中的导入进行排序,并删除任何未使用的导入。

您可以从源操作上下文菜单或使用 ⇧⌥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

JSX IntelliSense

您可以在普通的 *.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 项目中重命名光标下的符号

Renaming a variable

重构

VS Code 包括一些方便的 JavaScript 重构功能,例如提取函数提取常量。只需选择您要提取的源代码,然后单击装订线中的灯泡或按 (⌘. (Windows, Linux Ctrl+.)) 以查看可用的重构。

JavaScript refactoring

可用的重构包括

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

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

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

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

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

编辑器中会淡出未使用的 JavaScript 代码,例如始终为 true 的 if 语句的 else 代码块或未引用的导入

Unreachable source code faded out

您可以通过将光标放在其上并触发“快速修复”命令 (⌘. (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 调用转换为使用 asyncawait

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

使用 AI 增强补全

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

GitHub Copilot extension in the VS Code Marketplace

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

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

安装并启用 Copilot 扩展后,您可以在 JavaScript 项目中对其进行测试。

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

在 JavaScript 文件中,键入以下函数头

function calculateDaysBetweenDates(begin, end) {

Copilot 将提供如下所示的建议 - 使用 Tab 接受建议

Copilot JavaScript ghost text suggestion

嵌入提示

内嵌提示会向源代码添加额外的内联信息,以帮助您理解代码的作用。

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

Parameter name inlay hints

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

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

  • none — 禁用参数内嵌提示。
  • literals — 仅显示文字(字符串、数字、布尔值)的内嵌提示。
  • all — 显示所有参数的内嵌提示。

变量类型内嵌提示显示没有显式类型批注的变量的类型。

设置:javascript.inlayHints.variableTypes.enabled

Variable type inlay hints

属性类型内嵌提示显示没有显式类型批注的类属性的类型。

设置:javascript.inlayHints.propertyDeclarationTypes.enabled

Property type inlay hints

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

设置:javascript.inlayHints.parameterTypes.enabled

Parameter type inlay hints

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

设置:javascript.inlayHints.functionLikeReturnTypes.enabled

Return type inlay hints

引用 CodeLens

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

JavaScript references CodeLens

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

单击引用计数以快速浏览引用列表

JavaScript references CodeLens peek

代码检查器

Linter 为可疑的代码提供警告。虽然 VS Code 不包含内置的 JavaScript Linter,但 Marketplace 中提供了许多 JavaScript Linter 扩展

提示

此列表是从 VS Code Marketplace 动态查询的。阅读描述和评论,以确定该扩展是否适合您。

类型检查

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

Using type checking and Quick Fixes in a JavaScript file

TypeScript 尝试以与 .ts 文件相同的方式在 .js 文件中推断类型。当无法推断类型时,可以使用 JSDoc 注释显式指定类型。您可以在使用 JavaScript中阅读更多关于 TypeScript 如何使用 JSDoc 进行 JavaScript 类型检查的信息。

JavaScript 的类型检查是可选的,并且是选择加入的。现有的 JavaScript 验证工具(例如 ESLint)可以与内置的类型检查功能一起使用。

调试

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

调试客户端

您可以使用浏览器调试器调试客户端代码,例如我们为 Edge 和 Chrome 提供的内置调试器,或 Firefox 调试器

调试服务端

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

debug data inspection

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

提示

上面显示的扩展是动态查询的。单击上面的扩展磁贴以阅读描述和评论,以决定哪个扩展最适合您。请在Marketplace中查看更多信息。

后续步骤

请继续阅读以了解

  • 使用 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 支持 JSXReact Native。您将从 npmjs 类型声明文件存储库中自动下载的类型声明(typings)文件中获取 React/JSXReact Native 的 IntelliSense。此外,您还可以从 Marketplace 安装流行的 React Native 扩展

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

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

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

IntelliSense 不适用于外部库

Automatic Type Acquisition 适用于 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 源代码映射的工作原理。

当使用非 ES6 结构时,如何禁用语法验证?

有些用户希望使用像建议的管道 (|>) 运算符这样的语法结构。但是,这些结构目前不受 VS Code 的 JavaScript 语言服务支持,并且被标记为错误。对于仍然想使用这些未来功能的用户,我们提供了 javascript.validate.enable 设置

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

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

可以,但是 Flow 的某些语言特性(例如类型和错误检查)可能会干扰 VS Code 的内置 JavaScript 支持。要了解如何禁用 VS Code 的内置 JavaScript 支持,请参阅禁用 JavaScript 支持