Webpack5 搭建一个简易的 React+TS 开发环境

Webpack5 搭建一个简易的 React+TS 开发环境.png

之前入行前端系统学习过 Webpack,那时候的版本是 4,当时对 Webpack 的印象就是简单,但绝不易上手,尤其是应用到项目中,各种插件眼花缭乱,心都碎了一地。

现在 Webpack 升级到 5 了,里面内置了很多的插件,但是也还是做不到零配置。

对于这种脚手架,我理想的是,应该少配置,甚至做到零配置,用起来简单的就像在 HTML 中引入 JQuery 一样。

Vite 加油!

之前写过 React 配合 Webpack4 实现 hello world,感兴趣的可以看看。

项目目录结构

├── package.json
├── public
│   └── tpl
│       └── index.html
├── readme.md
├── src
│   └── index.tsx
├── tsconfig.json
└── webpack-config
    ├── webpack.base.config.js
    ├── webpack.config.js
    ├── webpack.dev.config.js
    └── webpack.prod.config.js

webpack.base.config.js 也可以叫 webpack.common.config.js 如果感觉名字太长的话,可以把 config 的字段去掉,即:

xxxxx
└── webpack-config
    ├── webpack.common.js
    ├── webpack.config.js
    ├── webpack.dev.js
    └── webpack.prod.js

动手实现

项目初建

初始化文件,和安装依赖(后面会单独把 package.json 文件的关键信息放出来):

$ npm init -y # 初始化 package.json
$ npm install webpack webpack-cli webpack-dev-server -D 

安装完这些,我们还需要一些 Webpack 插件,来辅助我们搭建项目,继续安装:

npm install webpack-merge html-webpack-plugin -D

看下 package.json 的依赖,都是基于最新版:

{
  "devDependencies": {
    "html-webpack-plugin": "^5.3.1",
    "webpack": "^5.35.1",
    "webpack-cli": "^4.6.0",
    "webpack-dev-server": "^3.11.2",
    "webpack-merge": "^5.7.3"
  }
}

public/tpl/index.html 的文件内容(主要是放置一个容器标签):

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Hello TypeScript</title>
</head>
<body>
    <div id="root"></div>
</body>
</html>

入口 index.js 文件(让页面显示一个 hello demo):

document.getElementById("root").innerHTML = "Hello TypeScript!";

webpack.base.config.js 文件(公用的基础配置):

[name][chunkhash:8] 的用法参考 template-strings

const HtmlWebpackPlugin = require("html-webpack-plugin");

module.exports = {
    entry: "./src/index.js",
    output: {
        filename: "[name][chunkhash:8].js"
    },
    resolve: {
        extensions: [".js", ".jsx", ".ts", ".tsx"]
    },
    plugins: [
        new HtmlWebpackPlugin({
            template: "./public/tpl/index.html"
        })
    ]
}

dev 环境下的个性配置,开启了 source-map 便于调试,参见 devtool

module.exports = {
    devtool: "eval-cheap-module-source-map"
};

prod 环境下的个性配置:

Webpack4 我们清空目录使用的插件是 clean-webpack-plugin 现在 Webpack 已经内置了,参见: outputclean

module.exports = {
    output: {
        clean: true
    }
}

package.json 的 scripts 字段新增内容如下:

{
  "scripts": {
    "start": "webpack serve --mode=development --config ./webpack-config/webpack.config.js",
    "bulid": "webpack --mode=production --config ./webpack-config/webpack.config.js"
  },
}

注意⚠️,webpack-dev-server 在五里面的命令改了,用 webpack serve 来替代 webpack-dev-server 了。

最后:

npm run start

浏览器打开 http://localhost:8080/ 即可看到:

增加 TS 和 React

还需要安装一些依赖:

$ npm install react react-dom
$ npm install -D typescript ts-loader  @types/react @types/react-dom

依赖文件被更新为:

{
  "devDependencies": {
    "@types/react": "^17.0.3",
    "@types/react-dom": "^17.0.3",
    "html-webpack-plugin": "^5.3.1",
    "ts-loader": "^9.1.1",
    "typescript": "^4.2.4",
    "webpack": "^5.35.1",
    "webpack-cli": "^4.6.0",
    "webpack-dev-server": "^3.11.2",
    "webpack-merge": "^5.7.3"
  },
  "dependencies": {
    "react": "^17.0.2",
    "react-dom": "^17.0.2"
  }
}

用 TS 需要有一个配置文件,package.json 在添加一个脚本命令:

