tsconfig.json配置详解


Posted in Javascript onMay 17, 2019

概述

如果一个目录下存在一个tsconfig.json文件,那么它意味着这个目录是TypeScript项目的根目录。 tsconfig.json文件中指定了用来编译这个项目的根文件和编译选项。 一个项目可以通过以下方式之一来编译:

使用tsconfig.json

  • 不带任何输入文件的情况下调用tsc,编译器会从当前目录开始去查找tsconfig.json文件,逐级向上搜索父目录。
  • 不带任何输入文件的情况下调用tsc,且使用命令行参数--project(或-p)指定一个包含tsconfig.json文件的目录。

当命令行上指定了输入文件时,tsconfig.json文件会被忽略。

示例

tsconfig.json示例文件:

使用"files"属性

{
  "compilerOptions": {
    "module": "commonjs",
    "noImplicitAny": true,
    "removeComments": true,
    "preserveConstEnums": true,
    "sourceMap": true
  },
  "files": [
    "core.ts",
    "sys.ts",
    "types.ts",
    "scanner.ts",
    "parser.ts",
    "utilities.ts",
    "binder.ts",
    "checker.ts",
    "emitter.ts",
    "program.ts",
    "commandLineParser.ts",
    "tsc.ts",
    "diagnosticInformationMap.generated.ts"
  ]
}

使用"include"和"exclude"属性

{
  "compilerOptions": {
    "module": "system",
    "noImplicitAny": true,
    "removeComments": true,
    "preserveConstEnums": true,
    "outFile": "../../built/local/tsc.js",
    "sourceMap": true
  },
  "include": [
    "src/**/*"
  ],
  "exclude": [
    "node_modules",
    "**/*.spec.ts"
  ]
}

细节

"compilerOptions"可以被忽略,这时编译器会使用默认值。在这里查看完整的编译器选项列表。

"files"指定一个包含相对或绝对文件路径的列表。 "include"和"exclude"属性指定一个文件glob匹配模式列表。 支持的glob通配符有:

  • * 匹配0或多个字符(不包括目录分隔符)
  • ? 匹配一个任意字符(不包括目录分隔符)
  • **/ 递归匹配任意子目录

如果一个glob模式里的某部分只包含*或.*,那么仅有支持的文件扩展名类型被包含在内(比如默认.ts,.tsx,和.d.ts, 如果allowJs设置能true还包含.js和.jsx)。

如果"files"和"include"都没有被指定,编译器默认包含当前目录和子目录下所有的TypeScript文件(.ts, .d.ts 和 .tsx),排除在"exclude"里指定的文件。JS文件(.js和.jsx)也被包含进来如果allowJs被设置成true。 如果指定了 "files"或"include",编译器会将它们结合一并包含进来。 使用 "outDir"指定的目录下的文件永远会被编译器排除,除非你明确地使用"files"将其包含进来(这时就算用exclude指定也没用)。

使用"include"引入的文件可以使用"exclude"属性过滤。 然而,通过 "files"属性明确指定的文件却总是会被包含在内,不管"exclude"如何设置。 如果没有特殊指定, "exclude"默认情况下会排除node_modules,bower_components,jspm_packages和<outDir>目录。

