docs(@vant/cli): changelog 4.0.0

This commit is contained in:
chenjiahan 2022-02-07 15:01:53 +08:00
parent 5a1deaf68d
commit 71eb44b42e
4 changed files with 21 additions and 121 deletions

View File

@ -68,5 +68,4 @@ pnpm add @vant/cli -D
- [命令](https://github.com/youzan/vant/tree/dev/packages/vant-cli/docs/commands.md)
- [配置指南](https://github.com/youzan/vant/tree/dev/packages/vant-cli/docs/config.md)
- [目录结构](https://github.com/youzan/vant/tree/dev/packages/vant-cli/docs/directory.md)
- [桌面端组件](https://github.com/youzan/vant/tree/dev/packages/vant-cli/docs/desktop.md)
- [更新日志](https://github.com/youzan/vant/tree/dev/packages/vant-cli/changelog.md)

View File

@ -1,72 +1,57 @@
# 更新日志
## v4.0.0-rc.6
## v4.0.0
- 修复通过 pnpm 安装使用时报错的问题
## v4.0.0-rc.4
- 新增 CommonJS 格式的构建产物,分别为 `lib/[name].cjs.js``lib/[name].cjs.min.js`
- 现在 ESModule 和 CommonJS 格式的产物会自动对外部依赖进行 external 处理
- 修复 Windows 路径兼容问题
## v4.0.0-rc.3
`2022-02-07`
### 不兼容更新
- 支持的 node 版本范围提升到 `^14.16.0 || >=16.0.0`
- 使用 vite 代替 webpack 进行构建,移除了所有 webpack 相关依赖
- 使用 esbuild 进行代码转义和压缩
- babel preset 添加了 `cjs` 后缀,现在需要通过 `@vant/cli/preset.cjs` 引入
- vant.config.js 重命名为 `vant.config.mjs`,由 commonJs 变更为 ESModule 格式
### Features
- 新增 build.configureWebpack 配置项
### 依赖升级
对以下依赖进行了大版本升级:
- eslint v8
## v4.0.0-beta.6
### 不兼容更新
- 使用 vite 代替 webpack 进行构建,移除了所有 webpack 相关依赖
- 站点构建产物的目录由 `site` 调整为 `site-dist`
- 不再支持 webpack.config.js 配置文件
- 不再支持 less import 语法中使用波浪号
- 不再在 demo 文件中自动注册组件
- 暂时不支持预览桌面端组件
- 移除 build 命令的 --watch 参数
- 移除内置的 babel-plugin-import 插件
- 由于不再使用 html-webpack-plugin, 因此移除了 site.htmlPluginOptions 配置项
- 为了避免幽灵依赖,不再默认依赖 `@vue/test-utils`,使用时需要手动安装
- 为了减少依赖数量,移除了默认安装的 sass 依赖,使用 sass 时需要手动安装:
```bash
yarn add sass
```
- 为了避免 Phantom dependency不再默认依赖 `@vue/test-utils`,使用时需要手动安装
### Features
- 新增 site.htmlMeta 配置项
- 新增 ESModule 格式的构建产物,分别为 `lib/[name].es.js``lib/[name].es.min.js`
### 依赖升级
对以下依赖进行了大版本升级:
- eslint v8
- jest v27
- husky v7
- ts-jest v27
- postcss v8
- clean-css v5
- commander v8
- babel-jest v27
- lint-staged v11
- autoprefixer v10
### Features
- 新增 site.htmlMeta 配置项
- 新增 build.configureWebpack 配置项
- 新增 ESModule 格式的构建产物,分别为 `lib/[name].es.js``lib/[name].es.min.js`
- 新增 CommonJS 格式的构建产物,分别为 `lib/[name].cjs.js``lib/[name].cjs.min.js`
- 现在 ESModule 和 CommonJS 格式的产物会自动对外部依赖进行 external 处理
### BugFixes
- 修复 Windows 路径兼容问题
- 修复通过 pnpm 安装使用时报错的问题
## v3.11.2
`2021-07-15`

View File

@ -25,7 +25,7 @@ npx vant-cli dev
运行本地开发环境。
运行 dev 命令时Vant Cli 会通过 [webpack-dev-server](https://github.com/webpack/webpack-dev-server) 启动一个本地服务器,用于在开发过程中对文档和示例进行预览。
运行 dev 命令时Vant Cli 会通过启动一个本地服务器,用于在开发过程中对文档和示例进行预览。
### build

View File

@ -1,84 +0,0 @@
## 关于桌面端组件
Vant Cli 也支持预览桌面端组件,你可以在组件的 `demo` 目录下新建一个 `.vue` 文件,并在组件的 `README` 中按如下格式声明要预览的组件:
```html
<demo-code>./demo/MyDemo.vue</demo-code>
```
`demo-code` 标签中间的文本为 `README``demo` 文件的相对路径。
```
button
├─ demo # 组件示例
│ └─ MyDemo.vue # 要预览的 demo 文件
├─ index.js # 组件入口
├─ index.less # 组件样式
└─ README.md # 组件文档
```
![image](https://user-images.githubusercontent.com/5093611/111076378-0e981a00-8527-11eb-8e3f-31f0be7e4021.png)
`demo-code` 标签支持以下属性:
| 名称 | 类型 | 描述 |
| --------- | ------- | --------------------------------------- |
| compact | boolean | 紧凑模式 |
| transform | boolean | 防止预览区内 fixed 定位的元素飞出预览区 |
| inline | boolean | 只显示组件本身,不显示预览区边框和代码 |
### `compact`
```html
<demo-code compact>./demo/MyDemo.vue</demo-code>
```
![image](https://user-images.githubusercontent.com/5093611/111076728-77cc5d00-8528-11eb-85f1-e7217344ab14.png)
### `transform`
```html
<demo-code transform>./demo/MyDemo.vue</demo-code>
```
![image](https://user-images.githubusercontent.com/5093611/111076799-d5f94000-8528-11eb-973f-c9d69f91d2a7.png)
### `inline`
```html
<demo-code inline>./demo/MyDemo.vue</demo-code>
```
![image](https://user-images.githubusercontent.com/5093611/111076845-15c02780-8529-11eb-9cfb-76c9b25dc2a2.png)
### 去除手机模拟器
对于 PC 端的组件,如果不需要右侧的手机模拟器,可以在 `vant.config.js` 文件中设置 `site.hideSimulator``true`,这样在所有页面都会隐藏手机模拟器,也可以只针对具体页面设置。
```js
module.exports = {
site: {
defaultLang: 'zh-CN',
hideSimulator: true, // 所有页面都不显示
locales: {
'zh-CN': {
title: 'Vant',
description: '轻量、可靠的移动端 Vue 组件库',
hideSimulator: true, // 中文下所有页面都不显示
nav: [
{
title: '基础组件',
items: [
{
path: 'button',
title: 'Button 按钮',
hideSimulator: true, // 只针对某个页面不显示
},
],
},
],
},
},
},
};
```