{
  "scripts": {
    "start": "webpack serve --mode=development --config ./webpack-config/webpack.config.js",
    "bulid": "webpack --mode=production --config ./webpack-config/webpack.config.js",
    "ts:init": "tsc --init"
  }
}

运行 npm run ts:init 命令,项目根目录会出现 tsconfig.json 文件,因为项目会用到 jsx 语法和操作 DOM ,所以确认 tsconfig.json 的 lib 和 jsx 字段正确使用,例如。

{
  "compilerOptions": {
      "lib": ["DOM"],
      "jsx": "react-jsx"
  }
}

webpack.base.config.js 需要做些改变,更改入口文件和 loader :

const HtmlWebpackPlugin = require("html-webpack-plugin");

module.exports = {
    entry: "./src/index.tsx",
    output: {
        filename: "[name][chunkhash:8].js"
    },
    resolve: {
        extensions: [".js", ".jsx", ".ts", ".tsx"]
    },
    module: {
        rules: [
            {
                test: /tsx?$/i,
                loader: "ts-loader",
                exclude: /node_modules/
            }
        ]
    },
    plugins: [
        new HtmlWebpackPlugin({
            template: "./public/tpl/index.html"
        })
    ]
}

src/index.js 需要重命名为 src/index.tsx,文件内容变更为:

import *  as React from "react";
import { render } from "react-dom";

interface Iprops {
    children: string;
}
function App (props: Iprops) {
    return (
        <>
            <h1>{props.children}</h1>
        </>
    )
}
render(<App>hello TypeScript!</App>, document.getElementById("root"));

npm run start 重启服务,浏览器完美运行:

当然事情可能不是那么的顺利,比如我就意外的收到了下面三个警告⚠️。

警告

根据提示可以知道,项目的 code-splitting 和 performance 有带优化,code-splitting 是 Webpack4 的内容,参考链接 splitchunksplugin 性能的问题,可以参考 performance 来配置。

module.exports = {
    optimization: {
        splitChunks: {
            chunks: "all",
            // maxSize 每个包的最大 250000 字节
            maxSize: 250000,
        }
    },
    performance: {
        hints: "error",
        // 打包之后的文件的大小超过 250000 字节报错提示
        maxAssetSize: 250000,
        // 首次加在文件的大小
        maxEntrypointSize: 400000,
    }
};

Webpack5 搭建一个简易的 React+TS 开发环境的教程就写完了,不知道你发现没 Webpack5 相对于 Webpack4 智能,又内置了好多社区插件,再给你举个例子🌰:

如果你使用过 Webpack 配置过项目,你一定知道

  • raw-loader:内联资源,允许将文件处理成一个字符串内联
  • file-loader:将文件打包导到输出目录,并在 import 的时候返回一个文件的 URI
    url-loader:当文件大小达到一定要求的时候,可以将其处理成 base64 的 URIS ,内置 file-loader。

这三个处理静态资源的 loader。我这一说,你就该猜到了,没错 Webpack5 也给内置了。具体的使用参考

简单介绍下,我们找张 earth-girl.png 的图片来实战。

启用 loader 是使用 type 字段进行配置的,webpack.base.config.js 的 module 需要新增规则

module.exports = {
    module: {
        rules: [
            {
                test: /\.png$/i,
                type: "asset/resource"
            },
            {
                test: /\.tsx?$/i,
                loader: "ts-loader",
                exclude: /node_modules/
            }
        ]
    }
};

index.tsx 插入 img 标签:

import *  as React from "react";
import { render } from "react-dom";
import earthGirl from "./earth-girl.png";

interface Iprops {
    children: string;
}
function App (props: Iprops) {
    return (
        <>
            <h1>{props.children}</h1>
            <img src={earthGirl} alt="earth-girl.png"/>
        </>
    )
}
render(<App>hello TypeScript!</App>, document.getElementById("root"));

这时候会编译错误,这是因为 TS 无法识别 png 文件,所以现在需要在项目根目录新建 custom.d.ts 文件内容为:

declare module "*.png";

重启服务,打开浏览器,啦啦啦图片出来了:

今天就介绍到这里了,更多 Webpack 内容请去 Webpack 官网学习 https://webpack.js.org/

完~

当前时间 Monday, April 26, 2021 17:58:27

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,189评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,577评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,857评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,703评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,705评论 5 366
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,620评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,995评论 3 396
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,656评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,898评论 1 298
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,639评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,720评论 1 330
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,395评论 4 319
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,982评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,953评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,195评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,907评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,472评论 2 342

推荐阅读更多精彩内容