ui/vant
1
0
Fork 0
mirror of https://github.com/youzan/vant.git synced 2025-10-16 08:00:34 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

feat(cli): support vite.config.ts (#11223)

Browse Source
This commit is contained in:
neverland
2022-11-05 20:39:51 +08:00
committed by GitHub
parent d9fe675af4
commit fe07c10729
5 changed files with 52 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
packages/vant-cli/docs/config.md
View File

@@ -177,17 +177,16 @@ When set to `true`, `export * from 'xxx'` will be used to export all modules and
### build.configureVite
- Type: `(config: InlineConfig): InlineConfig`
- Type: `(config: InlineConfig): InlineConfig | undefined`
- Default: `undefined`
Custom vite config(`@vant/cli>= 4.0.0`)
Custom [vite config](https://vitejs.dev/config/), requires `@vant/cli>= 4.0.0`.
```js
module.exports = {
build: {
configureVite(config) {
// add vite plugin
config.plugins.push(vitePluginXXX);
config.server.port = 3000;
return config;
},
},
@@ -214,6 +213,10 @@ module.exports = {
};
```
Note that you are not allowed to import vite plugins in `vant.config.mjs`, because the file will be bundled into the website code.
If you need to configure some vite plugins, please create a `vite.config.ts` file in the same directory of `vant.config.mjs`, in which you can add any vite configuration (this feature requires @vant/cli 5.1.0).
### build.packageManager
- Type: `'npm' | 'yarn' | 'pnpm'`

11
packages/vant-cli/docs/config.zh-CN.md
View File

@@ -177,17 +177,16 @@ module.exports = {
### build.configureVite
- Type: `(config: InlineConfig): InlineConfig`
- Type: `(config: InlineConfig): InlineConfig | undefined`
- Default: `undefined`
vant-cli 使用 vite 来构建组件库和文档站点，通过 `configureVite` 选项可以自定义 vite 配置（从 4.0.0 版本开始支持）。
vant-cli 使用 vite 来构建组件库和文档站点，通过 `configureVite` 选项可以自定义 [vite 配置](https://vitejs.dev/config/)（从 4.0.0 版本开始支持）。
```js
module.exports = {
build: {
configureVite(config) {
// 添加一个自定义插件
config.plugins.push(vitePluginXXX);
config.server.port = 3000;
return config;
},
},
@@ -216,6 +215,10 @@ module.exports = {
};
```
注意，由于 `vant.config.mjs` 文件会被打包到文档网站的代码中，因此 `configureVite` 中不允许引用 vite 插件。
如果需要配置 vite 插件，可以在 `vant.config.mjs` 的同级目录下创建 `vite.config.ts` 文件，在该文件中你可以添加任意的 vite 配置（该特性从 @vant/cli 5.1.0 版本开始支持）。
### build.packageManager
- Type: `'npm' | 'yarn' | 'pnpm'`