首页 > 技术文章 > TypeScript 之 tsconfig.json

cag2050 2018-08-31 10:41 原文

  • https://m.runoob.com/manual/gitbook/TypeScript/_book/doc/handbook/tsconfig.json.html

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

  • "compilerOptions"可以被忽略,这时编译器会使用默认值。

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

    • 匹配0或多个字符(不包括目录分隔符)
  1. ? 匹配0或一个任意字符(不包括目录分隔符)
  2. **/ 递归匹配任意子目录
  • 正则规则:
符号 匹配
  • | 零次或多次
  • | 一次或多次
    ?| 零次或一次
  • 如果一个glob模式里的某部分只包含或.,那么仅有支持的文件扩展名类型被包含在内(比如默认.ts,.tsx,和.d.ts, 如果allowJs设置为true还包含.js和.jsx)。

  • "files"和"include"

  1. 如果"files"和"include"都没有被指定,编译器默认包含当前目录和子目录下所有的TypeScript文件(.ts, .d.ts 和 .tsx),排除在"exclude"里指定的文件。
    JS文件(.js和.jsx)也被包含进来如果allowJs被设置成true。
  2. 如果指定了"files"或"include",编译器会将它们结合一并包含进来。
  3. 使用"outDir"指定的目录下的文件永远会被编译器排除,除非你明确地使用"files"将其包含进来(这时就算用exclude指定也没用)。
  • 使用"include"引入的文件可以使用"exclude"属性过滤。 然而,通过"files"属性明确指定的文件却总是会被包含在内,不管"exclude"如何设置。
    如果没有特殊指定,"exclude"默认情况下会排除node_modules,bower_components,和jspm_packages目录。

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

  • tsconfig.json文件可以是个空文件,那么所有默认的文件(如上面所述)都会以默认配置选项编译。
    在命令行上指定的编译选项会覆盖在tsconfig.json文件里的相应选项。

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

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

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

  • 使用extends继承配置
    tsconfig.json文件可以利用extends属性从另一个配置文件里继承配置。
    extends是tsconfig.json文件里的顶级属性(与compilerOptions,files,include,exclude一样)。 extends的值是一个字符串,指向要继承文件的路径。
    在原文件里的配置先被加载,然后被来自继承文件里的配置重写。 如果发现循环引用,则会报错。
    继承文件里的files,include和exclude,覆盖该配置文件的属性。
    配置文件里的相对路径在解析时相对于它所在的文件。

推荐阅读