在 VS Code 中尝试

jsconfig.json

什么是 jsconfig.json?

目录中存在 jsconfig.json 文件表示该目录是 JavaScript 项目的根目录。jsconfig.json 文件指定了根文件和 JavaScript 语言服务提供的功能的选项。

提示:如果您不使用 JavaScript,则无需担心 jsconfig.json

提示:jsconfig.jsontsconfig.json 的子集,后者是 TypeScript 的配置文件。jsconfig.jsontsconfig.json"allowJs" 属性设置为 true

为什么我需要 jsconfig.json 文件?

Visual Studio Code 的 JavaScript 支持可以以两种不同的模式运行

  • 文件范围 - 无 jsconfig.json:在此模式下,在 Visual Studio Code 中打开的 JavaScript 文件被视为独立的单元。只要文件 a.js 不显式引用文件 b.ts(无论是使用 import 还是 CommonJS 模块),这两个文件之间就没有共同的项目上下文。

  • 显式项目 - 包含 jsconfig.json:JavaScript 项目通过 jsconfig.json 文件定义。目录中存在这样的文件表示该目录是 JavaScript 项目的根目录。文件本身可以选择列出属于项目的文件、要从项目中排除的文件以及编译器选项(见下文)。

当您的工作区中有一个 jsconfig.json 文件定义了项目上下文时,JavaScript 体验会得到改善。因此,当您在新工作区中打开 JavaScript 文件时,我们会提示您创建一个 jsconfig.json 文件。

jsconfig.json 的位置

通过创建 jsconfig.json 文件,我们将这部分代码(网站的客户端)定义为 JavaScript 项目。将该文件放在 JavaScript 代码的根目录下,如下图所示。

jsconfig setup

在更复杂的项目中,您可能在工作区中定义了多个 jsconfig.json 文件。您可能希望这样做,以便一个项目中的代码不会作为 IntelliSense 建议给另一个项目中的代码。下图显示了一个包含 clientserver 文件夹的项目,展示了两个独立的 JavaScript 项目。

multiple jsconfigs

示例

默认情况下,JavaScript 语言服务将分析并为 JavaScript 项目中的所有文件提供 IntelliSense。您需要指定要排除或包含的文件,以便提供正确的 IntelliSense。

使用 "exclude" 属性

exclude 属性(一个 glob 模式)告诉语言服务哪些文件不是源代码的一部分。这有助于保持高性能。如果 IntelliSense 速度缓慢,请将文件夹添加到您的 exclude 列表中(如果 VS Code 检测到速度变慢,它会提示您这样做)。

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

提示:您需要 exclude 构建过程生成的文件(例如,dist 目录)。这些文件会导致建议重复出现并降低 IntelliSense 的速度。

使用 "include" 属性

或者,您可以使用 include 属性(一个 glob 模式)显式设置项目中的文件。如果没有 include 属性,则默认包含包含目录和子目录中的所有文件。指定 include 属性时,只包含这些文件。以下是具有显式 include 属性的示例。

{
  "compilerOptions": {
    "module": "CommonJS",
    "target": "ES6"
  },
  "include": ["src/**/*"]
}

提示:excludeinclude 中的文件路径是相对于 jsconfig.json 的位置。

jsconfig 选项

以下是用于配置 JavaScript 语言支持的 jsconfig "compilerOptions"

提示:不要对 compilerOptions 感到困惑,因为 JavaScript 不需要实际编译。此属性的存在是因为 jsconfig.jsontsconfig.json 的子集,后者用于编译 TypeScript。

选项 描述
noLib 不包含默认库文件 (lib.d.ts)
target 指定要使用的默认库 (lib.d.ts)。可选值为 "ES3"、"ES5"、"ES6"、"ES2015"、"ES2016"、"ES2017"、"ES2018"、"ES2019"、"ES2020"、"ES2021"、"ES2022"、"ES2023"、"ESNext"。
module 指定生成模块代码时的模块系统。可选值为 "AMD"、"CommonJS"、"ES2015"、"ES2020"、"ES2022"、"ES6"、"Node16"、"NodeNext"、"ESNext"、"None"、"System"、"UMD"。
moduleResolution 指定如何解析导入的模块。可选值为 "Node"、"Classic"、"Node16"、"NodeNext"、"Bundler"。
checkJs 启用 JavaScript 文件的类型检查。
experimentalDecorators 为提议的 ES 装饰器启用实验性支持。
allowSyntheticDefaultImports 允许从没有默认导出的模块进行默认导入。这不影响代码发出,只影响类型检查。
baseUrl 解析非相对模块名称的基础目录。
paths 指定相对于 baseUrl 选项计算的路径映射。

您可以在 TypeScript compilerOptions 文档中阅读更多关于可用 compilerOptions 的信息。

使用 webpack 别名

为了使 IntelliSense 与 webpack 别名配合使用,您需要使用 glob 模式指定 paths 键。

例如,对于别名 'ClientApp'

{
  "compilerOptions": {
    "baseUrl": ".",
    "paths": {
      "ClientApp/*": ["./ClientApp/*"]
    }
  }
}

然后使用别名

import Something from 'ClientApp/foo';

最佳实践

在可能的情况下,您应该排除不属于项目源代码的 JavaScript 文件所在的文件夹。

提示:如果您的工作区中没有 jsconfig.json,VS Code 默认会排除 node_modules 文件夹。

下表列出了常见项目组件及其建议排除的安装文件夹:

组件 要排除的文件夹
node 排除 node_modules 文件夹
webpack, webpack-dev-server 排除内容文件夹,例如 dist
bower 排除 bower_components 文件夹
ember 排除 tmptemp 文件夹
jspm 排除 jspm_packages 文件夹

当您的 JavaScript 项目变得太大导致性能下降时,通常是因为像 node_modules 这样的库文件夹。如果 VS Code 检测到您的项目变得太大,它会提示您编辑 exclude 列表。