一、编译选项与配置文件
- 自动编译文件
- 编译文件时，使用 -w 指令后，TS编译器会自动监视文件的变化，并在文件发生变化时对文件进行重新编译。
- 示例：
- tsc xxx.ts -w
- 自动编译整个项目
- 如果直接使用tsc指令，则可以自动将当前项目下的所有ts文件编译为js文件。
- 但是能直接使用tsc命令的前提时，要先在项目根目录下创建一个ts的配置文件 tsconfig.json
- tsconfig.json是一个JSON文件，添加配置文件后，只需只需 tsc 命令即可完成对整个项目的编译
- 配置选项：
- include
- 定义希望被编译文件所在的目录
- 默认值：["**/*"]
- 示例：
- "include":["src/**/*", "tests/**/*"]
- 上述示例中，所有src目录和tests目录下的文件都会被编译
- exclude
- 定义需要排除在外的目录
- 默认值：["node_modules", "bower_components", "jspm_packages"]
- 示例：
- "exclude": ["./src/hello/**/*"]
- 上述示例中，src下hello目录下的文件都不会被编译
- extends
- 定义被继承的配置文件
- 示例：
- "extends": "./configs/base"
- 上述示例中，当前配置文件中会自动包含config目录下base.json中的所有配置信息
- files
- 指定被编译文件的列表，只有需要编译的文件少时才会用到
- 示例：
- "files": [ "core.ts", "sys.ts", "types.ts", "scanner.ts", "parser.ts", "utilities.ts", "binder.ts", "checker.ts", "tsc.ts" ]
- 列表中的文件都会被TS编译器所编译
- compilerOptions
- 编译选项是配置文件中非常重要也比较复杂的配置选项
- 在compilerOptions中包含多个子选项，用来完成对编译的配置
- 项目选项
- target
- 设置ts代码编译的目标版本
- 可选值：
- ES3（默认）、ES5、ES6/ES2015、ES7/ES2016、ES2017、ES2018、ES2019、ES2020、ESNext
- 示例：
- "compilerOptions": { "target": "ES6" }
- 如上设置，我们所编写的ts代码将会被编译为ES6版本的js代码
- lib
- 指定代码运行时所包含的库（宿主环境）
- 可选值：
- ES5、ES6/ES2015、ES7/ES2016、ES2017、ES2018、ES2019、ES2020、ESNext、DOM、WebWorker、ScriptHost ......
- 示例：
- "compilerOptions": { "target": "ES6", "lib": ["ES6", "DOM"], "outDir": "dist", "outFile": "dist/aa.js" }
- module
- 设置编译后代码使用的模块化系统
- 可选值：
- CommonJS、UMD、AMD、System、ES2020、ESNext、None
- 示例：
- "compilerOptions": { "module": "CommonJS" }
- outDir
- 编译后文件的所在目录
- 默认情况下，编译后的js文件会和ts文件位于相同的目录，设置outDir后可以改变编译后文件的位置
- 示例：
- "compilerOptions": { "outDir": "dist" }
- 设置后编译后的js文件将会生成到dist目录
- outFile
- 将所有的文件编译为一个js文件
- 默认会将所有的编写在全局作用域中的代码合并为一个js文件，如果module制定了None、System或AMD则会将模块一起合并到文件之中
- 示例：
- "compilerOptions": { "outFile": "dist/app.js" }
- rootDir
- 指定代码的根目录，默认情况下编译后文件的目录结构会以最长的公共目录为根目录，通过rootDir可以手动指定根目录
- 示例：
- "compilerOptions": { "rootDir": "./src" }
- allowJs
- 是否对js文件编译
- checkJs
- 是否对js文件进行检查
- 示例：
- "compilerOptions": { "allowJs": true, "checkJs": true }
- removeComments
- 是否删除注释
- 默认值：false
- noEmit
- 不对代码进行编译
- 默认值：false
- sourceMap
- 是否生成sourceMap
- 默认值：false
- 严格检查
- strict
- 启用所有的严格检查，默认值为true，设置后相当于开启了所有的严格检查
- alwaysStrict
- 总是以严格模式对代码进行编译
- noImplicitAny
- 禁止隐式的any类型
- noImplicitThis
- 禁止类型不明确的this
- strictBindCallApply
- 严格检查bind、call和apply的参数列表
- strictFunctionTypes
- 严格检查函数的类型
- strictNullChecks
- 严格的空值检查
- strictPropertyInitialization
- 严格检查属性是否初始化
- 额外检查
- noFallthroughCasesInSwitch
- 检查switch语句包含正确的break
- noImplicitReturns
- 检查函数没有隐式的返回值
- noUnusedLocals
- 检查未使用的局部变量
- noUnusedParameters
- 检查未使用的参数
- 高级
- allowUnreachableCode
- 检查不可达代码
- 可选值：
- true，忽略不可达代码
- false，不可达代码将引起错误
- noEmitOnError
- 有错误的情况下不进行编译
- 默认值：false
- include
1.0、生成tsconfig.json文件
在目录下使用tsc --init 生成tsconfig.json文件
1.1、tsconfig.json 的作⽤
- ⽤于标识 TypeScript 项⽬的根路径；
- ⽤于配置 TypeScript 编译器；
- ⽤于指定编译的⽂件。
1.2、tsconfig.json 重要字段
- files - 设置要编译的⽂件的名称；
- include - 设置需要进⾏编译的⽂件，⽀持路径模式匹配；
- exclude - 设置⽆需进⾏编译的⽂件，⽀持路径模式匹配；
- compilerOptions - 设置与编译流程相关的选项。
使用"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"
]
}1.3、compilerOptions 选项
compilerOptions ⽀持很多选项，常⻅的有 baseUrl 、 target 、 moduleResolution 和 lib 等。
compilerOptions 每个选项的详细说明如下：
{
"compilerOptions": {
/* 基本选项 */
"target": "es5", // 指定 ECMAScript ⽬标版本: 'ES3'(default), 'ES5', 'ES6'/'ES2015', 'ES2016', 'ES2017', or 'ESNEXT'
"module": "commonjs", // 指定使⽤模块: 'commonjs', 'amd','system', 'umd' or 'es2015'
"lib": [], // 指定要包含在编译中的库⽂件
"allowJs": true, // 允许编译 javascript ⽂件
"checkJs": true, // 报告 javascript ⽂件中的错误
"jsx": "preserve", // 指定 jsx 代码的⽣成: 'preserve','react-native', or 'react'
"declaration": true, // ⽣成相应的 '.d.ts' ⽂件
"sourceMap": true, // ⽣成相应的 '.map' ⽂件
"outFile": "./", // 将输出⽂件合并为⼀个⽂件
"outDir": "./", // 指定输出⽬录
"rootDir": "./", // ⽤来控制输出⽬录结构 --outDir.
"removeComments": true, // 删除编译后的所有的注释
"noEmit": true, // 不⽣成输出⽂件
"importHelpers": true, // 从 tslib 导⼊辅助⼯具函数
"isolatedModules": true, // 将每个⽂件做为单独的模块 （与'ts.transpileModule' 类似）.
/* 严格的类型检查选项 */
"strict": true, // 启⽤所有严格类型检查选项
"noImplicitAny": true, // 在表达式和声明上有隐含的 any类型时报错
"strictNullChecks": true, // 启⽤严格的 null 检查
"noImplicitThis": true, // 当 this 表达式值为 any 类型的时候，⽣成⼀个错误
"alwaysStrict": true, // 以严格模式检查每个模块，并在每个⽂件⾥加
⼊ 'use strict'
/* 额外的检查 */
"noUnusedLocals": true, // 有未使⽤的变量时，抛出错误
"noUnusedParameters": true, // 有未使⽤的参数时，抛出错误
"noImplicitReturns": true, // 并不是所有函数⾥的代码都有返回值时，抛出错误
"noFallthroughCasesInSwitch": true, // 报告 switch 语句的 fallthrough 错误。（即，不允许 switch 的 case 语句贯穿）
/* 模块解析选项 */
"moduleResolution": "node", // 选择模块解析策略： 'node' (Node.js)
or 'classic' (TypeScript pre-1.6)
"baseUrl": "./", // ⽤于解析⾮相对模块名称的基⽬录
"paths": {}, // 模块名到基于 baseUrl 的路径映射的列表
"rootDirs": [], // 根⽂件夹列表，其组合内容表示项⽬运⾏时的结构内容
"typeRoots": [], // 包含类型声明的⽂件列表
"types": [], // 需要包含的类型声明⽂件名列表
"allowSyntheticDefaultImports": true, // 允许从没有设置默认导出的模块中默认导⼊。
/* Source Map Options */
"sourceRoot": "./", // 指定调试器应该找到 TypeScript ⽂件⽽不是源⽂件的位置
"mapRoot": "./", // 指定调试器应该找到映射⽂件⽽不是⽣成⽂件的位置
"inlineSourceMap": true, // ⽣成单个 soucemaps ⽂件，⽽不是将sourcemaps ⽣成不同的⽂件
"inlineSources": true, // 将代码与 sourcemaps ⽣成到⼀个⽂件中，要求同时设置了 --inlineSourceMap 或 --sourceMap 属性
/* 其他选项 */
"experimentalDecorators": true, // 启⽤装饰器
"emitDecoratorMetadata": true // 为装饰器提供元数据的⽀持
}
}二、声明文件
2.1、为什么需要声明文件
初始化项目
代码语言：javascript复制$ mkdir test-declare
$ cd test-declare
$ npm init -y
$ yarn add typescript -D
$ npx tsc --init创建 src/sum/index.js 文件，内容如下： 这是一个最普通不过的 js 文件，对外暴露 sum () 方法，在 nodejs 中运行。
代码语言：javascript复制function sum(a, b) {
return a b
}
module.exports = sum创建 src/index.ts 文件，内容如下： （这是一个 ts 文件，在 ts 文件中导入 js 文件）
代码语言：javascript复制import sum from './sum'
console.log(sum(2, 2))这时，如果使用 Vscode 编辑代码，应该可以看到如下的报错：意思就是没找到 sum 文件的声明文件。
为什么会报这个错误？
typescript 编译器看到的每个变量、方法都必须明确知道它的类型，在 src/index.ts 文件中导入 src/sum/index.js 文件，js 文件中的方法是没有类型的，造成 typescript 不能识别的错误。
解决方法也很简单，编辑 tsconfig.json 文件：
代码语言：javascript复制"allowJs": true,
"outDir": "./dist",
"rootDir": "./src",其中 allowJs 配置告诉 typescript 编辑器将 js 文件中的所有变量和方法都设置 any 类型，这样 typescript 编译器就能识别 js 文件了。
添加配置后报错消失，鼠标移动到 sum () 方法可以看到方法参数确确实实都设置为 any 类型了。
此时目录结构应该如下：
代码语言：javascript复制|-- test-declare
|-- src
|-- sum
|-- index.js
|-- index.ts
|-- package.json
|-- tsconfig.json编译代码
打开黑窗口，编译代码，编译完成后根目录下会生成 dist 目录。
代码语言：javascript复制$ npx tsc -w启动程序
另外打开一个黑窗口，运行程序，可以看到打印出计算结果。
代码语言：javascript复制$ node dist/index.js
$ 4虽然 ts 文件中可以导入 js 文件，并正常运行程序，但但但但但但是，js 文件的方法类型全是 any 很恶心。
我们希望为 js 文件里的变量和方法添加真实的类型，这就需要定义声明文件。
2.2、定义类型声明文件
创建 src/sum/index.d.ts 文件，内容如下：
代码语言：javascript复制declare function sum(a: number, b: number): number
export default sum此时再查看 src/index.ts 文件，可以看到导入的 sum () 方法的参数已经有类型提示了。
