Skip to content

Commit

Permalink
docs: 更新到0.3版本变动
Browse files Browse the repository at this point in the history
  • Loading branch information
@renzp94
renzp94 committed May 29, 2024
1 parent 88a458f commit 91491a6
Show file tree
Hide file tree
Showing 5 changed files with 55 additions and 50 deletions.
21 changes: 1 addition & 20 deletions .gitignore
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,23 +6,4 @@ package-lock.json
index.d.ts
.DS_Store
dist
docs/.vitepress/cache/deps/_metadata.json
docs/.vitepress/cache/deps/@theme_index.js
docs/.vitepress/cache/deps/@theme_index.js.map
docs/.vitepress/cache/deps/chunk-HWKKPLDN.js
docs/.vitepress/cache/deps/chunk-HWKKPLDN.js.map
docs/.vitepress/cache/deps/chunk-VDV77W7A.js
docs/.vitepress/cache/deps/chunk-VDV77W7A.js.map
docs/.vitepress/cache/deps/package.json
docs/.vitepress/cache/deps/vitepress___@vue_devtools-api.js
docs/.vitepress/cache/deps/vitepress___@vue_devtools-api.js.map
docs/.vitepress/cache/deps/vitepress___@vueuse_core.js
docs/.vitepress/cache/deps/vitepress___@vueuse_core.js.map
docs/.vitepress/cache/deps/vitepress___@vueuse_integrations_useFocusTrap.js
docs/.vitepress/cache/deps/vitepress___@vueuse_integrations_useFocusTrap.js.map
docs/.vitepress/cache/deps/vitepress___mark__js_src_vanilla__js.js
docs/.vitepress/cache/deps/vitepress___mark__js_src_vanilla__js.js.map
docs/.vitepress/cache/deps/vitepress___minisearch.js
docs/.vitepress/cache/deps/vitepress___minisearch.js.map
docs/.vitepress/cache/deps/vue.js
docs/.vitepress/cache/deps/vue.js.map
docs/.vitepress/cache
47 changes: 27 additions & 20 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
# rzpack

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

### 环境配置

Expand Down Expand Up @@ -141,27 +141,34 @@ pnpm create rzpack rzpack-app --template react-ts

### 配置

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

```ts
export enum BUILDER {
WEBPACK = 'webpack',
RSPACK = 'rspack',
}

export interface LessVars {
// 全局变量(直接定义的变量优先级高于变量文件)
vars?: Record<string, string>
Expand Down
16 changes: 16 additions & 0 deletions docs/pages/configs.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,21 @@
# 配置

## builder 打包器

- 类型：`BUILDER`
- 默认：`BUILDER.WEBPACK`

> 目前`Rspack`尚未达到生产可用状态，可以尝鲜，生产环境慎用。
```ts
export enum BUILDER {
WEBPACK = 'webpack',
RSPACK = 'rspack',
}
```

设置打包器。

## antdTheme 主题配置

- 类型：`LessVars`
Expand Down
19 changes: 10 additions & 9 deletions docs/pages/guide/cli.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,15 +40,16 @@ rzpack build [root]

#### 选项

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

## 预览

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/guide/what-is.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# 什么是rzpack?

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

0 comments on commit 91491a6

Please sign in to comment.