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 相关文章推荐
jQuery ui 1.7更新小结
Aug 15 Javascript
js显示文本框提示文字的方法
May 07 Javascript
jQuery实现分隔条左右拖动功能
Nov 21 Javascript
利用jquery制作滚动到指定位置触发动画
Mar 26 Javascript
JavaScript中对象的不同创建方法
Aug 12 Javascript
vuejs绑定class和style样式
Apr 11 Javascript
微信小程序单选radio及多选checkbox按钮用法示例
Apr 30 Javascript
微信小程序中悬浮窗功能的实现代码
Aug 02 Javascript
微信小程序实现单个卡片左滑显示按钮并防止上下滑动干扰功能
Dec 06 Javascript
JS数组进阶示例【数组的几种函数用法】
Jan 16 Javascript
JavaScript实现Excel表格效果
Feb 07 Javascript
js实现踩五彩块游戏
Feb 08 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应用提速面面观
2006/10/09 PHP
php sprintf()函数让你的sql操作更安全
2008/07/23 PHP
PHP 正则表达式常用函数
2014/08/17 PHP
PHP实现微信申请退款功能
2018/10/01 PHP
PHP快速排序算法实现的原理及代码详解
2019/04/03 PHP
图片按比例缩放函数
2006/06/26 Javascript
利用javascript解决图片缩放及其优化的代码
2012/05/23 Javascript
JavaScript自执行闭包的小例子
2013/06/29 Javascript
关于js内存泄露的一个好例子
2013/12/09 Javascript
10个很棒的jQuery代码片段
2015/09/24 Javascript
基于Node.js的强大爬虫 能直接发布抓取的文章哦
2016/01/10 Javascript
用JavaScript获取页面文档内容的实现代码
2016/06/10 Javascript
jQuery的Cookie封装,与PHP交互的简单实现
2016/10/05 Javascript
AJAX在JQuery中的应用详解
2019/01/30 jQuery
详解JavaScript对数组操作(添加/删除/截取/排序/倒序)
2019/04/28 Javascript
vue.js中导出Excel表格的案例分析
2019/06/11 Javascript
Vue状态模式实现窗口停靠功能(灵动、自由, 管理后台Admin界面)
2020/03/06 Javascript
Python中用Ctrl+C终止多线程程序的问题解决
2013/03/30 Python
python虚拟环境的安装配置图文教程
2017/10/20 Python
pandas修改DataFrame列名的方法
2018/04/08 Python
python日期时间转为字符串或者格式化输出的实例
2018/05/29 Python
Python面向对象总结及类与正则表达式详解
2019/04/18 Python
python不使用for计算两组、多个矩形两两间的iou方式
2020/01/18 Python
Python解释器及PyCharm工具安装过程
2020/02/26 Python
解决pycharm 格式报错tabs和space不一致问题
2021/02/26 Python
html5跨域通讯之postMessage的用法总结
2013/11/07 HTML / CSS
HTML5 在canvas中绘制矩形附效果图
2014/06/23 HTML / CSS
美国特价机票专家:Airfarewatchdog
2018/01/24 全球购物
酒店办公室文员岗位职责
2013/12/18 职场文书
迟到检讨书800字
2014/01/13 职场文书
安全大检查反思材料
2014/01/31 职场文书
阿德的梦教学反思
2014/02/06 职场文书
经典广告词大全
2014/03/14 职场文书
工厂门卫的岗位职责
2014/07/27 职场文书
jquery插件实现搜索历史
2021/04/24 jQuery
python中字符串String及其常见操作指南(方法、函数)
2022/04/06 Python