Merge branch 'dev' into next

This commit is contained in:
chenjiahan
2022-04-05 10:31:21 +08:00
43 changed files with 443 additions and 225 deletions

View File

@@ -1,17 +1,17 @@
# Vant Cli
# Vant CLI
Vant Cli 是一个 Vue 组件库构建工具,通过 Vant Cli 可以快速搭建一套功能完备的 Vue 组件库。
Vant CLI 是一个 Vue 组件库构建工具,通过 Vant CLI 可以快速搭建一套功能完备的 Vue 组件库。
### 特性
- 提供丰富的命令,涵盖从开发测试到构建发布的完整流程
- 基于约定的目录结构,自动生成优雅的文档站点和组件示例
- 内置 ESlint、Stylelint 校验规则,提交代码时自动执行校验
- 内置 ESLint、Stylelint 校验规则,提交代码时自动执行校验
- 构建后的组件库默认支持按需引入、主题定制、Tree Shaking
### 快速上手
执行以下命令可以快速创建一个基于 Vant Cli 的项目:
执行以下命令可以快速创建一个基于 Vant CLI 的项目:
```bash
yarn create vant-cli-app

View File

@@ -1,5 +1,13 @@
# 更新日志
## v4.0.1
`2022-03-03`
- 支持复制示例代码到剪贴板
- 修复官网更新日志的版本链接及 issue 链接异常的问题
- 修复 ReDoS 安全问题
## v4.0.0
`2022-02-07`
@@ -10,7 +18,7 @@
- 使用 vite 代替 webpack 进行构建,移除了所有 webpack 相关依赖
- 使用 esbuild 进行代码转义和压缩
- babel preset 添加了 `cjs` 后缀,现在需要通过 `@vant/cli/preset.cjs` 引入
- vant.config.js 重命名为 `vant.config.mjs`,由 commonJs 变更为 ESModule 格式
- vant.config.js 重命名为 `vant.config.mjs`,由 CommonJS 变更为 ESModule 格式
- 站点构建产物的目录由 `site` 调整为 `site-dist`
- 不再支持 webpack.config.js 配置文件
- 不再支持 less import 语法中使用波浪号
@@ -471,7 +479,7 @@ yarn add sass
`2020-01-12`
- 支持自定义 Postcss 配置
- 支持自定义 PostCSS 配置
- 支持自定义 devServer 端口
- 优化文档站点的 meta 字段
- 新增 API 文档中的版本标签样式

View File

@@ -1,6 +1,6 @@
# 命令
Vant Cli 中内置了一系列的命令,可以将命令添加到 npm scripts 中进行使用。
Vant CLI 中内置了一系列的命令,可以将命令添加到 npm scripts 中进行使用。
```json
// package.json
@@ -25,7 +25,7 @@ npx vant-cli dev
运行本地开发环境。
运行 dev 命令时Vant Cli 会通过启动一个本地服务器,用于在开发过程中对文档和示例进行预览。
运行 dev 命令时Vant CLI 会通过启动一个本地服务器,用于在开发过程中对文档和示例进行预览。
### build

View File

@@ -21,7 +21,7 @@
- [site.simulator.url](#sitesimulatorurl)
- [site.htmlMeta](#sitehtmlmeta)
- [site.enableVConsole](#siteenablevconsole)
- [Postcss](#postcss)
- [PostCSS](#postcss)
- [默认配置](#-----1)
- [browserslist](#browserslist)
@@ -335,13 +335,13 @@ module.exports = {
是否在 dev 时开启 [vConsole](https://github.com/Tencent/vConsole) 调试,用于移动端 debug。
## Postcss
## PostCSS
通过根目录下的`postcss.config.js`文件可以对 Postcss 进行配置。
通过根目录下的`postcss.config.js`文件可以对 PostCSS 进行配置。
### 默认配置
`vant-cli` 中默认的 Postcss 配置如下:
`vant-cli` 中默认的 PostCSS 配置如下:
```js
module.exports = {

View File

@@ -2,7 +2,7 @@
## 源代码目录
基于 Vant Cli 搭建的组件库的基本目录结构如下所示:
基于 Vant CLI 搭建的组件库的基本目录结构如下所示:
```
project
@@ -14,7 +14,7 @@ project
│ ├─ home.md # 文档首页
│ └─ changelog.md # 更新日志
├─ vant.config.mjs # Vant Cli 配置文件
├─ vant.config.mjs # Vant CLI 配置文件
├─ package.json
└─ README.md
```
@@ -83,7 +83,7 @@ button
### 生成类型声明
当组件库使用 TS 编写,且根目录下存在 `tsconfig.declaration.json` 文件Vant Cli 会自动生成 `.d.ts` 类型声明文件。
当组件库使用 TS 编写,且根目录下存在 `tsconfig.declaration.json` 文件Vant CLI 会自动生成 `.d.ts` 类型声明文件。
`tsconfig.declaration.json` 的参考格式如下:

View File

@@ -47,8 +47,8 @@
"dependencies": {
"@babel/core": "^7.16.0",
"@babel/preset-typescript": "^7.16.0",
"@docsearch/css": "3.0.0-alpha.50",
"@docsearch/js": "3.0.0-alpha.50",
"@docsearch/css": "^3.0.0",
"@docsearch/js": "^3.0.0",
"@types/jest": "^27.0.3",
"@vant/eslint-config": "^3.3.2",
"@vant/markdown-vetur": "^2.2.0",
@@ -62,7 +62,7 @@
"commander": "^8.3.0",
"consola": "^2.15.3",
"conventional-changelog": "^3.1.24",
"esbuild": "^0.14.21",
"esbuild": "^0.14.29",
"eslint": "^8.1.0",
"execa": "^5.1.1",
"fast-glob": "^3.2.7",
@@ -86,7 +86,7 @@
"stylelint": "^13.0.0",
"transliteration": "^2.2.0",
"typescript": "^4.5.2",
"vite": "^2.8.0",
"vite": "^2.9.0",
"vite-plugin-html": "^2.1.1",
"vite-plugin-md": "^0.11.4",
"vue-router": "^4.0.12"