导航
导航
文章目录󰁋
  1. 一、项目初始化
    1. 1.1 创建项目
    2. 1.2 webpack配置
  2. 二、提升开发体验
    1. 2.1 支持sass
    2. 2.2 支持css module
    3. 2.3 配置公共sass属性
    4. 2.4 支持装饰器
    5. 2.5 优化路径
    6. 2.6 构建缓存
  3. 三、整理杂项
    1. 3.1 整理项目结构
    2. 3.2 集成antd
    3. 3.3 整合常用函数
    4. 3.4 集成mobx
    5. 3.5 使用react-hot-loader进行热加载
    6. 3.6 集成svg-component
  4. 四、项目打包
    1. 4.1 添加打包命令
    2. 4.2 分离css文件
    3. 4.3 修改html-webpack-plugin配置项
    4. 4.4 代码分离和按需加载
    5. 4.5 添加optimization
    6. 4.6 代码压缩
    7. 4.7 关于externals
  5. 五、团队规范
    1. 5.1 使用tslint进行代码检测
    2. 5.2 使用stylelint做代码检测
    3. 5.3 添加npm script进行检测
    4. 5.4 使用prettier进行代码格式化
    5. 5.5 使用pre-commit
  6. 六、代码

Typescript+React模板搭建(三)

整理于网络

一、项目初始化

1.1 创建项目

确保安装了 npm install -g typescript

# -S 是--save简写
# -D 是--save-dev简写

# 创建目录
mkdir ts-react && cd ts-react

# 生成package.json、tsconfig.json
npm init -y && tsc --init

# 安装开发工具
npm install-D webpack webpack-cli webpack-dev-server

# 安装react相关
npm install -S react react-dom

# 安装react相关的ts验证包
npm install -D @types/react @types/react-dom

# 安装ts-loader(或者awesome-typescript-loader) 这两款loader用于将ts代码编译成js代码
npm install -D babel-loader

1.2 webpack配置

  1. 在项目根目录新建一个build文件夹
mkdir build && cd build && touch webpack.config.js
  1. 根目录下新建src文件夹,然后在src里新建index.tsx文件作为项目入口
mkdir src && cd src && touch index.tsx
  1. 编写简单的webpack配置,只包含entryoutput
const path = require('path')

