Skip to content

Commit 91491a6

Browse files
renzp94renzp94
committed
docs: 更新到0.3版本变动
1 parent 88a458f commit 91491a6

File tree

5 files changed

+55
-50
lines changed

5 files changed

+55
-50
lines changed

‎.gitignore

+1-20
Original file line numberDiff line numberDiff line change
@@ -6,23 +6,4 @@ package-lock.json
66
index.d.ts
77
.DS_Store
88
dist
9-
docs/.vitepress/cache/deps/_metadata.json
10-
docs/.vitepress/cache/deps/@theme_index.js
11-
docs/.vitepress/cache/deps/@theme_index.js.map
12-
docs/.vitepress/cache/deps/chunk-HWKKPLDN.js
13-
docs/.vitepress/cache/deps/chunk-HWKKPLDN.js.map
14-
docs/.vitepress/cache/deps/chunk-VDV77W7A.js
15-
docs/.vitepress/cache/deps/chunk-VDV77W7A.js.map
16-
docs/.vitepress/cache/deps/package.json
17-
docs/.vitepress/cache/deps/vitepress___@vue_devtools-api.js
18-
docs/.vitepress/cache/deps/vitepress___@vue_devtools-api.js.map
19-
docs/.vitepress/cache/deps/vitepress___@vueuse_core.js
20-
docs/.vitepress/cache/deps/vitepress___@vueuse_core.js.map
21-
docs/.vitepress/cache/deps/vitepress___@vueuse_integrations_useFocusTrap.js
22-
docs/.vitepress/cache/deps/vitepress___@vueuse_integrations_useFocusTrap.js.map
23-
docs/.vitepress/cache/deps/vitepress___mark__js_src_vanilla__js.js
24-
docs/.vitepress/cache/deps/vitepress___mark__js_src_vanilla__js.js.map
25-
docs/.vitepress/cache/deps/vitepress___minisearch.js
26-
docs/.vitepress/cache/deps/vitepress___minisearch.js.map
27-
docs/.vitepress/cache/deps/vue.js
28-
docs/.vitepress/cache/deps/vue.js.map
9+
docs/.vitepress/cache

‎README.md

+27-20
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
# rzpack
1414

1515
### 介绍
16-
`Rzpack`是一款基于`Webpack5`开发的React打包工具，通过`Webpack5`的`cache`、`lazyCompilation`特性及`esbuild`、`swc`等工具的配合，大大提高开发环境的启动速度，热更速度及打包速度，内置了许多功能，无需复杂的配置即可快速开发。同时配套的`create-rzpack`可以快速创建项目模板，省去项目框架搭建的时间。
16+
`Rzpack`是一款基于`Webpack5`/`Rspack`开发的React打包工具，通过`Webpack5`的`cache`、`lazyCompilation`特性及`esbuild`、`swc`等工具的配合，或者使用由`Rust`开发的`Rspack`，大大提高开发环境的启动速度，热更速度及打包速度，内置了许多功能，无需复杂的配置即可快速开发。同时配套的`create-rzpack`可以快速创建项目模板，省去项目框架搭建的时间。
1717

1818
### 环境配置
1919

@@ -141,27 +141,34 @@ pnpm create rzpack rzpack-app --template react-ts
141141

142142
### 配置
143143

144-
| 属性 | 说明 | 类型 | 默认 | 是否必填 |
145-
| ---------------- | -------------------------------------------------- | ------------------------------------------ | ---------------- | -------- |
146-
| antdTheme | antd主题变量设置 | `LessVars` | - | 非必填 |
147-
| lessVars | less全局变量设置 | `LessVars` | - | 非必填 |
148-
| assets | 资源文件处理 | `RzpackAssets` | - | 非必填 |
149-
| buildInfo | 是否在控制台打印编译信息 | `boolean\|BuildInfoWebpackPluginOptions` | - | 非必填 |
150-
| cache | 是否使用webpack5缓存 | boolean | true | 非必填 |
151-
| entry | 打包入口 | `string\|string[]\|Record<string, string>` | `./src/main.tsx` | 非必填 |
152-
| gzip | 是否启用gzip | boolean | - | 非必填 |
153-
| html | htmlPlugin插件设置(配置参考htmlWebpackPlugin插件) | `HtmlWebpackPlugin.Options` | - | 非必填 |
154-
| output | 输出目录 | `Output` | `dist` | 非必填 |
155-
| publicPath | 静态资源目录 | string | `public` | 非必填 |
156-
| server | 代理配置，当开启可视化配置时此处配置的接口代理无效 | `WebpackDevServerConfiguration` | - | 非必填 |
157-
| lazyCompilation | 实验性功能 | `LazyCompilationOptions` | - | 非必填 |
158-
| moduleFederation | 模块联邦 | `ModuleFederationPluginOptions` | - | 非必填 |
159-
| webpackChain | 使用webpackChain重写webpack配置 | `RzpackWebpackChain` | - | 非必填 |
160-
| proxyFile | 可视化配置的代理，仅在开启可视化配置时才生效 | string | - | 非必填 |
161-
| reactRefresh | 是否开启React代码热更新 | boolean | - | 非必填 |
162-
| million | 是否使用Million.js | `boolean\|MillionOptions` | - | 非必填 |
144+
| 属性 | 说明 | 类型 | 默认 | 是否必填 |
145+
| ---------------- | ----------------------------------------------------------------------------------- | ------------------------------------------ | ----------------- | -------- |
146+
| builder | 打包器 | `BUILDER` | `BUILDER.WEBPACK` | 非必填 |
147+
| antdTheme | antd主题变量设置 | `LessVars` | - | 非必填 |
148+
| lessVars | less全局变量设置 | `LessVars` | - | 非必填 |
149+
| assets | 资源文件处理 | `RzpackAssets` | - | 非必填 |
150+
| buildInfo | 是否在控制台打印编译信息 | `boolean\|BuildInfoWebpackPluginOptions` | - | 非必填 |
151+
| cache | 是否使用持久化缓存(目前Webpack仅支持) | boolean | true | 非必填 |
152+
| entry | 打包入口 | `string\|string[]\|Record<string, string>` | `./src/main.tsx` | 非必填 |
153+
| gzip | 是否启用gzip | boolean | - | 非必填 |
154+
| html | htmlPlugin/HtmlRspackPlugin插件设置(配置参考htmlWebpackPlugin/HtmlRspackPlugin插件) | `HtmlWebpackPlugin.Options` | - | 非必填 |
155+
| output | 输出目录 | `Output` | `dist` | 非必填 |
156+
| publicPath | 静态资源目录 | string | `public` | 非必填 |
157+
| server | 代理配置，当开启可视化配置时此处配置的接口代理无效 | `WebpackDevServerConfiguration` | - | 非必填 |
158+
| lazyCompilation | 实验性功能 | `LazyCompilationOptions` | - | 非必填 |
159+
| moduleFederation | 模块联邦 | `ModuleFederationPluginOptions` | - | 非必填 |
160+
| webpackChain | 使用webpackChain重写webpack配置(0.2.x以下支持) | `RzpackWebpackChain` | - | 非必填 |
161+
| rzpackChain | 使用webpackChain重写webpack/rspack配置(0.3.x支持) | `RzpackWebpackChain` | - | 非必填 |
162+
| proxyFile | 可视化配置的代理，仅在开启可视化配置时才生效 | string | - | 非必填 |
163+
| reactRefresh | 是否开启React代码热更新 | boolean | - | 非必填 |
164+
| million | 是否使用Million.js | `boolean\|MillionOptions` | - | 非必填 |
163165