任何被"files"或"include"指定的文件所引用的文件也会被包含进来。A.ts引用了B.ts,因此B.ts不能被排除,除非引用它的A.ts在"exclude"`列表中。

需要注意编译器不会去引入那些可能做为输出的文件;比如,假设我们包含了index.ts,那么index.d.ts和index.js会被排除在外。 通常来讲,不推荐只有扩展名的不同来区分同目录下的文件。

tsconfig.json文件可以是个空文件,那么所有默认的文件(如上面所述)都会以默认配置选项编译。

在命令行上指定的编译选项会覆盖在tsconfig.json文件里的相应选项。

@types,typeRoots和types

默认所有可见的"@types"包会在编译过程中被包含进来。 node_modules/@types文件夹下以及它们子文件夹下的所有包都是可见的; 也就是说, ./node_modules/@types/,../node_modules/@types/和../../node_modules/@types/等等。

如果指定了typeRoots,只有typeRoots下面的包才会被包含进来。 比如:

{
  "compilerOptions": {
    "typeRoots" : ["./typings"]
  }
}

这个配置文件会包含所有./typings下面的包,而不包含./node_modules/@types里面的包。

如果指定了types,只有被列出来的包才会被包含进来。 比如:

{
  "compilerOptions": {
    "types" : ["node", "lodash", "express"]
  }
}

这个tsconfig.json文件将仅会包含 ./node_modules/@types/node,./node_modules/@types/lodash和./node_modules/@types/express。/@types/。 node_modules/@types/*里面的其它包不会被引入进来。

指定"types": []来禁用自动引入@types包。

注意,自动引入只在你使用了全局的声明(相反于模块)时是重要的。 如果你使用 import "foo"语句,TypeScript仍然会查找node_modules和node_modules/@types文件夹来获取foo包。

使用extends继承配置

tsconfig.json文件可以利用extends属性从另一个配置文件里继承配置。

extends是tsconfig.json文件里的顶级属性(与compilerOptions,files,include,和exclude一样)。 extends的值是一个字符串,包含指向另一个要继承文件的路径。

在原文件里的配置先被加载,然后被来至继承文件里的配置重写。 如果发现循环引用,则会报错。

来至所继承配置文件的files,include和exclude覆盖源配置文件的属性。

配置文件里的相对路径在解析时相对于它所在的文件。

比如:

configs/base.json:

{
 "compilerOptions": {
  "noImplicitAny": true,
  "strictNullChecks": true
 }
}

tsconfig.json:

{
 "extends": "./configs/base",
 "files": [
  "main.ts",
  "supplemental.ts"
 ]
}

tsconfig.nostrictnull.json:

{
 "extends": "./tsconfig",
 "compilerOptions": {
  "strictNullChecks": false
 }
}

compileOnSave

在最顶层设置compileOnSave标记,可以让IDE在保存文件的时候根据tsconfig.json重新生成文件。

{
  "compileOnSave": true,
  "compilerOptions": {
    "noImplicitAny" : true
  }
}

要想支持这个特性需要Visual Studio 2015, TypeScript1.8.4以上并且安装atom-typescript插件

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。

Javascript 相关文章推荐
js 字符串转化成数字的代码
Jun 29 Javascript
JQueryEasyUI Layout布局框架的使用
Apr 08 Javascript
JavaScript中用toString()方法返回时间为字符串
Jun 12 Javascript
jQuery实现简洁的导航菜单效果
Nov 23 Javascript
基于javascript数组实现图片轮播
May 02 Javascript
JavaScript实战之带收放动画效果的导航菜单
Aug 16 Javascript
分分钟玩转Vue.js组件(二)
Mar 01 Javascript
详解vue+vuex+koa2开发环境搭建及示例开发
Jan 22 Javascript
create-react-app构建项目慢的解决方法
Mar 14 Javascript
Vue中使用vue-i18插件实现多语言切换功能
Apr 25 Javascript
JS常见构造模式实例对比分析
Aug 27 Javascript
Nuxt页面级缓存的实现
Mar 09 Javascript
小程序云函数调用API接口的方法
May 17 #Javascript
JS实现的检验身份证格式并输出出生日期,年龄,性别,出生地示例
May 17 #Javascript
微信小程序云开发之使用云函数
May 17 #Javascript
jQuery实现的鼠标拖动画矩形框示例【可兼容IE8】
May 17 #jQuery
微信小程序云开发之使用云数据库
May 17 #Javascript
微信小程序云开发之使用云存储
May 17 #Javascript
vue-cli3 配置开发与测试环境详解
May 17 #Javascript
You might like
小偷PHP+Html+缓存
2006/12/20 PHP
第五章 php数组操作
2011/12/30 PHP
PHP中error_reporting()用法详解
2015/08/31 PHP
PHP数据库连接mysql与mysqli对比分析
2016/01/04 PHP
PHP利用Cookie设置用户30分钟未操作自动退出功能
2017/07/03 PHP
php实现JWT(json web token)鉴权实例详解
2019/11/05 PHP
javascript结合fileReader 实现上传图片
2015/01/30 Javascript
jQuery实现页面滚动时动态加载内容的方法
2015/03/20 Javascript
JavaScript jQuery 中定义数组与操作及jquery数组操作
2015/12/18 Javascript
基于javascript实现全国省市二级联动下拉选择菜单
2016/01/28 Javascript
jQuery中iframe的操作(点击按钮新增窗口)
2016/04/20 Javascript
bootstrap布局中input输入框右侧图标点击功能
2016/05/16 Javascript
JavaScript实现经典排序算法之选择排序
2016/12/28 Javascript
基于jQuery实现图片推拉门动画效果的两种方法
2017/08/26 jQuery
select标签设置默认选中的选项方法
2018/03/02 Javascript
Mint UI组件库CheckList使用及踩坑总结
2018/12/20 Javascript
详解关于Vuex的action传入多个参数的问题
2019/02/22 Javascript
layer.open回调获取弹出层参数的实现方法
2019/09/10 Javascript
通过javascript实现扫雷游戏代码实例
2020/02/09 Javascript
js 获取扫码枪输入数据的方法
2020/06/10 Javascript
python实现从字典中删除元素的方法
2015/05/04 Python
Python函数式编程指南:对生成器全面讲解
2019/11/19 Python
keras做CNN的训练误差loss的下降操作
2020/06/22 Python
css3加js做一个简单的3D行星运转效果实例代码
2017/01/18 HTML / CSS
维多利亚的秘密官方旗舰店:VICTORIA’S SECRET
2018/04/02 全球购物
Fossil美国官网:化石手表、手袋、首饰及配饰
2019/02/17 全球购物
英国领先的鞋类零售商和顶级品牌的官方零售商:Wynsors
2020/02/17 全球购物
Huda Beauty官方商店:化妆和美容产品
2020/09/05 全球购物
介绍一下Ruby的特点
2013/01/20 面试题
心理健康活动总结
2014/04/30 职场文书
教师党员个人整改措施材料
2014/09/16 职场文书
2014年行政工作总结
2014/11/19 职场文书
公司宣传语大全
2015/07/13 职场文书
2015教师节通讯稿
2015/07/20 职场文书
竞聘演讲报告:基本写作有哪些?附开头范文
2019/10/16 职场文书
微信告警的zabbix监控系统 监控整个NGINX集群
2022/04/18 Servers