"files": [
   "core.ts",
   "sys.ts",
   "types.ts",
   "scanner.ts",
   "parser.ts",
   "utilities.ts",
   "binder.ts",
   "checker.ts",
   "tsc.ts"
]

列表中的文件都会被TS编译器所编译

  • 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、为什么需要声明文件

    初始化项目

    $ mkdir test-declare 
    $ cd test-declare
    $ npm init -y
    $ yarn add typescript -D
    $ npx tsc --init
    

    创建 src/sum/index.js 文件,内容如下: 这是一个最普通不过的 js 文件,对外暴露 sum () 方法,在 nodejs 中运行。

    function sum(a, b) {
        return a + b
    module.exports = sum
    

    创建 src/index.ts 文件,内容如下: (这是一个 ts 文件,在 ts 文件中导入 js 文件)

    import sum from './sum'
    console.log(sum(2, 2))
    

    这时,如果使用 Vscode 编辑代码,应该可以看到如下的报错:意思就是没找到 sum 文件的声明文件。

    为什么会报这个错误?

    typescript 编译器看到的每个变量、方法都必须明确知道它的类型,在 src/index.ts 文件中导入 src/sum/index.js 文件,js 文件中的方法是没有类型的,造成 typescript 不能识别的错误。

    解决方法也很简单,编辑 tsconfig.json 文件:

    "allowJs": true,
    "outDir": "./dist",
    "rootDir": "./src",
    

    其中 allowJs 配置告诉 typescript 编辑器将 js 文件中的所有变量和方法都设置 any 类型,这样 typescript 编译器就能识别 js 文件了。

    添加配置后报错消失,鼠标移动到 sum () 方法可以看到方法参数确确实实都设置为 any 类型了。

    此时目录结构应该如下:

    |-- test-declare
        |-- src
            |-- sum
                |-- index.js
            |-- index.ts
        |-- package.json
        |-- tsconfig.json
    

    打开黑窗口,编译代码,编译完成后根目录下会生成 dist 目录。

    $ npx tsc -w
    

    另外打开一个黑窗口,运行程序,可以看到打印出计算结果。

    $ node dist/index.js
    

    虽然 ts 文件中可以导入 js 文件,并正常运行程序,但但但但但但是,js 文件的方法类型全是 any 很恶心。

    我们希望为 js 文件里的变量和方法添加真实的类型,这就需要定义声明文件。

    2.2、定义类型声明文件

    创建 src/sum/index.d.ts 文件,内容如下:

    declare function sum(a: number, b: number): number
    export default sum
    

    此时再查看 src/index.ts 文件,可以看到导入的 sum () 方法的参数已经有类型提示了。👍

    此时目录结构为:

    |-- test-declare
        |-- src
            |-- sum
                |-- index.js
                |-- index.d.ts      <=== 类型声明文件
            |-- index.ts
        |-- package.json
        |-- tsconfig.json
    

    2.3、给第三方库写声明文件

    很多第三方库是用 js 写的,通过设置 allowJs: true 配置可以在 typescript 工程使用这些库,但是没法知道库里面变量的类型以及方法参数的类型,很不友好。

    我们期待:在 Vscode 开发时,只要敲出方法,编辑器可以自行提示该方法参数的类型是什么,这样我就不会把原本该写成数值类型的参数写成字符串类型了,大大降低代码出错风险。

    如果你是第三方库作者

    如果您是第三方库的作者,我们希望您在自己的库里就添加上声明文件。

    手动创建 node_modules/subtract 模拟第三方库,切换到 subtract 目录下执行 $ npm init -y 初始化 subtract 工程。

    |-- test-declare
        |-- node_modules   <=== 手动创建 subtract 模拟第三方库 
            |-- subtract
                |-- src
                    |-- index.js
                |-- index.d.ts
                |-- package.json
        |-- src
        |-- ....
    

    编辑 node_modules/subtract/src/index.js 文件,内容如下:

    function subtract(a, b) {
        return a - b
    module.exports = subtract
    

    编辑 node_modules/subtract/index.d.js 文件,内容如下:

    declare function subtract(a: number, b: number): number
    export default subtract
    

    修改 package.json 文件,其中 types 指向声明文件路径。

    "main": "./src/index.js",
    "types": "./index.d.ts",
    

    实测发现,外部库找第三方库声明文件默认路径为第三方库 (subtract) 根目录下的 index.d.ts 文件,找不到的话,会去找第三方库 package.json 中 types 字段中设置的路径。

    编辑 src/index.ts 文件,导入 subtract 库并执行方法,鼠标移动到 subtract () 方法上,可以看到也是有参数类型提示的,测试成功。

    如果你是第三方库的使用者

    如果您是第三方库的使用者,您是没法直接修改第三方库的源码,只能改自己的代码。

    手动创建 node_modules/multiply 模拟第三方库,切换到 multiply 目录下执行 $ npm init -y 初始化 multiply 工程。

    |-- test-declare
        |-- node_modules   <=== 手动创建 multiply 模拟第三方库 
            |-- multiply
                |-- index.js
                |-- package.json
        |-- src
        |-- ....
    

    编辑 test-declare/node_modules/multiply/index.js 文件:

    function multiply(a, b) {
        return a * b
    module.exports = multiply
    

    修改 test-declare/src/index.ts 文件,导入 multiply 模块,可以看到报错:没有找到 multiply 模块的声明文件。

    报错信息也提供了两种解决方案:

  • npm install @types/multiply 这种方案前提是有人已经写好了声明文件,我们可以直接安装下就哦了;
  • add a new declaration(.d.ts) file containing "declare module multiply" 如果没有 @types/multiply 包,还可以在根目录下新建 global.d.ts,内容写上 declare module 'multiply'。这样做只能保证代码不报错,但是鼠标移动到 multiply 上面是没有参数类型提示的,这明显不是我们想要的。
  • (如果前面创建了 global.d.ts,删除它)

    创建 test-declare/types/multiply/index.d.ts 文件写声明文件,types 下目录的名字一定要和第三方库的名字一毛一样,这里为第三方库 multiply 写声明文件,因此创建 types/multiply 目录。

    declare function multiply(a: number, b: number): number
    export default multiply
    

    编辑 tsconfig.json 文件,告诉 typescirpt 去哪里找我们自己定义的声明文件。

    "baseUrl": "./",
    "paths": {
        "*": [ "types/*" ]
    

    回过头看下 src/index.ts 文件,multiply () 方法的参数类型已经可以显示了。

    此时目录结构为:

    |-- test-declare
        |-- ...
        |-- src
        |-- types
            |-- multiply
                |-- index.d.ts        <=== 声明文件
        |-- ....
    

    2.4、如何写声明文件

    还剩最后一个话题,如何编写声明文件,这需要掌握 Typescript 基本语法。

    导出一个方法

    上面👆写的所有声明方法都是对外暴露一个方法,暴露变量类似。

    源码 index.js

    function divide (a, b) {
        return a / b
    

    为 index.js 编写声明文件:

    // index.d.ts
    declare function divide(a: number, b: number): number
    export default divide
    

    导出一个对象字面量

    想要导出一个对象字面量,这个对象字面量内包含了很多方法和变量,如何做?

    源码 my-math.js

    function multiply(a, b) {
        return a * b
    function divide(a, b) {
        return a / b
    const num1 = 4
    const num2 = 2
    module.exports = {
        multiply, divide, num1, num2
    

    使用 namespace 对外导出一个对象字面量,对应的声明文件:

    // index.d.ts
    declare namespace obj {
        function multiply(a: number, b: number): number
        function divide(a: number, b: number): number
        const num1: number
        const num2: number
    export default obj
    
    // index.ts
    import math from 'multiply'
    console.log(math.multiply(math.num1, math.num2))

    三、webpack

    请先看完:https://www.cnblogs.com/best/p/10083024.html

    3.1、打包项目

    创建一个项目文件夹并 初始化项目 npm init -y

    生成 package.json 配置文件

    修改文件, 增加 bulid 命令 "build": "webpack",

    <meta charset="UTF-8" /> <meta http-equiv="X-UA-Compatible" content="IE=edge" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title><%=htmlWebpackPlugin.options.title %></title> </head> <body></body> </html>

    <%=%>这是ejs的语法,获取标题。

  • 安装 webpack 插件, 使的打包后会自动创建 html 文件, 并自动引入相关的 js 文件
    npm i -D html-webpack-plugin

    配置 webpack.config.js 文件

  • 安装时要注意版本兼容问题, webpack 5 版本不兼容 比较高版本的 webpack-dev-server, 所以这里安装的是 npm i -D webpack-dev-server@3.11.2
  • 配置 package.json 文件 "serve": "webpack serve --open chrome.exe",
  • 插件源码与使用方法:https://github.com/johnagan/clean-webpack-plugin#options-and-defaults-optional
  • 引入插件并配置

    npm i -D webpack webpack-cli webpack-dev-server typescript ts-loader clean-webpack-plugin

    共安装了7个包

    webpack

    构建工具webpack

    const path = require("path");
    const HtmlWebpackPlugin = require("html-webpack-plugin");
    const { CleanWebpackPlugin } = require("clean-webpack-plugin");

    module.exports = {
       optimization:{
           minimize: false // 关闭代码压缩,可选
      },

       entry: "./src/index.ts",
       
       devtool: "inline-source-map",
       
       devServer: {
           contentBase: './dist'
      },

       output: {
           path: path.resolve(__dirname, "dist"),
           filename: "bundle.js",
           environment: {
               arrowFunction: false // 关闭webpack的箭头函数,可选
  •