mirror of
https://gitee.com/vant-contrib/vant.git
synced 2025-04-05 19:41:42 +08:00
chore: make the case correct (#10458)
This commit is contained in:
neverland
GitHub
parent
d507e97996
commit
995cad17fd
@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"name": "create-vant-cli-app",
|
"name": "create-vant-cli-app",
|
||||||
"version": "2.0.0",
|
"version": "2.0.0",
|
||||||
"description": "Create Vant Cli App",
|
"description": "Create Vant CLI App",
|
||||||
"main": "lib/index.js",
|
"main": "lib/index.js",
|
||||||
"bin": {
|
"bin": {
|
||||||
"create-vant-cli-app": "./lib/index.js"
|
"create-vant-cli-app": "./lib/index.js"
|
||||||
|
|||||||
@ -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
|
- 构建后的组件库默认支持按需引入、主题定制、Tree Shaking
|
||||||
|
|
||||||
### 快速上手
|
### 快速上手
|
||||||
|
|
||||||
执行以下命令可以快速创建一个基于 Vant Cli 的项目：
|
执行以下命令可以快速创建一个基于 Vant CLI 的项目：
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
yarn create vant-cli-app
|
yarn create vant-cli-app
|
||||||
|
|||||||
@ -10,7 +10,7 @@
|
|||||||
- 使用 vite 代替 webpack 进行构建，移除了所有 webpack 相关依赖
|
- 使用 vite 代替 webpack 进行构建，移除了所有 webpack 相关依赖
|
||||||
- 使用 esbuild 进行代码转义和压缩
|
- 使用 esbuild 进行代码转义和压缩
|
||||||
- babel preset 添加了 `cjs` 后缀，现在需要通过 `@vant/cli/preset.cjs` 引入
|
- 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`
|
- 站点构建产物的目录由 `site` 调整为 `site-dist`
|
||||||
- 不再支持 webpack.config.js 配置文件
|
- 不再支持 webpack.config.js 配置文件
|
||||||
- 不再支持 less import 语法中使用波浪号
|
- 不再支持 less import 语法中使用波浪号
|
||||||
@ -471,7 +471,7 @@ yarn add sass
|
|||||||
|
|
||||||
`2020-01-12`
|
`2020-01-12`
|
||||||
|
|
||||||
- 支持自定义 Postcss 配置
|
- 支持自定义 PostCSS 配置
|
||||||
- 支持自定义 devServer 端口
|
- 支持自定义 devServer 端口
|
||||||
- 优化文档站点的 meta 字段
|
- 优化文档站点的 meta 字段
|
||||||
- 新增 API 文档中的版本标签样式
|
- 新增 API 文档中的版本标签样式
|
||||||
|
|||||||
@ -1,6 +1,6 @@
|
|||||||
# 命令
|
# 命令
|
||||||
|
|
||||||
Vant Cli 中内置了一系列的命令，可以将命令添加到 npm scripts 中进行使用。
|
Vant CLI 中内置了一系列的命令，可以将命令添加到 npm scripts 中进行使用。
|
||||||
|
|
||||||
```json
|
```json
|
||||||
// package.json
|
// package.json
|
||||||
@ -25,7 +25,7 @@ npx vant-cli dev
|
|||||||
|
|
||||||
运行本地开发环境。
|
运行本地开发环境。
|
||||||
|
|
||||||
运行 dev 命令时，Vant Cli 会通过启动一个本地服务器，用于在开发过程中对文档和示例进行预览。
|
运行 dev 命令时，Vant CLI 会通过启动一个本地服务器，用于在开发过程中对文档和示例进行预览。
|
||||||
|
|
||||||
### build
|
### build
|
||||||
|
|
||||||
|
|||||||
@ -21,7 +21,7 @@
|
|||||||
- [site.simulator.url](#sitesimulatorurl)
|
- [site.simulator.url](#sitesimulatorurl)
|
||||||
- [site.htmlMeta](#sitehtmlmeta)
|
- [site.htmlMeta](#sitehtmlmeta)
|
||||||
- [site.enableVConsole](#siteenablevconsole)
|
- [site.enableVConsole](#siteenablevconsole)
|
||||||
- [Postcss](#postcss)
|
- [PostCSS](#postcss)
|
||||||
- [默认配置](#-----1)
|
- [默认配置](#-----1)
|
||||||
- [browserslist](#browserslist)
|
- [browserslist](#browserslist)
|
||||||
|
|
||||||
@ -335,13 +335,13 @@ module.exports = {
|
|||||||
|
|
||||||
是否在 dev 时开启 [vConsole](https://github.com/Tencent/vConsole) 调试，用于移动端 debug。
|
是否在 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
|
```js
|
||||||
module.exports = {
|
module.exports = {
|
||||||
|
|||||||
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
## 源代码目录
|
## 源代码目录
|
||||||
|
|
||||||
基于 Vant Cli 搭建的组件库的基本目录结构如下所示：
|
基于 Vant CLI 搭建的组件库的基本目录结构如下所示：
|
||||||
|
|
||||||
```
|
```
|
||||||
project
|
project
|
||||||
@ -14,7 +14,7 @@ project
|
|||||||
│ ├─ home.md # 文档首页
|
│ ├─ home.md # 文档首页
|
||||||
│ └─ changelog.md # 更新日志
|
│ └─ changelog.md # 更新日志
|
||||||
│
|
│
|
||||||
├─ vant.config.mjs # Vant Cli 配置文件
|
├─ vant.config.mjs # Vant CLI 配置文件
|
||||||
├─ package.json
|
├─ package.json
|
||||||
└─ README.md
|
└─ 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` 的参考格式如下：
|
`tsconfig.declaration.json` 的参考格式如下：
|
||||||
|
|
||||||
|
|||||||
@ -1,4 +1,4 @@
|
|||||||
# Eslint Config of Vant
|
# ESLint Config of Vant
|
||||||
|
|
||||||
## Install
|
## Install
|
||||||
|
|
||||||
|
|||||||
@ -742,7 +742,7 @@ Vant follows [Semantic Versioning 2.0.0](https://semver.org/lang/zh-CN/).
|
|||||||
|
|
||||||
**Bug Fixes**
|
**Bug Fixes**
|
||||||
|
|
||||||
- fix incorrect tag prompts under Webstorm [#8450](https://github.com/youzan/vant/issues/8450)
|
- fix incorrect tag prompts under WebStorm [#8450](https://github.com/youzan/vant/issues/8450)
|
||||||
|
|
||||||
### [v3.0.11](https://github.com/youzan/vant/compare/v3.0.10...v3.0.11)
|
### [v3.0.11](https://github.com/youzan/vant/compare/v3.0.10...v3.0.11)
|
||||||
|
|
||||||
|
|||||||
@ -746,7 +746,7 @@ Vant 遵循 [Semver](https://semver.org/lang/zh-CN/) 语义化版本规范。
|
|||||||
|
|
||||||
**Bug Fixes**
|
**Bug Fixes**
|
||||||
|
|
||||||
- 修复 Webstorm 下组件标签提示不正确的问题 [#8450](https://github.com/youzan/vant/issues/8450)
|
- 修复 WebStorm 下组件标签提示不正确的问题 [#8450](https://github.com/youzan/vant/issues/8450)
|
||||||
|
|
||||||
### [v3.0.11](https://github.com/youzan/vant/compare/v3.0.10...v3.0.11)
|
### [v3.0.11](https://github.com/youzan/vant/compare/v3.0.10...v3.0.11)
|
||||||
|
|
||||||
|
|||||||
@ -73,10 +73,10 @@ For enterprise developers, we recommend:
|
|||||||
|
|
||||||
### CLI
|
### CLI
|
||||||
|
|
||||||
We recommend to use [Vue Cli](https://cli.vuejs.org/) to create a new project.
|
We recommend to use [Vue CLI](https://cli.vuejs.org/) to create a new project.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Install Vue Cli
|
# Install Vue CLI
|
||||||
npm install -g @vue/cli
|
npm install -g @vue/cli
|
||||||
|
|
||||||
# Create a project
|
# Create a project
|
||||||
|
|||||||
@ -84,7 +84,7 @@ pnpm add vant
|
|||||||
|
|
||||||
- 基于 Vite 和 Vant 搭建应用
|
- 基于 Vite 和 Vant 搭建应用
|
||||||
- 基于 Nuxt 和 Vant 搭建应用
|
- 基于 Nuxt 和 Vant 搭建应用
|
||||||
- 基于 Vue Cli 和 Vant 搭建应用
|
- 基于 Vue CLI 和 Vant 搭建应用
|
||||||
- 配置按需引入组件
|
- 配置按需引入组件
|
||||||
- 配置基于 Rem 的适配方案
|
- 配置基于 Rem 的适配方案
|
||||||
- 配置基于 Viewport 的适配方案
|
- 配置基于 Viewport 的适配方案
|
||||||
|
|||||||
@ -10,7 +10,7 @@ Vant 提供了一套默认主题，CSS 命名采用 BEM 的风格，方便使用
|
|||||||
|
|
||||||
### 示例工程
|
### 示例工程
|
||||||
|
|
||||||
我们提供了一个基于 Vue Cli 3 的示例工程，仓库地址为 [Vant Demo](https://github.com/youzan/vant-demo)，其中包含了定制主题的基本配置，可以作为参考。
|
我们提供了一个基于 Vue CLI 3 的示例工程，仓库地址为 [Vant Demo](https://github.com/youzan/vant-demo)，其中包含了定制主题的基本配置，可以作为参考。
|
||||||
|
|
||||||
### 样式变量
|
### 样式变量
|
||||||
|
|
||||||
|
|||||||
@ -222,7 +222,7 @@ imagePreviewRef.value?.swipeTo(1);
|
|||||||
|
|
||||||
| Attribute | Description | Type |
|
| Attribute | Description | Type |
|
||||||
| --------- | ---------------------- | -------- |
|
| --------- | ---------------------- | -------- |
|
||||||
| url | Url of current image | _number_ |
|
| url | URL of current image | _number_ |
|
||||||
| index | Index of current image | _number_ |
|
| index | Index of current image | _number_ |
|
||||||
|
|
||||||
### onScale Parameters
|
### onScale Parameters
|
||||||
|
|||||||
@ -38,7 +38,7 @@ export default {
|
|||||||
setup() {
|
setup() {
|
||||||
const showShare = ref(false);
|
const showShare = ref(false);
|
||||||
const options = [
|
const options = [
|
||||||
{ name: 'Wechat', icon: 'wechat' },
|
{ name: 'WeChat', icon: 'wechat' },
|
||||||
{ name: 'Weibo', icon: 'weibo' },
|
{ name: 'Weibo', icon: 'weibo' },
|
||||||
{ name: 'Link', icon: 'link' },
|
{ name: 'Link', icon: 'link' },
|
||||||
{ name: 'Poster', icon: 'poster' },
|
{ name: 'Poster', icon: 'poster' },
|
||||||
@ -73,8 +73,8 @@ export default {
|
|||||||
const showShare = ref(false);
|
const showShare = ref(false);
|
||||||
const options = [
|
const options = [
|
||||||
[
|
[
|
||||||
{ name: 'Wechat', icon: 'wechat' },
|
{ name: 'WeChat', icon: 'wechat' },
|
||||||
{ name: 'Wechat Moments', icon: 'wechat-moments' },
|
{ name: 'WeChat Moments', icon: 'wechat-moments' },
|
||||||
{ name: 'Weibo', icon: 'weibo' },
|
{ name: 'Weibo', icon: 'weibo' },
|
||||||
{ name: 'QQ', icon: 'qq' },
|
{ name: 'QQ', icon: 'qq' },
|
||||||
],
|
],
|
||||||
@ -147,7 +147,7 @@ export default {
|
|||||||
setup() {
|
setup() {
|
||||||
const showShare = ref(false);
|
const showShare = ref(false);
|
||||||
const options = [
|
const options = [
|
||||||
{ name: 'Wechat', icon: 'wechat' },
|
{ name: 'WeChat', icon: 'wechat' },
|
||||||
{ name: 'Weibo', icon: 'weibo' },
|
{ name: 'Weibo', icon: 'weibo' },
|
||||||
{ name: 'Link', icon: 'link', description: 'Description' },
|
{ name: 'Link', icon: 'link', description: 'Description' },
|
||||||
{ name: 'Poster', icon: 'poster' },
|
{ name: 'Poster', icon: 'poster' },
|
||||||
|
|||||||
@ -29,7 +29,7 @@ const t = useTranslate({
|
|||||||
link: 'Link',
|
link: 'Link',
|
||||||
title: 'Share',
|
title: 'Share',
|
||||||
weibo: 'Weibo',
|
weibo: 'Weibo',
|
||||||
wechat: 'Wechat',
|
wechat: 'WeChat',
|
||||||
poster: 'Poster',
|
poster: 'Poster',
|
||||||
qrcode: 'Qrcode',
|
qrcode: 'Qrcode',
|
||||||
multiLine: 'Multi Line',
|
multiLine: 'Multi Line',
|
||||||
@ -38,7 +38,7 @@ const t = useTranslate({
|
|||||||
customIcon: 'Custom Icon',
|
customIcon: 'Custom Icon',
|
||||||
description: 'Description',
|
description: 'Description',
|
||||||
weappQrcode: 'Weapp Qrcode',
|
weappQrcode: 'Weapp Qrcode',
|
||||||
wechatMoments: 'Wechat Moments',
|
wechatMoments: 'WeChat Moments',
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
|
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user