jsconfig.json 是什么
谁需要这个文件?
Visual Studio Code,拥有该文件的目录会被 VS code 认为是一个 JavaScript 项目。利用其中的配置更好的为项目提供服务。
为什么需要这个文件?
为了性能。
一方面,现在,一个 JavaScript 项目所包含的代码太大了,尤其是 node_modules
和 dist
两个目录。默认情况下 VS code 也需要对这些"非源码"的代码进行分析,从而导致性能下降。
另一方面,一个代码仓库中会包含很多不同 JavaScript 项目。这些完全独立的项目被当作一个项目分析,提供智能感知[IntelliSense]非常不合理。
基于以上两种原因,通过 jsconfig.json 来明确 JavaScript 项目的文件范围,可以给用户提供高好的性能和更准确的智能感知。
如何使用
exclude
属性用来排除无需语言服务(https://github.com/microsoft/TypeScript/wiki/JavaScript-Language-Service-in-Visual-Studio)的文件。include
属性用来包含需要语言服务的文件compilerOptions
属性继承于 tsconfig.json(https://www.typescriptlang.org/docs/handbook/tsconfig-json.html),用来配置如何编译TypeScript
。具体属性列表,可查阅文档
配置 webpack aliases
大家可能遇到过,在使用 webpack aliases 时,VS code 并不能正确解析。而通过 jsconfig.json
则可以告诉浏览器,文件中那些别名的正确的解析路径
最佳实践
只要有可能,你都应该配置 exclude
属性来排除那些不属于源码的文件夹。
下面的表格列出了常见项目的安装文件夹中,应该排除的目录。
