typescript之tsconfig.json配置文件解释

380 阅读5分钟

本章解释一下tsconfig.json配置文件解释

tsconfig.json官网地址

include:表示编译时需要编译的文件或目录,例如:

{
"include": [
    "src/", //src下的所有文件、包含子目录

    "types/"//types下的所有文件、包含子目录
  ]
}

exclude:表示编译时需要排除编译的文件或目录,例如:

默认排除node_modules文件夹下文件

{
"exclude": [
    "src/lib", // src/lib下的所有文件、包含子目录不会被编译
  ]
}

extends:引入其它的配置文件,并继承配置,例如:

{
    "extends": "./tsconfig.base.json" //基础配置抽离到此文件,然后引入继承
}

files:表示编译时需要编译的单个文件列表,例如:

{
"files": [
    "src/a.ts", //指定编译src目录下的a.ts文件
  ]
}

compileOnSave:设置保存文件的时候自动编译,例如:

vscode暂不支持该功能,可以使用Atom编辑器

{
"compileOnSave": true
}

compilerOptions:配置编译选项,例如:

编译选项配置非常繁杂,有很多配置,这里只列出常用的配置。

{
    "compilerOptions": {
        "target":"es5", //指编译后的版本目录语言
        "module": "esnext", //项目编译后代码使用的模板标准
        "lib": ["DOM", "ES2015"], //TS项目运行时需要使用的库,即声明文件,es5 默认引用dom、es5、scripthost,如需要使用es的高级版本特性,通常都需要配置,如es8的数组新特性需要引入"ES2019.Array",
        "rootDir": "./src", //项目编译目录(编译时从哪个目录开始查找编译)
        "outDir": "./dist", // 项目编译后的文件输出的地址
        "outFile": "./app.js", // 将多个相互依赖的文件生成一个文件,可以用在AMD模块中,即开启时应设置"module": "AMD",
        "baseUrl": "./", // 解析非相对模块的基地址,默认是当前目录,减少繁琐的 import from '../../'相对引入,配置此属性后只用于代码开发层面的提示,需要配置alias别名解析才可使用!
        "esModuleInterop": true, //允许export=导出,由import from 导入
        "strict": true, // 严格模式,开启类型严格检查
        "strictNullChecks": true, // 开启null、undefined检查
        "skipLibCheck": true, // 是否跳过声明文件的类型检查,这可以在编译期间以牺牲类型系统准确性为代价来节省时间
        "moduleResolution": "node",// 模块解析策略,ts默认用node的解析策略,即相对的方式导入
        "incremental": true, // TS编译器在第一次编译之后会生成一个存储编译信息的文件,第二次编译会在第一次的基础上进行增量编译,可以提高编译的速度
        "tsBuildInfoFile": "./buildFile", // 增量编译文件的存储位置(需搭配incremental属性使用)
        "listEmittedFiles": true, // 编译完成后控制台打印输出文件
        "listFiles": true// 打印编译的文件(包括引用的声明文件)
        "diagnostics": true, // 打印诊断信息,用于控制台用于调试的诊断信息
        "allowJS": true, // 允许编译器编译JS,JSX文件
        "checkJs": true, // 允许在JS文件中报错,通常搭配allowJS属性一起使用
        "declaration": true, // 生成声明文件,开启后会自动生成声明文件 
        "declarationDir": "./file", // 指定生成声明文件存放目录 
        "emitDeclarationOnly": true, // 只生成声明文件,而不会生成js文件
        "sourceMap": true, // 生成目标文件的sourceMap文件 
        "inlineSourceMap": true, // 生成目标文件的inline SourceMap,inline SourceMap会包含在生成的js文件中 
        "declarationMap": true, // 为声明文件生成sourceMap 
        "typeRoots": [], // 声明文件目录,默认时node_modules/@types 
        "types": [], // 加载的声明文件包 
        "removeComments":true, // 删除注释 
        "noEmit": true, // 不输出文件,即编译后不会生成任何js文件 
        "noEmitOnError": true, // 发送错误时不输出任何文件
        "noEmitHelpers": true, // 不生成helper函数,减小体积,需要额外安装,常配合importHelpers一起使用 
        "importHelpers": true, // 通过tslib引入helper函数,文件必须是模块
        "downlevelIteration": true, // 降级遍历器实现,如果目标源是es3/5,那么遍历器会有降级的实现
        "alwaysStrict": true, // 在代码中注入'use strict' 
        "noImplicitAny": true, // 不允许隐式的any类型 
        "strictFunctionTypes": true, // 不允许函数参数双向协变 
        "strictPropertyInitialization": true, // 类的实例属性必须初始化 
        "strictPropertyInitialization": true, // 类的实例属性必须初始化 
        "strictBindCallApply": true, // 严格的bind/call/apply检查
        "noImplicitThis": true, // 不允许this有隐式的any类型 
        "noUnusedLocals": true, // 检查只声明、未使用的局部变量(只提示不报错) 
        "noUnusedParameters": true, // 检查未使用的函数参数(只提示不报错) 
        "noFallthroughCasesInSwitch": true, // 防止switch语句贯穿(即如果没有break语句后面不会执行) 
        "noImplicitReturns": true, //每个分支都会有返回值 
        "allowUmdGlobalAccess": true, // 允许在模块中全局变量的方式访问umd模块
        "paths": { // 路径映射,相对于baseUrl 
        // 如使用jq时不想使用默认版本,而需要手动指定版本,可进行如下配置 
            "jquery": ["node_modules/jquery/dist/jquery.min.js"] 
        },
        "rootDirs": ["src","out"], // 将多个目录放在一个虚拟目录下,用于运行时,即编译后引入文件的位置可能发生变化,这也设置可以虚拟src和out在同一个目录下,不用再去改变路径也不会报错
    }
}

references:指定工程引用依赖,例如:

在项目开发中,有时候我们为了方便将前端项目和后端node项目放在同一个目录下开发,两个项目依赖同一个配置文件和通用文件,但我们希望前后端项目进行灵活的分别打包,那么我们可以进行如下配置:

image.png