TypeScript - 编译和配置

# 编译选项

# 自动编译文件

编译文件时，使用 -w 指令后，TS 编译器会自动监视文件的变化，并在文件发生变化时对文件进行重新编译。

示例：

tsc xxx.ts -w

# 自动编译整个项目

如果直接使用 tsc 指令，则可以自动将当前项目下的所有 ts 文件编译为 js 文件。

但是能直接使用 tsc 命令的前提时，要先在项目根目录下创建一个 ts 的配置文件 tsconfig.json。

tsconfig.json 是 TS 编译器的配置文件，TS 编译器可以根据它的信息来对代码进行编译。添加配置文件后，只需只需 tsc 命令即可完成对整个项目的编译。

# 配置选项

# include

• 用来表示需要被编译的 TS 文件目录
• 默认值：["**/*"]
• 路径: ** 表示任意目录, * 表示任意文件

示例：

"include": [
    "src/**/*",
    "tests/**/*"
]

上述示例中，所有 src 目录和 tests 目录下的文件都会被编译。

# exclude

• 用来表示不需要被编译的文件目录
• 默认值：["node_modules", "bower_components", "jspm_packages"]

示例：

"exclude": [
    "./src/hello/**/*"
]

上述示例中，src 下 hello 目录下的文件都不会被编译

# extends

• 定义被继承的配置文件

示例：

// 表示当前配置文件中会自动包含 config 目录下 base.json 中的所有配置信息
"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"
    }
    

    1
    2
    3
    

  • 如上设置，我们所编写的 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"
    }
    

    1
    2
    3
    4
    5
    6
    

• module：设置编译后代码使用的模块化系统

  • 可选值：CommonJS、UMD、AMD、System、ES2020、ESNext、None

  • 示例：

    "compilerOptions": {
        "module": "CommonJS"
    }
    

    1
    2
    3
    

• outDir：编译后文件的所在目录。默认情况下，编译后的 js 文件会和 ts 文件位于相同的目录，设置 outDir 后可以改变编译后文件的位置

  • 示例：

    "compilerOptions": {
        "outDir": "dist"
    }
    

    1
    2
    3
    

    设置后编译后的 js 文件将会生成到 dist 目录

• outFile：将所有的文件编译为一个 js 文件。默认会将所有的编写在全局作用域中的代码合并为一个 js 文件，如果 module 制定了 None、System 或 AMD 则会将模块一起合并到文件之中

  • 示例：

    "compilerOptions": {
        "outFile": "dist/app.js"
    }
    

    1
    2
    3
    

• rootDir：指定代码的根目录，默认情况下编译后文件的目录结构会以最长的公共目录为根目录，通过 rootDir 可以手动指定根目录

  • 示例：

    "compilerOptions": {
        "rootDir": "./src"
    }
    

    1
    2
    3
    

• allowJs：是否对 js 文件编译

• checkJs：是否对 js 文件进行检查

  • 示例：

    "compilerOptions": {
        "allowJs": true,
        "checkJs": true
    }
    

    1
    2
    3
    4
    

• 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

"compilerOptions": {
    // target 用来指定 ts 被编译为 ES 的版本
    // 'es3', 'es5', 'es6', 'es2015', 'es2016', 'es2017', 'es2018', 'es2019', 'es2020', 'esnext'.
    "target": "es2015",

    // module 指定要使用的模块化的规范
    //'none', 'commonjs', 'amd', 'system', 'umd', 'es6', 'es2015', 'es2020', 'esnext'
    "module": "es2015",

    // lib 用来指定项目所用的库
    // "lib": []，一般情况下不需要设置（浏览器运行的就不用管，nodejs 运行的再根据实际使用去指定）
    // 可选值：'es5', 'es6', 'es2015', 'es7', 'es2016', 'es2017', 'es2018', 'es2019', 'es2020', 'esnext', 'dom', 
    // 'dom.iterable', 'webworker', 'webworker.importscripts', 'webworker.iterable', 'scripthost', 'es2015.core', 'es2015.collection', 
    // 'es2015.generator', 'es2015.iterable', 'es2015.promise', 'es2015.proxy', 'es2015.reflect', 'es2015.symbol', 'es2015.symbol.wellknown', 'es2016.array.include',
    //  'es2017.object', 'es2017.sharedmemory', 'es2017.string', 'es2017.intl', 'es2017.typedarrays', 'es2018.asyncgenerator', 'es2018.asynciterable', 'es2018.intl', 
    // 'es2018.promise', 'es2018.regexp', 'es2019.array', 'es2019.object', 'es2019.string', 'es2019.symbol', 'es2020.bigint', 'es2020.promise', 
    // 'es2020.sharedmemory', 'es2020.string', 'es2020.symbol.wellknown', 'es2020.intl', 'esnext.array', 'esnext.symbol', 'esnext.asynciterable', 'esnext.intl',

    // outDir 用来指定编译后文件所在的目录
    "outDir": "./dist",

    // outFile 将代码合并为一个文件
    // 设置 outFile 后，所有的全局作用域中的代码会合并到同一个文件中
    // "outFile": "./dist/app.js",

    // 是否对 js 文件进行编译，默认是 false
    "allowJs": true,

    // 是否检查 js 代码是否符合语法规范，默认值是 false
    "checkJs": true,

    // 是否移除注释
    "removeComments": true,

    // 不生成编译后的文件
    "noEmit": false,

    // 当有错误时不生成编译文件
    "noEmitOnError": true,

    // 所有严格检查的总开关，包括下面四个（如果相同的话可以直接用这个，下面四个省略）
    "strict": true,

    // 用来设置编译后的文件是否使用严格模式，默认是 false
    "alwaysStrict": true,

    // 不允许隐式的 any 类型
    "noImplicitAny": true,

    // 不允许不明确类型的 this
    "noImplicitThis": true,

    // 严格检查空值
    "strictNullChecks": true
}