从零开始使用webpack构建react + ts前端项目

文章序

脚手架虽好,但是为了彻底弄明白前端工程化和webpack,最好是手动创建前端项目亲身体验一把,本文旨在使用webpack从零开始构建react + ts项目,希望对你有所帮助

1.项目初始化

1.1创建文件夹

右键-新建-文件夹 重命名为react-ts-project
创建好后双击进入该文件夹

或者 命令行执行
mkdir react-ts-project
cd react-ts-project

1.2项目初始化

执行npm init -y初始化
执行完毕你会看到生成了一个package.json文件,此文件存放本项目相关信息,脚本命令,依赖包等信息
打开package.json,在script里增加
"dev": "webpack-dev-server --open --mode development",
"build": "webpack --mode production",
此时package.json文件内容

{
  "name": "react-ts-project",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "dev": "webpack-dev-server --open --mode development",
    "build": "webpack --mode production",
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [],
  "author": "",
  "license": "ISC"
}

2.依赖安装

用vscode或其他编译器打开react-ts-project,新建终端,在命令行中输入
npm i webpack webpack-cli webpack-dev-server react react-dom typescript esbuild-loader html-loader html-webpack-plugin
安装本项目所需依赖,执行完你会发现在项目根目录多了一个node_modules文件夹,该文件夹就是用于存放项目依赖,下面对这些依赖做简要解释
webpack、webpack-cli: 提供webpack打包基础能力,不多解释
webpack-dev-server: 提供开发环境本地运行项目的能力,可以使用node等替代
react、react-dom: react相关依赖包,不多解释
typescript: 提供Typescript语言能力
esbuild-loader: 打包时将js、jsx、ts、tsx等文件编译成目标版本语言,比如es5,用以替代bable + ts-loader
html-loader、html-webpack-plugin: 用以根据指定html模板文件生成最后打包的html文件
最终package.json文件内容

{
  "name": "react-ts-project",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "dev": "webpack-dev-server --open --mode development",
    "build": "webpack --mode production",
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [],
  "author": "",
  "license": "ISC",
  "dependencies": {
    "esbuild-loader": "^3.0.1",
    "html-loader": "^4.2.0",
    "html-webpack-plugin": "^5.5.1",
    "react": "^18.3.0-canary-a1f97589f-20230526",
    "react-dom": "^18.3.0-canary-a1f97589f-20230526",
    "typescript": "^5.2.0-dev.20230602",
    "webpack": "^5.85.0",
    "webpack-cli": "^5.1.3",
    "webpack-dev-server": "^4.15.0"
  }
}

3.编写webpack.config.js

const HtmlWebPackPlugin = require("html-webpack-plugin");
const path = require("path");


module.exports = {
    entry: "./src/main.tsx", //入口文件
    output: {  //输出路径和文件名
        filename: "bundle.js",
        path: path.resolve(__dirname, "dist")
    },
    module: {
        rules: [
            {
                test: /\.html$/, //使用html-loader
                use: [
                    {
                        loader: "html-loader"
                    }
                ]
            },
            {
                test: /\.(js|ts|jsx|tsx)$/, //使用esbuild-loader将js、ts、jsx、tsx文件内容转换为es2015
                include: path.appSrc,
                use: [
                    {
                        loader: "esbuild-loader",
                        options: {
                            loader: "tsx",
                            target: "es2015",
                        },
                    }
                ]
            }
        ]
    },
    plugins: [ //使用插件,这里使用了HtmlWebPackPlugin
        new HtmlWebPackPlugin({
            title: "react-ts-project",
            filename: "./index.html",
            template: "./public/index.html"
        })
    ]
};

4.编写tsconfig.json

该文件是对ts语言的一些配置,直接复制即可,有兴趣可自行研究

{
  "compilerOptions": {
    "target": "es5",
    "module": "commonjs",
    // "suppressImplicitAnyIndexErrors": true,
    "outDir": "./build",
    "sourceMap": false,
    "allowJs": true, // allowJs=true => tsc compile js as module, no type check
    "removeComments": true,
    "noImplicitReturns": true,
    "noEmit": true,
    "noImplicitAny": false,
    "noImplicitThis": true,
    "skipLibCheck": true,
    "moduleResolution": "node",
    "jsx": "react-jsx",
    "esModuleInterop": true,
    "declaration": true,
    "downlevelIteration": true,
    "allowImportingTsExtensions": true,
    "lib": [
      "dom",
      "esnext",
      "DOM.Iterable"
    ],
    "baseUrl": "./",
    "paths": {
      "@api/*": [
        "./src/api"
      ],
      "@src/*": [
        "./src/*"
      ],
      "@components/*": [
        "./src/components/*"
      ],
      "@utils/*": [
        "./src/utils/*"
      ],
      "@styles": [
        "./src/styles"
      ]
    }
  },
  "include": [
    "src",
  ],
  "exclude": [
    "node_modules",
    "webpack",
    "build",
  ]
}

5.编写项目

首先在根目录下新建src文件夹、public文件夹,在public文件夹内新建index.html文件,文件内容如下

<!DOCTYPE html>
<html lang="en">
<head>
    <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>react-ts-project</title>
</head>
<body>
    <div id="app"></div>
</body>
</html>

在src文件下新建main.tsx文件,文件内容如下

import React from "react";
import ReactDOM from "react-dom";
import App from "./App.tsx";


ReactDOM.render(
  <App />,
  document.getElementById("app")
);

新建app.tsx文件,文件内容如下

import React, { useState } from "react";

function App() {

  return (
    <div>hello react + ts</div>
  );
}

export default App;

6.运行项目

此时你已经完成一个基本的react + ts项目了,在终端输入npm run dev运行项目,会自动打开浏览器你会看到


这就是我们刚才在app.tsx里编写的内容,好了,到这里你就可以愉快的进行开发了

7.打包项目

当我们完成项目的编写,就需要将项目放到服务器上去运行了,在此之前需要对项目进行打包,在终端执行npm run build命令,会看到当打包完成在跟目录会出现一个dist文件夹,将该文件夹下的index.html和bundle.js文件放到服务器环境上对应的nginx或tomcat配置的路径内即可访问

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

推荐阅读更多精彩内容