From 995cad17fd8941ba394f5a325d9930ac90de81a0 Mon Sep 17 00:00:00 2001 From: neverland Date: Sat, 2 Apr 2022 10:57:54 +0800 Subject: [PATCH] chore: make the case correct (#10458) --- packages/create-vant-cli-app/package.json | 2 +- packages/vant-cli/README.md | 8 ++++---- packages/vant-cli/changelog.md | 4 ++-- packages/vant-cli/docs/commands.md | 4 ++-- packages/vant-cli/docs/config.md | 8 ++++---- packages/vant-cli/docs/directory.md | 6 +++--- packages/vant-eslint-config/README.md | 2 +- packages/vant/docs/markdown/changelog.en-US.md | 2 +- packages/vant/docs/markdown/changelog.zh-CN.md | 2 +- packages/vant/docs/markdown/quickstart.en-US.md | 4 ++-- packages/vant/docs/markdown/quickstart.zh-CN.md | 2 +- packages/vant/docs/markdown/theme.zh-CN.md | 2 +- packages/vant/src/image-preview/README.md | 2 +- packages/vant/src/share-sheet/README.md | 8 ++++---- packages/vant/src/share-sheet/demo/index.vue | 4 ++-- 15 files changed, 30 insertions(+), 30 deletions(-) diff --git a/packages/create-vant-cli-app/package.json b/packages/create-vant-cli-app/package.json index 7c896e569..5ea4eadfa 100644 --- a/packages/create-vant-cli-app/package.json +++ b/packages/create-vant-cli-app/package.json @@ -1,7 +1,7 @@ { "name": "create-vant-cli-app", "version": "2.0.0", - "description": "Create Vant Cli App", + "description": "Create Vant CLI App", "main": "lib/index.js", "bin": { "create-vant-cli-app": "./lib/index.js" diff --git a/packages/vant-cli/README.md b/packages/vant-cli/README.md index df02f0c53..89949aeff 100644 --- a/packages/vant-cli/README.md +++ b/packages/vant-cli/README.md @@ -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 diff --git a/packages/vant-cli/changelog.md b/packages/vant-cli/changelog.md index 51afe59bd..1860f1fba 100644 --- a/packages/vant-cli/changelog.md +++ b/packages/vant-cli/changelog.md @@ -10,7 +10,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 +471,7 @@ yarn add sass `2020-01-12` -- 支持自定义 Postcss 配置 +- 支持自定义 PostCSS 配置 - 支持自定义 devServer 端口 - 优化文档站点的 meta 字段 - 新增 API 文档中的版本标签样式 diff --git a/packages/vant-cli/docs/commands.md b/packages/vant-cli/docs/commands.md index deed799d5..c0382f51f 100644 --- a/packages/vant-cli/docs/commands.md +++ b/packages/vant-cli/docs/commands.md @@ -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 diff --git a/packages/vant-cli/docs/config.md b/packages/vant-cli/docs/config.md index 4e927cbc9..81b022e26 100644 --- a/packages/vant-cli/docs/config.md +++ b/packages/vant-cli/docs/config.md @@ -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 = { diff --git a/packages/vant-cli/docs/directory.md b/packages/vant-cli/docs/directory.md index 1b870d653..a0e6a77ef 100644 --- a/packages/vant-cli/docs/directory.md +++ b/packages/vant-cli/docs/directory.md @@ -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` 的参考格式如下： diff --git a/packages/vant-eslint-config/README.md b/packages/vant-eslint-config/README.md index 89413a262..8d1264ba7 100644 --- a/packages/vant-eslint-config/README.md +++ b/packages/vant-eslint-config/README.md @@ -1,4 +1,4 @@ -# Eslint Config of Vant +# ESLint Config of Vant ## Install diff --git a/packages/vant/docs/markdown/changelog.en-US.md b/packages/vant/docs/markdown/changelog.en-US.md index 58157a0f7..ceebb80da 100644 --- a/packages/vant/docs/markdown/changelog.en-US.md +++ b/packages/vant/docs/markdown/changelog.en-US.md @@ -742,7 +742,7 @@ Vant follows [Semantic Versioning 2.0.0](https://semver.org/lang/zh-CN/). **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) diff --git a/packages/vant/docs/markdown/changelog.zh-CN.md b/packages/vant/docs/markdown/changelog.zh-CN.md index 7a12e3812..f47fceb34 100644 --- a/packages/vant/docs/markdown/changelog.zh-CN.md +++ b/packages/vant/docs/markdown/changelog.zh-CN.md @@ -746,7 +746,7 @@ Vant 遵循 [Semver](https://semver.org/lang/zh-CN/) 语义化版本规范。 **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) diff --git a/packages/vant/docs/markdown/quickstart.en-US.md b/packages/vant/docs/markdown/quickstart.en-US.md index eeba1f27d..088ca21a3 100644 --- a/packages/vant/docs/markdown/quickstart.en-US.md +++ b/packages/vant/docs/markdown/quickstart.en-US.md @@ -73,10 +73,10 @@ For enterprise developers, we recommend: ### 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 -# Install Vue Cli +# Install Vue CLI npm install -g @vue/cli # Create a project diff --git a/packages/vant/docs/markdown/quickstart.zh-CN.md b/packages/vant/docs/markdown/quickstart.zh-CN.md index e3853227b..eb839bdea 100644 --- a/packages/vant/docs/markdown/quickstart.zh-CN.md +++ b/packages/vant/docs/markdown/quickstart.zh-CN.md @@ -84,7 +84,7 @@ pnpm add vant - 基于 Vite 和 Vant 搭建应用 - 基于 Nuxt 和 Vant 搭建应用 -- 基于 Vue Cli 和 Vant 搭建应用 +- 基于 Vue CLI 和 Vant 搭建应用 - 配置按需引入组件 - 配置基于 Rem 的适配方案 - 配置基于 Viewport 的适配方案 diff --git a/packages/vant/docs/markdown/theme.zh-CN.md b/packages/vant/docs/markdown/theme.zh-CN.md index f96f7559d..44ea1c73c 100644 --- a/packages/vant/docs/markdown/theme.zh-CN.md +++ b/packages/vant/docs/markdown/theme.zh-CN.md @@ -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)，其中包含了定制主题的基本配置，可以作为参考。 ### 样式变量 diff --git a/packages/vant/src/image-preview/README.md b/packages/vant/src/image-preview/README.md index 18708ea98..808c46eef 100644 --- a/packages/vant/src/image-preview/README.md +++ b/packages/vant/src/image-preview/README.md @@ -222,7 +222,7 @@ imagePreviewRef.value?.swipeTo(1); | Attribute | Description | Type | | --------- | ---------------------- | -------- | -| url | Url of current image | _number_ | +| url | URL of current image | _number_ | | index | Index of current image | _number_ | ### onScale Parameters diff --git a/packages/vant/src/share-sheet/README.md b/packages/vant/src/share-sheet/README.md index 03295f57c..1d230a041 100644 --- a/packages/vant/src/share-sheet/README.md +++ b/packages/vant/src/share-sheet/README.md @@ -38,7 +38,7 @@ export default { setup() { const showShare = ref(false); const options = [ - { name: 'Wechat', icon: 'wechat' }, + { name: 'WeChat', icon: 'wechat' }, { name: 'Weibo', icon: 'weibo' }, { name: 'Link', icon: 'link' }, { name: 'Poster', icon: 'poster' }, @@ -73,8 +73,8 @@ export default { const showShare = ref(false); const options = [ [ - { name: 'Wechat', icon: 'wechat' }, - { name: 'Wechat Moments', icon: 'wechat-moments' }, + { name: 'WeChat', icon: 'wechat' }, + { name: 'WeChat Moments', icon: 'wechat-moments' }, { name: 'Weibo', icon: 'weibo' }, { name: 'QQ', icon: 'qq' }, ], @@ -147,7 +147,7 @@ export default { setup() { const showShare = ref(false); const options = [ - { name: 'Wechat', icon: 'wechat' }, + { name: 'WeChat', icon: 'wechat' }, { name: 'Weibo', icon: 'weibo' }, { name: 'Link', icon: 'link', description: 'Description' }, { name: 'Poster', icon: 'poster' }, diff --git a/packages/vant/src/share-sheet/demo/index.vue b/packages/vant/src/share-sheet/demo/index.vue index 53a51d04e..c6824bd9a 100644 --- a/packages/vant/src/share-sheet/demo/index.vue +++ b/packages/vant/src/share-sheet/demo/index.vue @@ -29,7 +29,7 @@ const t = useTranslate({ link: 'Link', title: 'Share', weibo: 'Weibo', - wechat: 'Wechat', + wechat: 'WeChat', poster: 'Poster', qrcode: 'Qrcode', multiLine: 'Multi Line', @@ -38,7 +38,7 @@ const t = useTranslate({ customIcon: 'Custom Icon', description: 'Description', weappQrcode: 'Weapp Qrcode', - wechatMoments: 'Wechat Moments', + wechatMoments: 'WeChat Moments', }, });