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 相关文章推荐
如何在Mozilla Gecko 用Javascript加载XSL
Jan 09 Javascript
多浏览器支持的右下角浮动窗口
Apr 01 Javascript
JavaScript常用小技巧小结
Dec 29 Javascript
JS实现自适应高度表单文本框的方法
Feb 25 Javascript
深入学习JavaScript对象
Oct 13 Javascript
JS组件Bootstrap实现弹出框效果代码
Apr 26 Javascript
通过sails和阿里大于实现短信验证
Jan 04 Javascript
Bootstrap如何激活导航状态
Mar 22 Javascript
node.js中实现kindEditor图片上传功能的方法教程
Apr 26 Javascript
JavaScript实现反转字符串的方法详解
Apr 27 Javascript
React组件之间的通信的实例代码
Jun 27 Javascript
微信小程序实现音乐播放器
Nov 20 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版 汉字转码的实现详解
2013/06/09 PHP
探讨php define()函数及defined()函数使用详解
2013/06/09 PHP
TP(thinkPHP)框架多层控制器和多级控制器的使用示例
2018/06/13 PHP
PHP微信支付结果通知与回调策略分析
2019/01/10 PHP
PHP实现无限极分类的两种方式示例【递归和引用方式】
2019/03/25 PHP
windows 2008r2+php5.6.28环境搭建详细过程
2019/06/18 PHP
jquery1.5.1中根据元素ID获取元素对象的代码
2011/04/02 Javascript
jQuery-onload让第一次页面加载时图片是淡入方式显示
2012/05/23 Javascript
Javascript中的delete介绍
2012/09/02 Javascript
jquery实现九宫格大转盘抽奖
2015/11/13 Javascript
javascript中apply、call和bind的使用区别
2016/04/05 Javascript
JS执行控制之节流模式实例分析
2018/12/21 Javascript
详解微信小程序开发用户授权登陆
2019/04/24 Javascript
微信小程序tab切换可滑动切换导航栏跟随滚动实现代码
2019/09/04 Javascript
jQuery 选择器用法实例分析【prev + next】
2020/05/22 jQuery
[01:20]辉夜杯背景故事宣传片《辉夜传说》
2015/12/25 DOTA
Python3 正在毁灭 Python的原因分析
2014/11/28 Python
Python 迭代器工具包【推荐】
2016/05/06 Python
wxPython之解决闪烁的问题
2018/01/15 Python
python批量从es取数据的方法(文档数超过10000)
2018/12/27 Python
pandas实现to_sql将DataFrame保存到数据库中
2019/07/03 Python
10款最好的Python开发编辑器
2019/07/03 Python
Pytorch 抽取vgg各层并进行定制化处理的方法
2019/08/20 Python
Python实现元素等待代码实例
2019/11/11 Python
python序列类型种类详解
2020/02/26 Python
Python通过format函数格式化显示值
2020/10/17 Python
CSS3实现文字描边的2种方法(小结)
2020/02/14 HTML / CSS
兰蔻加拿大官方网站:Lancome加拿大
2016/08/05 全球购物
美国网上书店:Barnes & Noble
2018/08/15 全球购物
Hotels.com越南:酒店预订
2019/10/29 全球购物
用你熟悉的语言写一个连接ORACLE数据库的程序,能够完成修改和查询工作
2012/06/11 面试题
2013年学期结束动员演讲稿
2014/01/07 职场文书
毕业生找工作自荐书
2014/06/30 职场文书
党员廉洁自律个人总结
2015/02/13 职场文书
爱心捐款活动总结
2015/05/09 职场文书
python画条形图的具体代码
2022/04/20 Python