module.export = {
entry: {
app: path.join(__dirname, '../', 'src/index.tsx)
},
output: {
path.join(__dirname, '../', 'dist),
filename: '[name].js
}
}
  1. 编写awesome-typescript-loader配置项:
    webpack中的module是专门用来决定如何处理各种模块的配置项,例如本例中的typescript,这里主要用的配置项就是module.rules,而当前只需要简单配置解析.tsx文件类型即可

  1. src/index.tsx中写入口文件
import * as React from 'react'
import * as ReactDOM from 'react-dom'

import Test from '@components/Test'

const render = () => {
ReactDOM.render(
<div>1234</div>,
document.querySelector('#app')
)
}
render()

但是这时候你会发现有一个错误没有处理

这是因为在tsconfig里面没有指定JSX的版本,这时候在tsconfigcompilerOptions中添加"jsx": "react"配置项即可消除错误

  • 此外还需要注意一点,以后需要import xxx from 'xxx'这样的文件的话需要在webpack中的resolve项中配置extensions,这样以后引入文件就不需要带扩展名
module.exports = {
resolve: {
extensions: ['.ts', '.tsx', '.js', '.jsx']
}
}
  1. 添加页面模板

public文件夹下新建文件夹tpl,然后在tpl中新建一个index.html,如下

mkdir public && cd public && touch index.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta http-equiv="X-UA-Compatible" content="ie=edge">
<title>Document</title>
</head>
<body>
<div id="app"></div>
</body>
</html>

这时候有了页面模板还是不够的,还需要将页面模板和打包出来的js文件关联起来,因为考虑到以后打包出来的js的文件不会是一个固定的名称,所以这里需要使用一个webpack的插件html-webpack-plugin

  1. 配置html-webpack-plugin
module.exports = {
plugins: [
new HtmlwebpackPlugin({
template: 'public/index.html'
})
]
}

配置完成后就可以启动项目了

  1. 配置tsconfig
  • 编译目标 这时候我们切回tsconfig配置中,会发现在compilerOptions配置项的targetes5,也就是说把ts代码编译成es5规范的代码,如果不做兼容的话,我们可以将它设置为es6,使其编译成es6的代码
  • 模块处理module项中,会发现生成的是commonjs的模块系统,因为不考虑兼容,所以这里我也将其设定为最新的esnext,并且将模块处理方式改为用node来处理,设置moduleResolution项为node,不做模块处理方式设置的话可能会有报错

  1. 项目启动

这时候我们可以在package.json中添加启动命令

"dev": "webpack-dev-server --config build/webpack.config.js --mode development"

其中--mode development用于指定开发模式,否则在webpack4+版本下会有警告
然后直接npm run dev即可

总结

其实这个时候项目其实就已经跑起来了,完全可以不用往下看,但是实际上的工作并没有做完,下一章就开始讲解如何提高开发体验

二、提升开发体验

本章主要介绍的是建立在项目初始化的基础上如何优化开发体验 内容包含如下:

  • 支持sass
  • 支持css module
  • 配置公用的sass属性
  • 支持装饰器
  • 路径优化
  • 构建缓存
  • 构建加速

2.1 支持sass

# 安装相应包
npm install -D node-sass sass-loader style-loader css-loader

webpack进行loader编译的顺序是从下到上的:知道上面的顺序后我们在webpack中的配置就非常简单了,直接在module.rules下面加上.scss文件类型的编译配置即可

查看效果,这时候我们在src下面新建一个index.scss,然后在index.tsx里面引入这个文件查看




2.2 支持css module

css module是针对css类名作用域做出限定的一种规范,用以解决css类名冲突的问题

  • 安装对应的包 因为在这里我们用的是TypeScript,所以可以用typings-for-css-modules-loader这个包,这个包也可以替代css-loader的功能,此外这个包还能根据.scss文件里面的类名自动生成对应的.d.ts文件
npm install -D typings-for-css-modules-loader

配置webpack 这个配置接非常简单了,因为要用typings-for-css-modules-loader替代css-loader的功能,所以直接替换即可,将前面sass的配置修改为如下:

修改为这样既可,但是同时我们也发现一个问题:

  • 这个问题导致的原因是因为.scss文件中并没有类似export这样的关键词用于导出一个模块,所以也就导致报错找不到模块,这个问题可以通过ts的模块声明(declare module)来解决。
  • 解决模块声明问题,这时候我们在根目录下新建一个typings文件夹,用于存放.scss的模块声明,以及后续需要用到的全局校验接口,然后新建typed-css-modules.d.ts文件用于存放.scss模块声明,目录结构和声明内容如下

这个时候回到index.tsx文件中你会发现错误标红消失了,然后我们在index.scss文件中新增如下代码

保存后你会发现当前目录下新增了一个index.scss.d.ts文件,打开里面可以发现是针对每个类名的类型校验,当以后新增类名的时候,typed-css-modules.d.ts都会自动在index.scss.d.ts里面新增对应的类型校验

这时候回到页面查看,你会发现类名变成了一个hash值,这样可以有效地避免类名全局污染问题

2.3 配置公共sass属性

既然已经可以使用sass进行更加简便的css代码编写,那么我们也可以将常用的一些样式代码和sass变量写入公共文件中,当使用的时候就可以直接引入使用,这可以提高一定的效率节约时间

  1. 新建公共样式目录

首先在src目录下新建styles文件夹,然后在styles文件夹下新建var.scss文件用于存放样式变量。 之后在var.scss文件里写入一个颜色变量和一个样式:

  1. 查看效果

然后在index.scss文件里面引入var.scss,接着就可以直接使用里面的变量了


  1. 优化

上面的效果其实已经达成,但还是存在一个不好的问题,就是在引入var.scss的路径上要根据每个文件夹的路径相对来引入非常麻烦,那么我们能否做到只需要@import var.scss就行呢?答案是可以的,我们可以使用一个node-sass的属性includePaths进行路径优化:


2.4 支持装饰器

前置工作 在src目录下新建一个components文件夹,用于存放通用组件,然后在components文件及里面新建一个组件Test,然后在网页入口引入这个组件,如下图所示:

什么是装饰器,为什么需要装饰器 装饰器本质上就是一个函数,这个函数对类(class)本身进行一些处理,也可以将装饰器的写法当做一种语法糖,如果不用装饰器的话,可以写成下图这样

设置装饰器可用 根据装饰器的语法,我们可以将上面的代码写成如下:

但是你会发现这里报了一个错误,这是因为装饰器语法在es6标准中还只是一个提案,并未正式支持,但是在ts中,装饰器已经被正式支持了,不用ts的可以自行安装babel相关包进行支持

那么怎么解决这个错误呢?我们根据错误提示进入到tsconfig文件中,将experimentalDecorators设置为true即可,然后回到页面查看log装饰器已经生效了

2.5 优化路径

在上面的例子中我们新建了components文件夹,然后在入口处引入了其中的Test组件

但是这时候需要考虑到一个问题,如果以后在一个层级比较深的文件中引入这个组件会不会产生如下这种情况呢?

import Test from '../../../../components/Test'

这样不仅书写起来麻烦还容易出错,因此这时候就需要进行一些路径上的优化,使得无论在哪个地方引入这些组件都能用同一种写法,例如:

import Test from '@comonents/Test'

这里针对路径的优化有两种方案,第一种是直接在webpack.resolve.alias中进行路径配置:

但是在这里我们使用了ts,所以还需要在tsconfig中进行配置:

这样也能用,不过我们还可以用tsconfig-paths-webpack-plugin这个包将tsconfig中对路径的设置映射到webpack配置中去,这样就不需要在webpack中再进行一次路径的配置了,首先安装:

npm install -D tsconfig-paths-webpack-plugin

然后就采用前面tsconfig里面对baseUrlpaths的配置。
之后进入webpack配置中,引入tsconfig-paths-webpack-plugin

const TsconfigPathsPlugin = require('tsconfig-paths-webpack-plugin')

接着在webpack.resolve中新增配置项plugins(这里要注意的是新增的不是webpack.plugins,而是webpack.resolve.plugins),配置如下代码

接着我们就可以愉快地使用简化后的路径了:

2.6 构建缓存

我们一般会使用webpack-dev-server来进行项目开发,当我们运行webpack-dev-server的时候它会在内存中进行项目的构建,但是当使用了babel之类的代码转换工具后,会对项目构建产生较大的性能影响,这是因为每一次的构建都会对代码进行重新转换。而构建缓存就是将构建的公用代码缓存在磁盘上,这样做的效果就是第一次构建的时间花销会比不用缓存的构建大,但是在之后每次构建的时间花销都会大大减少

  • 对比 我们拿一个较大的项目来看区别。 注: 左边是没有设置构建缓存,右边进行了构建缓存。 首先进行对比的是第一次构建时候的时间花销:

  • 然后是第二次构建的时间花销

可以看出在第二次构建的时候时间花销减少了百分之五十以上。

设置构建缓存

在设置构建缓存之前我们首先要考虑的是那些地方需要进行设置,那么在前面的配置过程中,可以看出花销较大的地方有对ts(x)的转换并且以后还会添加对应的babel进去,然后还有针对sass类型的转换,那么我们就先对这两个地方的转换进行配置

  1. ts(x)的转换

这里因为我们使用的是awesome-typescript-loader,这个库本身自带了开启缓存的选项useCache,然后我们需要指定一个保存缓存文件的地方cacheDirectory,所以配置改为如下:

  1. sass类型的转换

这个地方我们需要使用到一个库cache-loader

npm install -D cache-loader

然后在对.scss文件类型的转换配置中使用它,在这里我们主要是针对转换出来的css进行缓存,所以需要写在typings-for-css-modules-loader配置的前面:

这样就配置好当前的构建缓存了,当你npm run dev的时候会发现根目录下生成了缓存文件.cache-loader

打开它看会发现有对应的缓存代码:

三、整理杂项

在上一篇提升开发体验中,我们一下子集成了一堆插件和功能进去,导致项目结构比教混乱,重点问题就在webpack的相关配置项目录build文件夹中,所以今天的工作较为轻松,重点就是进行项目结构整理,然后再进行一些杂项的添加

  • 整理项目结构
  • 集成Ant Design并进行主题修改
  • 整合常用函数,并且让所有组件继承这些函数
  • 集成mobx进行项目的状态管理
  • 使用react-hot-loader进行热加载
  • 集成svg-component

3.1 整理项目结构

在做这一步的时候首先我们来看看现在的项目结构是怎么样的

那么当前最先需要做的工作就是进行build文件夹下webapck的配置项整理

针对webpack配置项的整理。做这一步的时候首先需要确定一点就是,我们根据什么来整理webpack配置项目录呢?要确定这一点只需要查看一下webpack中有些什么配置,然后就可以根据每个配置项进行模块划分

在这份配置项中,因为entryoutputresolve内容相对较少,往后也不会有太多内容的添加,所以可以忽略

首先将plugins相关内容移出来

  1. 首先在build中新建文件plugins.js,然后将原先的plugin里面的代码拷贝过去

  1. webpack.config.js中将plugins.js的内容引入进来即可

整合路径选择webpack.config.js中你会看到许多使用path.join的地方,这一块也可以抽取出来作为一个工具模块。新建build/utils.js文件,然后写入如下代码,将路径的目标指向根目录,详细路径则通过参数的形式传入

之后在任何需要使用的地方引入这个函数使用即可

将module相关内容移出来

因为在module项中相关的配置相对较多,涵盖了对ts(x)scss等相关文件的loader,以后还需要添加针对图片等文件类型的loader,所以这一块需要分的更加细一些:

  1. build中新建rules目录,里面新建jsRulesstyleRules文件

  1. 将之前module中的loader配置一如对应文件中并导出,然后在webpack.config.js中引入: 首先是jsRules内容

然后是styleRules内容

最后是引入rules后的webpack.config.js

至此我们就将webpack的配置项分离了出来,接下来我们集成Ant DesignUI库(简称antd),并且修改其主题色。

3.2 集成antd

集成antd 要集成antd非常简单,只需要npm install -S antd即可,然后我们在components/Test组件中引入其中一个组件

修改antd的主题配色

通常在开发中,我们采用的配色不是antd原本的配色,如果大面积引用antd组件的话,一个个去修改配色确实是非常麻烦的事情,于是这个时候就需要一次性对antd的主题色进行修改

  1. antd的样式使用less进行编写,对其主题的修改也就是对其中的less变量进行修改,所以想要修改主题需要安装lessless-loader: npm install -D less less-loader
  2. 然后我们在根目录下添加一个theme.js文件,里面是需要修改的主题样式代码,具体有什么主题可以进行修改可以点击这里查看:

  1. 然后编写在build/rules/styleRules中添加针对less文件的loader,如下图: 引入上一步的主题文件
const theme = require('../../../theme')

  1. 最后我们在components/Test组件中引入Button组件的样式less文件

此时可以查看效果,发现已经主题已经修改成功

  1. 存在的问题

这个时候进行antd组件的引入和主题修改的步骤中还是存在一些问题的,比如在引入某个组件的同时还需要手动引入其对应的less文件,这是非常麻烦的一件事,那么找我们需要解决的就是在引入antd组件的同时也自动引入其对应的less文件。
另外,使用import {Button } from 'antd'这样的引入方式存在一个很大的弊端,就是在引入其中某个组件的同时会把整个antd文件都引入进来,影响构建速度,而且打包后体积会变大,这样的话我们还需要做antd的按需加载。所以接下来我们需要解决掉这两个问题,而这两个问题也是可以同时解决的

antd按需加载

  • antd官网中推荐使用babel-plugin-import来做按需加载,但是我们的项目用的是typescript,走的是awesome-typescript-loader编译,所以在我们的项目中babel-plugin-import是不生效的,这时候需要就需要一个叫做ts-import-plugin的插件
    npm install -D ts-import-plugin
  • 第二步我们需要在build/rules/jsRules.js中进行配置,根据ts-import-plugin的教程直接配置即可

  • 回到Test组件中 将import 'antd/lib/button/style/index.less'这句话删掉,然后重新运行查看效果

3.3 整合常用函数

在上一步中,我们集成了antdUI库,在这个库中有许多东西是非常常用的,例如消息组件message和通知组件notification,但是要用到这两个组件的话就得引入,当使用次数较多的时候,我们可以考虑将其整合在一个react组件中,然后所有的组件都继承这个组件即可,这样做的好处是当以后添加了例如axios这样的常用库的时候也可以整合到这个react组件中,使继承这个react组件的组件都可以用到

整合常用函数

  1. 我们先在src下新建utils目录,然后在utils中新建reactExt.tsx文件

  1. 然后在tsconfig.json中设置好utils的路径,方便以后的路径引用

  1. reactExt.tsx中引入antd常用组件,然后导出这个整合了antd组件的组件,当然你也可以把它叫做类,其中需要注意的是,因为以后的每个react组件使用的都是componentExt,然后在这里我们需要使用typescriptinterface来对react组件的stateprops进行数据类型上的限制,但与此同时并不能知道每个react组件针对statepropsinterface是怎么样的,所以在componentExt中需要用到泛型来灵活化interface

  1. 最后在components/Test组件中引入comonentExt进行测试:

以后如果有常用的功能性函数也可以往components/reactExt中进行添加。

3.4 集成mobx

mobxreact技术栈中一款优秀的状态管理工具,它具有数据监测的功能,并且比redux用起来更加方便,也能脱离react进行单独使用,安装mobx只需要npm install -S mobx即可,同时也要安装他和react连接的工具npm install -S mobx-react。接下来就以一个经典的计算器组件来测试mobx

准备工作 在进行测试之前,我们还需要整理一下组件存放的目录。首先区分一下组件目录的作用

  1. components目录用于存放通用组件,该目录存放的组件不包含任何业务性功能。
  2. 新建src/containers/views目录,这个目录是用于存放业务组件的,并且这些组件不能复用。
  3. 新建src/containers/shared目录,这个目录用于存放可以复用的业务组件。
  4. tsconfig.json中设置简短路径方便以后调用

这一步在该博客中作用体现不大,但是对真实项目的条理性是存在较好作用的。 如下图

创建store

  1. 新建src/store目录用于存放store文件,然后在该目录下新建globalStore目录和其中的index.tsx文件

  1. 然后在这个index.tsx文件中有如下代码:其中的observableaction的功能请自行查看mobx文档

  1. 然后新建src/store/index.tsx文件用于导出这些store

连接store 创建了store之后我们还需要将其和react进行连接,这个时候就需要用到mobx-react这个库,我们去到src/index.tsx中进行修改

这里面的configure({enforceActions: 'observed'})用于限制被observable(也就是store中添加了@observable)的数据的修改方式,让其只能添加了@action的函数中进行修改

编写Counter组件进行测试

  1. 我们去到src/containers/views目录中,新增Counter/index.tsx,并写入如下代码:

  1. 然后将这个组件用mobx-react变为可观测对象,并使用@inject注入globalStore

  1. 最后我们在src/index.tsx中引入Counter组件,顺便看看它的props中是否带有数据

  1. 最后回到Counter组件中编写方法检验功能是否正常

store添加全局typescript校验

在上面的例子中虽然我们在功能上已经可以正常的使用了,但是显而易见的是有报错,这个错误是因为没有填写针对组件props的验证接口导致typescript认为globalStore不存在而导致的。我们可以写成如下代码解决问题

但是每个引入了globalStore的组件都需要写一次显得非常麻烦,那么我们可以将IGlobalStore这个校验接口写成全局的校验接口,直接以如下图形式验证即可:

  1. 我们在src/store/globalStore下新建type.d.ts

  1. 去到globalStore/index.tsx中,将GlobalStore类导出,我们将会利用这个类作为typescript校验接口来使用(这种用法可以点这里查看详情):

  1. type.d.ts中引入这个类,然后定义并导出一个全局命名空间(该用法详解点这里),接着在这个命名空间中把接口导出:

  1. 回到Counter组件中,将接口改写为如下

这里注意需要添加?,因为这个属性是从store中拿过来的,不填写的话,父组件会报错说没有传这个值。 但是因为添加了?,所以这个globalStore验证为不一定有,从而在组件中会有如下报错:

这个时候我们可以去tsconfig.json中将strictNullChecks项置为false,去掉nullundefined的检测即可

  1. 到了这一步我们集成Mobx就成功了,并且也针对store添加了对应的typescript验证:

3.5 使用react-hot-loader进行热加载

这一步主要针对的是webpack-dev-server的页面自动刷新功能不能保持数据一直都在,有时候在更新组件代码后需要保持数据不变的场景就会很不方便,所以这个时候就需要用到react-hot-loader来进行页面代码变更检测并找到变更部分进行更新,同时保证数据不变

  1. 首先我们安装它npm install -D react-hot-loader
  2. 然后我们还要用到它里面的react-hot-loader/babel,但是因为我们使用了awesome-typescript-loader,所以不需要在根目录添加.babelrc文件了,直接进到build/rules/jsRules.js中进行配置即可

  1. 接着我们去到Counter组件中引入react-hot-loader中的hot方法,直接以装饰器的形式包裹组件

  1. 最后再去package.json中,在dev命令后面加上--hot即可

  1. 回到Counter组件中做个检测,先增加一些数字,然后在增加字样后面加上几个字符,可以看到页面更新的同时保留了数据

实际上我们在控制台看到输出这个字样就已经成功了

3.6 集成svg-component

在前端开发中,svg格式的图片使用的是非常频繁的,而集成了svg-component后,我们可以将svg图片以组件的形式引入并使用

  1. 要集成svg-component我们首先要安装@svgr/webpack: npm install -D @svgr/webpack,这是一个loader
  2. 然后我们在build/rules中新建fileRules.js文件,将svg格式文件用这个loader进行编译

然后在webpack.config.json中导入并重启项目

  1. 接着我们随便找一个svg格式图片在Counter中引入并测试,虽然可以使用了,但是也导致了一个typescript的报错说找不到模块

导致这个错误的原因是svg图片本身并不具备模块化的功能,也不提供模块导出,所以在导入的时候是不能识别的,要解决这个问题可以模仿我们之前使用css moudles的方式,给它声明一个模块:我们在typings目录下新建svg.d.ts文件,并写入如下代码

这个时候还可以为svg-component的使用提供代码提示和传入属性校验的支持: 我们声明一个接口,然后在声明的模块中用这个接口作为内容

这个接口使用的是react的无状态组件声明,传入属性则为svg文件自带的属性比如col or width之类的,然后我们就可以愉快地使用svg-comonent

四、项目打包

本章节内容

  • 添加打包命令
  • 进行cssjs分离
  • 修改html-webpack-plugin配置项
  • 添加react-loadablereact-router,进行代码分离和按需加载
  • 添加optimization,进行第三方库代码分离
  • 进行代码压缩
  • 关于externals

4.1 添加打包命令

我们先去webpack.config.js中观察一下output这个配置项

该配置项指定了打包路径和打包后的js文件名,在webpack的配置项中,output是必须有的。 接着我们去到package.json中在script中添加打包命令build,该命令引用我们的webpack.config.js配置文件

之后试试运行npm run build,会发现已经将项目打包出来了

添加打包路径工具

在上一步中,我们已经知道打包出来的文件位于根目录下的dist文件夹中,所以这个路径工具的添加指向dist文件夹: 我们去到build/utils.js文件中,添加如下代码:

以后指定打包文件存放路径的时候就可以直接使用这个工具进行指定

4.2 分离css文件

在上面打包的结果中,我们会发现只有一个app.js文件,而实际上我们是有写css样式的,但是现在的却并没有这个css文件,这是因为webpack将所有的资源(包含js, css等等)都看成是chunk,然后一起打包进一个文件中,这样会导致打包出来的js文件体积巨大,从而拖累页面的加载速度

  1. webpack 4+版本中,我们可以使用mini-css-extract-plugin进行css代码的分离,所以首先安装它npm install -D mini-css-extract-plugin
  2. 然后我们到build/plugins.js中添加这个插件

  1. 最后需要注意,之前在提升开发体验这一章中有提到过一点,style-loader用于将css-loader编译出来的代码转为js代码并写入js文件中,所以在这里,我们需要用mini-css-extract-plugin中的loader去替换掉style-loader,让它写入单独的css文件而不是js文件中:

我们去到build/rules/styleRules.js中,将原本的style-loader全都替换成mini-css-extract-pluginloader(这一步可以进行开发环境和生产环境的区分,在文章中不进行区分

  1. 经过上面的步骤,我们可以打包进行测试: 运行npm run build可以发现打包结果中css文件已经进行了分离

而在打包出来的index.html中也可以发现这个css文件被引入了

最后我们再在打包路径中将打包出来的js文件用js文件夹包裹起来即可

4.3 修改html-webpack-plugin配置项

这一步主要用于压缩打包出来的index.html文件,但是单页面应用的话html内容其实不多,所以做不做也差不多,在本文章中也只是做个介绍:

  1. 首先在html-webpack-plugin中利用的是html-minifier来做压缩工作的,所以详细配置点击进去看即可,常用的如下

  1. 第二个需要提一下则是inject这个配置项,该项指定资源如何注入,我们直接使用默认的true即可,他会将js资源注入到<body>标签的底部,如果要注入到头部填写head即可

4.4 代码分离和按需加载

这一步和下一步都是在进行代码的拆分,考虑的是如果所有文件都塞进一个js文件中,会导致这个js文件体积臃肿,而单页面应用的所有构建又是依赖于这个js文件,所以需要进行代码分离,只加载当前页面需要构建的js文件。通常来说,我们会根据react-router分的页面来进行代码分离,再用react-loadable进行分割出来的代码的异步加载(当然你也可以将所有组件都进行代码分离然后异步加载)。所以在这里我们先利用react-router分两个页面home和page出来

  1. 首先我们安装react-router: npm install -S react-router-dom,然后在src/containers/views中新建HomePage组件

  1. 接着安装react-loadable: npm install -S react-loadable, 然后在src/containers/shared中新建App组件

之后在里面的index.tsx中引用react-routerreact-loadable进行组件按需加载: 当然不要忘了使用react-hot-loader

这一步需要注意的是,Loadable这个函数中的loading参数是必须有的,至于如何使用可以自行参考react-loadablegithub链接

  1. 这个时候去到页面看一下:在/路径下,没有加载page.js这个文件,而切换到/page路径则会加载page.js文件,这个时候按需加载就完成了:

  1. 最后我们观察一下打包后的js文件可以发现已经进行了分离

4.5 添加optimization

optimizationwebpack4+版本中新出的配置项,这个配置项的功能主要是进行代码压缩,优化。在本节中,我们需要将用到的处于node_modules中的第三方代码进行分离,在这里主要用到的是两个配置项optimization.runtimeChunkoptimization.splitChunks,其中runtimeChunk用于生成维系各各代码块关系的代码,splitChunks则用于指定需要进行分块的代码,和分块后文件名

  1. 我们去到build目录下,新建optimization.js,并添加如下代码

然后在webpack.config.js中引入这个配置

  1. 最后我们打包试试看可以发现第三方代码都被打包进vendor.js文件中了

你可以通过比对在添加optimization之前和之后打包出来的app.js文件来看出效果

4.6 代码压缩

我们主要是做jscss的代码压缩和优化

  1. 在上面阶段中,我们打包出来的js代码是已经经过压缩的

所以在这个阶段我们可以利用uglifyjs-webpack-plugin进行一些压缩优化:
首先我们需要安装npm install -D uglifyjs-webpack-plugin,然后去到build/optimization.js中添加如下代码即可,具体的优化见代码

PS: 这里有一个点需要注意,在uglifyjs-webpack-plugin这个插件中,如果是2.x版本的话是不支持es6规范的,所以建议安装1.x版本,而我这里的版本是:

  1. 然后我们进行css代码的压缩,这里需要使用到optimize-css-assets-webpack-plugin插件:npm install -D optimize-css-assets-webpack-plugin
    我们先去Home组件中随意添加一个样式并使用它

然后再去到build/optimization.js添加如下代码:

具体的插件使用方式可以自行上github查看该插件。 最后查看打包出来后的css代码:

到现在压缩代码步骤也做完了,最后将介绍一下webpack.externals这个选项

4.7 关于externals

webpack.externals配置项用于在构建过程中忽略一些常用包的集成,从而降低构建时间和打包后的包大小,它的配置也很简单,在本章中只做简单介绍:在本项目中,我们可以将reactreact-dom添加进externals中,然后在html模板中引入它们的外部链接:

  1. 我们先去到webpack.config.js中,添加externals选项,并且把reactreact-dom添加进去

这个配置项接收的是一个对象(其他形式请自行查阅webpack文档),对象的键是指webapck在获取这个模块时候require时候的参数,而对应的值则是标明你打算将这个模块挂载的变量名,这里是挂载在window对象中的

  1. 去到build/tpl/index.html中,引入cdnreactreact-dom的链接

  1. 重启项目,可以发现在npm run dev中能够正常使用,并且也已经引入了两者的外部资源

  1. 最后我们来对比一下打包后模块占用情况

再来对比一下两者打包出来的包体积大小

五、团队规范

这篇文章的每一步都基于vscode这款编辑器,如果你使用的不是vscode,那么就需要自行集成相关插件及其配置。该文章只是简单介绍各各代码检测的流程,至于配置项则需要读者自行前往对应的lint官网自己查看、配置需要的。

在这块中我们需要做的如下:

  • 使用tslint做代码检测
  • 使用stylelint做代码检测
  • 添加npm script进行检测
  • 使用prettier进行代码格式化
  • 使用pre-commit

5.1 使用tslint进行代码检测

我们的项目因为大量使用typescript,所以使用的是tslint检测工具,如果在你的项目中没有用到typescript,那么请使用eslint

  1. 首先我们需要在vscode中安装插件:

然后在项目中安装npm install -D tslint。此外,因为我们有大量的.tsx文件,所以还需要npm install -D tslint-react来指定针对.tsx语法的限制

  1. 接着在根目录下新建tsling.json文件,该文件用于写tslint配置文件:

  1. tslint.json中写入配置,配置项参考请点击这里

这份配置项中,上面的extends是指tslint的扩展,第一个扩展是稳定且常规的tsling检测标准,第二个则是针对.tsx文件做的检测

  1. 测试一下是否生效: 我们将no-console改为true测试一下

然后在组件中写一个console.log就可以知道这份配置表已经生效

5.2 使用stylelint做代码检测

  1. 首先,在vscode安装stylelint这个插件,该插件可以对csslessscss等类型的样式表代码进行格式和样式书写顺序上的检测:
npm install -D stylelint

  1. 我们在根目录下创建.stylelintrc.js文件,然后安装官方推荐的配置stylelint-config-standard以及针对scss代码类型检测的插件stylelint-scss:
npm install -D stylelint-config-standard stylelint-scss
  1. 然后在.stylelintrc.js文件中写入配置项

  1. 但是这时候针对scss代码的检测还是有问题的,它不能识别scss中例如@mixin@include之类的语法:

所以还需要手动写一些规则覆盖掉针对这类语法的检测使其不报错:

5.3 添加npm script进行检测

这一步主要利用tslintstylelint附带的命令行命令检测项目中存在的代码规范问题,然后输出到终端查看

  1. 去到package.json中,在scripts中添加如下命令

这条命令既检查.tsx文件也检查.scss文件

  1. 然后再终端中输入一次,就能看到报错如下

然后定位到文件中去修改即可

5.4 使用prettier进行代码格式化

除了上一节中手动定位并修改不规范的代码外,我们还可以依赖于vscode的插件来进行符合我们规范的代码格式化,这个插件推荐使用prettier

  1. 首先在vscode中安装这个插件

  1. 然后去到用户设置表中,进到工作区设置进行配置,下图是该模板的配置,当然你也可以自行配置需要的设置

  1. 回到刚才错误的地方,只要我们一保存就会自动格式化成正确的

5.5 使用pre-commit

在前面的篇幅中,我们有将lint命令添加进npm script中,但是这个命令如果要自己去运行我想很多人都会忘记,结果就会导致可能有不符合规范的代码被上传到远端代码仓库中。这种情况下我们可以做pre-commit进行代码强制检测,也就是在git commit之前进行一次代码检测,不符合规范不让commit
实现这个功能我们可以安装husky这个插件npm install -D husky,然后在npm script中添加命令就好了

六、代码

完整代码示例 https://github.com/poetries/ts-react-tpl

支持一下
扫一扫,支持poetries
  • 微信扫一扫
  • 支付宝扫一扫