164166
```ts
167+
export enum BUILDER {
168+
WEBPACK = 'webpack',
169+
RSPACK = 'rspack',
170+
}
171+
165172
export interface LessVars {
166173
// 全局变量(直接定义的变量优先级高于变量文件)
167174
vars?: Record<string, string>

‎docs/pages/configs.md

+16
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,21 @@
11
# 配置
22

3+
## builder 打包器
4+
5+
- 类型：`BUILDER`
6+
- 默认：`BUILDER.WEBPACK`
7+
8+
> 目前`Rspack`尚未达到生产可用状态，可以尝鲜，生产环境慎用。
9+
10+
```ts
11+
export enum BUILDER {
12+
WEBPACK = 'webpack',
13+
RSPACK = 'rspack',
14+
}
15+
```
16+
17+
设置打包器。
18+
319
## antdTheme 主题配置
420

521
- 类型：`LessVars`

‎docs/pages/guide/cli.md

+10-9
Original file line numberDiff line numberDiff line change
@@ -40,15 +40,16 @@ rzpack build [root]
4040

4141
#### 选项
4242

43-
| 属性 | 说明 | 类型 | 默认 |
44-
| ----------------------- | ------------------- | --------- | -------------------- |
45-
| --c | 指定配置文件 | `string` | `./vigour.config.ts` |
46-
| --config | 指定配置文件 | `string` | `./vigour.config.ts` |
47-
| --m | 指定webpack启动模式 | `string` | `development` |
48-
| --mode | 指定webpack启动模式 | `string` | `development` |
49-
| --outDir [dir] | 输出目录 | `string` | `dist` |
50-
| --bundle-size [boolean] | 分析打包资源大小 | `boolean` | - |
51-
| --bundle-time [boolean] | 分析打包时长 | `boolean` | - |
43+
| 属性 | 说明 | 类型 | 默认 | 版本 |
44+
| ----------------------- | -------------------------- | --------- | -------------------- | ----- |
45+
| --c | 指定配置文件 | `string` | `./vigour.config.ts` | 0.2.x |
46+
| --config | 指定配置文件 | `string` | `./vigour.config.ts` | 0.2.x |
47+
| --m | 指定webpack启动模式 | `string` | `development` | 0.2.x |
48+
| --mode | 指定webpack启动模式 | `string` | `development` | 0.2.x |
49+
| --outDir [dir] | 输出目录 | `string` | `dist` | 0.2.x |
50+
| --bundle-size [boolean] | 分析打包资源大小 | `boolean` | - | 0.2.x |
51+
| --bundle-time [boolean] | 分析打包时长(rspack不支持) | `boolean` | - | 0.2.x |
52+
| --doctor [boolean] | 可视化构建分析工具 | `boolean` | - | 0.3 |
5253

5354
## 预览
5455

‎docs/pages/guide/what-is.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
# 什么是rzpack?
22

3-
`rzpack`是一款基于`Webpack5`开发的React打包工具，通过`Webpack5`的`cache`、`lazyCompilation`特性及`esbuild`、`swc`等工具的配合，大大提高开发环境的启动速度，热更速度及打包速度，内置了许多功能，无需复杂的配置即可快速开发。同时配套`create-rzpack`可以快速创建项目模板，省去项目框架搭建的时间。
3+
`Rzpack`是一款基于`Webpack5`/`Rspack`开发的React打包工具，通过`Webpack5`的`cache`、`lazyCompilation`特性及`esbuild`、`swc`等工具的配合，或者使用由`Rust`开发的`Rspack`，大大提高开发环境的启动速度，热更速度及打包速度，内置了许多功能，无需复杂的配置即可快速开发。同时配套的`create-rzpack`可以快速创建项目模板，省去项目框架搭建的时间。

0 commit comments

Comments
 (0)