VsCode的jsconfig.json配置文件说明详解

功能简单说明:jsconfig.json有了它,可以对文件目录检索做智能提示,宝宝再也不用两眼发酸的丑目录写引入文件的地址了,一路上下键选择回车搞定。

jsconfig.json是什么?

如果你的项目中有一个 jsconfig.json文件的话,这个文件的配置可以对你的文件所在目录下的所有js代码做出个性化支持。
jsconfig.json的配置是tsconfig.json的子集。

webpack aliases的支持

如果我们在我们的webpack里面配置的路径的别名,心细的小朋友就发现了. 我们的vscode不能根据别名路径导入的包跳转文件了.所以我们还需要jsconfig.json的支持。

{
  "compilerOptions": {
    "baseUrl": ".",
    "paths": {
      "@component": ["./src/component"]
    }
  }
}

以下详细说明:

目录中出现 jsconfig.json 文件表明该目录是 JavaScript 项目的根目录。 Json 文件指定了根文件和 JavaScript 语言服务提供的特性的选项。

提示: 如果你不使用 JavaScript,你不需要担心 jsconfig.json。

提示: jsconfig.json 是 tsconfig.json 的后代,后者是 TypeScript 的配置文件。 Json 是 tsconfig.json,“ allowJs”属性设置为 true。

为什么我需要一个 jsconfig.json 文件

因为VsCode的 JavaScript 支持可以在两种不同的模式下运行:

  • Scope-no jsconfig.json: 文件在这种模式下,在 Visual Studio Code 中打开的 JavaScript 文件被视为独立的单元。 只要文件 a.js 没有显式引用文件 b.ts (使用 import 或 CommonJS 模块) ,这两个文件之间就不存在通用的项目上下文。
  • Explicit Project-with jsconfig.json: JavaScript 项目通过 jsconfig.json 文件定义。 目录中出现这样的文件表明该目录是 JavaScript 项目的根目录。 文件本身可以选择列出属于项目的文件、要从项目中排除的文件以及编译器选项(见下文)。

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

Location of jsconfig.json

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

image

在更复杂的项目中,您可能在工作区中定义了多个 jsconfig.json 文件。 您希望这样做,这样一个项目中的代码就不会被建议作为 IntelliSense 在另一个项目中进行编码。 下面是一个带有客户端和服务器文件夹的项目,展示了两个独立的 JavaScript 项目。

image

例子

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

使用 “exclude”

Exclude 属性(glob 模式)告诉语言服务哪些文件不是源代码的一部分。 这使性能保持在一个高水平。 如果 IntelliSense 速度慢,则向排除列表添加文件夹(如果检测到速度慢,VS 代码将提示您这样做)。

{
 "compilerOptions": {
 "module": "commonjs",
 "target": "es6"
 },
 "exclude": ["node_modules"]
}

提示: 您希望排除由构建过程生成的文件(例如,dist 目录)。 这些文件将导致建议显示两次,并将减缓智能感知。

使用 “include”

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

{
 "compilerOptions": {
 "module": "commonjs",
 "target": "es6"
 },
 "include": ["src/**/*"]
}

提示: exclude 和 include 中的文件路径相对于 jsconfig.json 的位置

jsconfig Options 选项

下面是 jsconfig“ compilerOptions”来配置 JavaScript 语言支持。

compilerOptions

提示: 不要被 compilerOptions 搞糊涂了。 这个属性之所以存在,是因为 jsconfig.json 是 tsconfig.json 的后代,后者用于编译打字稿。

属性 描述
nolib 不要包含默认的库文件(lib.d.ts)
target 指定要使用的默认库(lib.d.ts)。值为 "es3", "es5", "es6", "es2015", "es2016", "es2017", "es2018", "es2019", "es2020", "esnext".
module 在生成模块代码时指定模块系统。值为“ amd”、“ commonJS”、“ es2015”、“ es6”、“ esnext”、“ none”、“ system”、“ umd”
moduleResolution 指定如何解析导入模块。值为“node”和“classic”
checkJs 启用 JavaScript 文件的类型检查
experimentalDecorators 为提议的 ES 装饰器提供实验支持
allowSyntheticDefaultImports 允许从没有默认导出的模块进行默认导入。这不影响代码,只是进行类型检查
baseUrl 解析非相关模块名称的基础目录
paths 指定相对于 baseUrl 选项计算的路径映射

您可以在TypeScript compilerOptions documentation .文档中了解有关可用 compilerOptions 的更多信息。

使用 webpack 别名

要使用 webpack 别名,智能感知需要使用 glob 模式指定路径键。

例如,使用 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 排除 tmp 及 temp 文件目录
jspm 排除 jspm_packages 文件目录

当你的 JavaScript 项目变得太大而且性能降低时,通常是因为类似node_modules的库文件夹。 如果 VS 代码检测到项目变得太大,它将提示您编辑exclude。

提示:有时无法正确选择更改配置,例如添加或编辑jsconfig.json文件。 运行Reload JavaScript Project命令应重新加载项目并获取更改。

使用TypeScript编译器进行低级编译

当tsc用于将ES6 JavaScript向下级编译为旧版本时,jsconfig.json中的以下编译器选项适用:

选项 描述
module 指定模块代码生成。 值为“commonjs”,“system”,“umd”,“amd”,“es6”,“es2015”
diagnostics 显示诊断信息。
emitBOM 在输出文件的开头发出UTF-8字节顺序标记(BOM)。
inlineSourceMap 使用源映射发出单个文件,而不是使用单独的文件。
inlineSources 在单个文件中将源与源图一起发出; 需要设置--inlineSourceMap。
jsx 指定JSX代码生成:“保留”或“反应”?。
reactNamespace 指定在针对'react'JSX发出的目标时为createElement和__spread调用的对象。
mapRoot 将位置指定为字符串中的uri,其中调试器应该找到映射文件而不是生成的位置。
noEmit 不发起输出。
noEmitHelpers 不在编译输出中生成自定义辅助函数,如__extends。
noEmitOnError 如果报告任何类型检查错误,不发起输出。
noResolve 不将三斜杠引用或模块导入目标解析为输入文件。
outFile 连接并将输出发送到单个文件。
outDir 将输出结构重定向到目录。
removeComments 不向输出发出注释。
rootDir 指定输入文件的根目录。用于通过--outDir控制输出目录结构。
sourceMap 生成相应的'.map'文件。
sourceRoot 指定调试器应该找到JavaScript文件而不是源位置的位置。
stripInternal 不为具有'@internal'注释的代码发出声明。
watch 监听输入文件。
emitDecoratorMetadata 在源中为装饰声明发出设计类型元数据。
noImplicitUseStrict 不在模块输出中发出“use strict”指令。
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,029评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,395评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,570评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,535评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,650评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,850评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,006评论 3 408
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,747评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,207评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,536评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,683评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,342评论 4 330
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,964评论 3 315
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,772评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,004评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,401评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,566评论 2 349