From d48cd73adb6a40c9fff8141bf7a9213d72974660 Mon Sep 17 00:00:00 2001 From: chenjiahan Date: Thu, 2 Apr 2020 15:39:06 +0800 Subject: [PATCH] chore: prettier markdown files --- docs/markdown/home.en-US.md | 32 +++++++-------- docs/markdown/home.zh-CN.md | 34 +++++++-------- docs/markdown/quickstart.en-US.md | 23 ++++++----- docs/markdown/quickstart.zh-CN.md | 45 +++++++++++--------- docs/markdown/style-guide.zh-CN.md | 66 ++++++++++-------------------- docs/markdown/theme.en-US.md | 10 ++--- docs/markdown/theme.zh-CN.md | 8 ++-- docs/site/mobile.js | 4 +- test/dom.ts | 2 +- test/index.ts | 2 +- 10 files changed, 105 insertions(+), 121 deletions(-) diff --git a/docs/markdown/home.en-US.md b/docs/markdown/home.en-US.md index 0fd88be4e..94c63eab9 100644 --- a/docs/markdown/home.en-US.md +++ b/docs/markdown/home.en-US.md @@ -8,14 +8,14 @@ ### Features -* 60+ Reusable components -* 90% Unit test coverage -* Extensive documentation and demos -* Support [babel-plugin-import](https://github.com/ant-design/babel-plugin-import) -* Support Custom Theme -* Support i18n -* Support TS -* Support SSR +- 60+ Reusable components +- 90% Unit test coverage +- Extensive documentation and demos +- Support [babel-plugin-import](https://github.com/ant-design/babel-plugin-import) +- Support Custom Theme +- Support i18n +- Support TS +- Support SSR ### Quickstart @@ -31,18 +31,18 @@ Modern browsers and Android 4.0+, iOS 8.0+. ### Ecosystem -| Project | Description | -|-----|------| -| [vant-demo](https://github.com/youzan/vant-demo) | Official vant demo collection | -| [vant-weapp](https://github.com/youzan/vant-weapp) | WeChat MiniProgram UI | -| [vant-cli](https://github.com/youzan/vant/tree/dev/packages/vant-cli) | Scaffold for UI library | -| [vant-icons](https://github.com/youzan/vant/tree/dev/packages/vant-icons) | Vant icons | +| Project | Description | +| ------------------------------------------------------------------------------------------- | ------------------------------ | +| [vant-demo](https://github.com/youzan/vant-demo) | Official vant demo collection | +| [vant-weapp](https://github.com/youzan/vant-weapp) | WeChat MiniProgram UI | +| [vant-cli](https://github.com/youzan/vant/tree/dev/packages/vant-cli) | Scaffold for UI library | +| [vant-icons](https://github.com/youzan/vant/tree/dev/packages/vant-icons) | Vant icons | | [vant-touch-emulator](https://github.com/youzan/vant/tree/dev/packages/vant-touch-emulator) | Using vant in desktop browsers | ### Links -* [Feedback](https://github.com/youzan/vant/issues) -* [Changelog](#/en-US/changelog) +- [Feedback](https://github.com/youzan/vant/issues) +- [Changelog](#/en-US/changelog) ### LICENSE diff --git a/docs/markdown/home.zh-CN.md b/docs/markdown/home.zh-CN.md index 5b161f26c..7dda5c38d 100644 --- a/docs/markdown/home.zh-CN.md +++ b/docs/markdown/home.zh-CN.md @@ -8,14 +8,14 @@ ### 特性 -* 60+ 高质量组件 -* 90% 单元测试覆盖率 -* 完善的中英文文档和示例 -* 支持按需引入 -* 支持主题定制 -* 支持国际化 -* 支持 TS -* 支持 SSR +- 60+ 高质量组件 +- 90% 单元测试覆盖率 +- 完善的中英文文档和示例 +- 支持按需引入 +- 支持主题定制 +- 支持国际化 +- 支持 TS +- 支持 SSR ### 快速上手 @@ -47,19 +47,19 @@ ### 生态 -| 项目 | 描述 | -|-----|------| -| [vant-demo](https://github.com/youzan/vant-demo) | Vant 官方示例合集 | -| [vant-weapp](https://github.com/youzan/vant-weapp) | 微信小程序组件库 | -| [vant-cli](https://github.com/youzan/vant/tree/dev/packages/vant-cli) | 开箱即用的组件库搭建工具 | -| [vant-icons](https://github.com/youzan/vant/tree/dev/packages/vant-icons) | Vant 图标库 | +| 项目 | 描述 | +| ------------------------------------------------------------------------------------------- | -------------------------- | +| [vant-demo](https://github.com/youzan/vant-demo) | Vant 官方示例合集 | +| [vant-weapp](https://github.com/youzan/vant-weapp) | 微信小程序组件库 | +| [vant-cli](https://github.com/youzan/vant/tree/dev/packages/vant-cli) | 开箱即用的组件库搭建工具 | +| [vant-icons](https://github.com/youzan/vant/tree/dev/packages/vant-icons) | Vant 图标库 | | [vant-touch-emulator](https://github.com/youzan/vant/tree/dev/packages/vant-touch-emulator) | 在桌面端使用 Vant 的辅助库 | ### 链接 -* [意见反馈](https://github.com/youzan/vant/issues) -* [更新日志](#/zh-CN/changelog) -* [码云镜像](https://gitee.com/organizations/vant-contrib) +- [意见反馈](https://github.com/youzan/vant/issues) +- [更新日志](#/zh-CN/changelog) +- [码云镜像](https://gitee.com/organizations/vant-contrib) ### 开源协议 diff --git a/docs/markdown/quickstart.en-US.md b/docs/markdown/quickstart.en-US.md index fd647220c..3a1f00d71 100644 --- a/docs/markdown/quickstart.en-US.md +++ b/docs/markdown/quickstart.en-US.md @@ -78,7 +78,7 @@ import { Button } from 'vant'; import Button from 'vant/lib/button'; import 'vant/lib/button/style'; ``` - + ### 3. Import all components ```js @@ -97,7 +97,10 @@ The easiest way to use Vant is to include a CDN link in the html file, after whi ```html - + @@ -107,7 +110,7 @@ The easiest way to use Vant is to include a CDN link in the html file, after whi // Render the Button component new Vue({ el: '#app', - template: `Button` + template: `Button`, }); // Call function component @@ -131,13 +134,13 @@ postcss config example: ```js module.exports = { plugins: { - 'autoprefixer': { - browsers: ['Android >= 4.0', 'iOS >= 8'] + autoprefixer: { + browsers: ['Android >= 4.0', 'iOS >= 8'], }, 'postcss-pxtorem': { rootValue: 37.5, - propList: ['*'] - } - } -} -``` \ No newline at end of file + propList: ['*'], + }, + }, +}; +``` diff --git a/docs/markdown/quickstart.zh-CN.md b/docs/markdown/quickstart.zh-CN.md index 3ee3c03b6..9c80c80ca 100644 --- a/docs/markdown/quickstart.zh-CN.md +++ b/docs/markdown/quickstart.zh-CN.md @@ -41,7 +41,6 @@ yarn add vant - 配置基于 TypeScript 的工程 - 配置自定义主题色方案 - ## 引入组件 ### 方式一. 自动按需引入组件 (推荐) @@ -115,21 +114,24 @@ Vue.use(Vant); ```html - + ``` @@ -149,15 +151,15 @@ Vant 中的样式默认使用`px`作为单位，如果需要使用`rem`单位， ```js module.exports = { plugins: { - 'autoprefixer': { - browsers: ['Android >= 4.0', 'iOS >= 8'] + autoprefixer: { + browsers: ['Android >= 4.0', 'iOS >= 8'], }, 'postcss-pxtorem': { rootValue: 37.5, - propList: ['*'] - } - } -} + propList: ['*'], + }, + }, +}; ``` > 在配置 postcss-loader 时，应避免 ignore node_modules 目录，否则将导致 Vant 样式无法被编译 @@ -184,7 +186,10 @@ iPhone X 等机型底部存在底部指示条，指示条的操作区域与页 ```html - + @@ -207,14 +212,14 @@ Vant 中的许多组件提供了实例方法，调用实例方法时，我们需 export default { data() { return { - checked: false + checked: false, }; }, // 注意：组件挂载后才能访问到 ref 对象 mounted() { this.$refs.checkbox.toggle(); - } -} + }, +}; ``` ## 常见问题 @@ -230,7 +235,7 @@ export default { ``` -这是因为 HTML 并不支持自闭合的自定义元素，也就是说 `` 这样的语法是不被识别的，使用完整的闭合标签可以避免这个问题： +这是因为 HTML 并不支持自闭合的自定义元素，也就是说 `` 这样的语法是不被识别的，使用完整的闭合标签可以避免这个问题： ```html diff --git a/docs/markdown/style-guide.zh-CN.md b/docs/markdown/style-guide.zh-CN.md index 05fd8be6b..437a50c4d 100644 --- a/docs/markdown/style-guide.zh-CN.md +++ b/docs/markdown/style-guide.zh-CN.md @@ -12,18 +12,18 @@ // bad export default { data: { - foo: 'bar' - } -} + foo: 'bar', + }, +}; // good export default { - data () { + data() { return { - foo: 'bar' - } - } -} + foo: 'bar', + }; + }, +}; ``` ### 单文件组件文件名称 @@ -78,16 +78,16 @@ components/ // bad export default { props: { - 'greeting-text': String - } + 'greeting-text': String, + }, }; // good export default { props: { - greetingText: String - } -} + greetingText: String, + }, +}; ``` ```html @@ -98,38 +98,16 @@ export default { ``` -### Props 换行 - -多个 Props 的元素应该分多行撰写，每个 Props 一行，闭合标签单起一行。 - -```html - - - - - -``` - ### 指令缩写 指令缩写，用 `:` 表示 `v-bind:` ，用 `@` 表示 `v-on:` ```html - + - + ``` ### Props 顺序 @@ -175,7 +153,7 @@ export default { destroyed() {}, - methods: {} + methods: {}, }; ``` @@ -192,7 +170,7 @@ export default { styles() { // ... - } + }, }, methods: { @@ -202,8 +180,8 @@ export default { onChange() { // ... - } - } + }, + }, }; ``` @@ -213,14 +191,14 @@ export default { ```html ``` diff --git a/docs/markdown/theme.en-US.md b/docs/markdown/theme.en-US.md index 5639bdc0a..71e8fa27b 100644 --- a/docs/markdown/theme.en-US.md +++ b/docs/markdown/theme.en-US.md @@ -21,7 +21,6 @@ There are some basic variables below, all available variables could be found in ## How to custom theme - ### Step 1: import less file First you should import the less source file to your project. you can use babel-plugin-import to automatically import or just manually import less file. @@ -39,11 +38,11 @@ module.exports = { libraryName: 'vant', libraryDirectory: 'es', // specify less file path - style: name => `${name}/style/less` + style: (name) => `${name}/style/less`, }, - 'vant' - ] - ] + 'vant', + ], + ], }; ``` @@ -107,4 +106,3 @@ module.exports = { }, }; ``` - diff --git a/docs/markdown/theme.zh-CN.md b/docs/markdown/theme.zh-CN.md index e44ef8d92..2818d4b91 100644 --- a/docs/markdown/theme.zh-CN.md +++ b/docs/markdown/theme.zh-CN.md @@ -42,11 +42,11 @@ module.exports = { libraryName: 'vant', libraryDirectory: 'es', // 指定样式路径 - style: name => `${name}/style/less` + style: (name) => `${name}/style/less`, }, - 'vant' - ] - ] + 'vant', + ], + ], }; ``` diff --git a/docs/site/mobile.js b/docs/site/mobile.js index eb566099c..a27993dd5 100644 --- a/docs/site/mobile.js +++ b/docs/site/mobile.js @@ -49,7 +49,7 @@ Vue.mixin({ const locales = {}; const camelizedName = camelize(name); - Object.keys(i18n).forEach(key => { + Object.keys(i18n).forEach((key) => { locales[key] = { [camelizedName]: i18n[key] }; }); @@ -60,7 +60,7 @@ Vue.mixin({ // switch lang after routing if (window.vueRouter) { - window.vueRouter.afterEach(to => { + window.vueRouter.afterEach((to) => { const { lang } = to.meta || {}; if (lang) { diff --git a/test/dom.ts b/test/dom.ts index b88984669..ae5556627 100644 --- a/test/dom.ts +++ b/test/dom.ts @@ -43,7 +43,7 @@ export function mockGetBoundingClientRect( Element.prototype.getBoundingClientRect = jest.fn(() => rect); - return function() { + return function () { Element.prototype.getBoundingClientRect = originMethod; }; } diff --git a/test/index.ts b/test/index.ts index de479a8dd..fc3f459ab 100644 --- a/test/index.ts +++ b/test/index.ts @@ -9,7 +9,7 @@ Vue.component('transition', TransitionStub as any); // promisify setTimeout export function later(delay: number = 0): Promise { - return new Promise(resolve => { + return new Promise((resolve) => { setTimeout(resolve, delay); }); }