Webpack5 系列(九):TS 打包配置

一、前言

上一篇讲到库的打包,本篇将介绍 TypeScript 的打包配置。

二、TS

TypeScript 是 JavaScript 类型的超集,它能够被转换为普通的 JavaScript。为了在 webpack cli 中使用 ts,就需要安装特定的 loader 来“翻译” ts 语法。

2.1 依赖安装

npm install --save-dev typescript ts-loader

2.2 tsconfig.json

在根目录下新建 tsconfig.js,它是 ts 的配置文件。

{
  "compilerOptions": {
    "outDir": "./dist/", // 这个可以不写,因为在webpack配置中已经写了
    "noImplicitAny": true, // 不允许隐式any类型
    "module": "es6", // 模块引入方式
    "target": "es5", // 打包后编译成什么形式
    "jsx": "react", // 引入react
    "allowJs": true, // 在ts文件中允许引入js文件
    "moduleResolution": "node" // 引入模块的方式
  }
}

接下来打开 webpack.config.js 。

2.3 webpack.config.js

const path = require('path');

module.exports = {
  entry: './src/index.ts', // 注意这里原来是 './src/index.js',需要改成 ts 结尾!
  module: {
    rules: [
      {
        test: /\.tsx?$/,
        use: 'ts-loader',
        exclude: /node_modules/,
      },
    ],
  },
  resolve: {
    extensions: ['.tsx', '.ts', '.js'],
  },
  output: {
    filename: 'bundle.js',
    path: path.resolve(__dirname, 'dist'),
  },
};

这样一来,将会引导 webpack 进入 "./src/index.ts" ,然后利用 ts-loader 加载所有的 .ts 以及 .tsx 结尾的文件,最后在当前目录下生成一个 bundle.js 文件。

注意:

  • 入口文件需要改后缀,我们现在用 ts 了,不用 js ;
  • 配置规则中的 tsx 指的是: ts + jsx ;
  • resolve 可以配置模块的解析方式,一般常用来设置 alias 别名以及 extensions 后缀名解析顺序。

三、js 改写为 ts 的示例

3.1 js 示例

greeter.js

import _ from 'lodash';

class Greeter {
	constructor (message) {
		this.greeting = message;
	}
	greet () {
		return _.join(['Hello ', this.greeting], '');
	}
}

export default Greeter;

index.ts

import Greeter from "./ts/greeter";
let greeter = new Greeter("JavaScript!");

let button = document.createElement("button");
button.textContent = "Say Hello";
button.onclick = function () {
  alert(greeter.greet());
};

document.body.appendChild(button);

3.2 ts 示例

现在将 3.1 中的 js 示例改用 ts 编写:

greeter.ts

import * as _ from "lodash"; // 注意这里!

class Greeter {
  greeting: string;
  constructor(message: string) {
    this.greeting = message;
  }
  greet() {
    return _.join(["Hello, ", this.greeting], "");
  }
}

export default Greeter;

注意:

  • 由于 lodash.js 没有默认导出,所以需要改为上面的写法。

  • 如果想要按照原来的 import _ from 'lodash'; ,则需要在 tsconfig.js 中添加参数allowSyntheticDefaultImports,将它设置为 true 即可。

    {
      "compilerOptions": {
        // ...
        "allowSyntheticDefaultImports": true
      }
    }
    

之后,和 3.1 一样,将它引入到 index.ts 文件中。

结果发现:我们的代码居然是运行不起来的。lodash 下面有一条红线:

Untitled

四、声明文件

在 TS 中,有一类文件是以 .d.ts 结尾的,这一类文件属于类型声明文件。TS 比 JS 多了类型检查,而这个声明文件就是类型检查的关键,所以为了让 TS 能够识别第三方库的 JS,就需要安装特定的声明文件。按照错误提示,我们需要按照以下依赖:@types/lodash

npm i --save-dev @types/lodash

在我们安装完成以后,重新运行项目,即可正常运行。

小结

  • 要想在项目中添加 TS 相关的配置,则先要安装 typescript 和 ts-loader;
  • 依赖安装完成后,需要添加 tsconfig.js 和相关配置参数,以及在 webpack.config.js 中添加 ts-loader 的规则;
  • 在使用第三方库的时候,注意需要安装对应的类型声明文件,避免引用错误。
  • 其他声明文件可以在这里搜索:www.typescriptlang.org/dt/search?s…

添加我的微信:enjoy_Mr_cat,共同成长,卷卷群里等你 🤪。

以上,感谢您的阅读~

posted @ 2021-11-09 19:36  见嘉于世  阅读(0)  评论(0编辑  收藏  举报  来源