docs: formatted with prettier (#768)

* docs: formatted with prettier * chore: add prettier auto-formatting on commit
alibaba · Apr 2, 2020 · cb7f095 · cb7f095
1 parent 0d9c671
commit cb7f095
Show file tree

Hide file tree

Showing 52 changed files with 5,689 additions and 5,135 deletions.
diff --git a/README.md b/README.md
@@ -59,7 +59,6 @@ npm install --save @formily/core
 
 ![](https://img.alicdn.com/tfs/TB1BvlRu4D1gK0jSZFsXXbldVXa-1882-1144.png)
 
-
 ## WebSite
 
 https://formilyjs.org
@@ -72,7 +71,6 @@ https://formilyjs.org
 - [@formily/react](./packages/react/README.md)
 - [@formily/core](./packages/core/README.md)
 
-
 ## Demo
 
 [codesandbox](https://codesandbox.io/s/o5up7)
@@ -81,13 +79,11 @@ https://formilyjs.org
 
 - [icejs](https://github.com/alibaba/ice)
 
-
 ## Contributors
 
-This project exists thanks to all the people who contribute. 
+This project exists thanks to all the people who contribute.
 <a href="https://github.com/alibaba/formily/graphs/contributors"><img src="https://opencollective.com/formily/contributors.svg?width=890" /></a>
 
-
 ## LICENSE
 
 Formily is open source software licensed as

diff --git a/README.zh-cn.md b/README.zh-cn.md
@@ -13,7 +13,7 @@
 
 ## 背景
 
-在React中，在受控模式下，表单的整树渲染问题非常明显。特别是对于数据联动的场景，很容易导致页面卡顿，为了解决这个问题，我们将每个表单字段的状态做了分布式管理，从而大大提升了表单操作性能。同时，我们深度整合了JSON Schema协议，可以帮助您快速解决后端驱动表单渲染的问题。
+在 React 中，在受控模式下，表单的整树渲染问题非常明显。特别是对于数据联动的场景，很容易导致页面卡顿，为了解决这个问题，我们将每个表单字段的状态做了分布式管理，从而大大提升了表单操作性能。同时，我们深度整合了 JSON Schema 协议，可以帮助您快速解决后端驱动表单渲染的问题。
 
 ## 特性
 
@@ -37,13 +37,13 @@ npm install --save antd @formily/antd @formily/antd-components
 npm install --save @alifd/next @formily/next @formily/next-components
 ```
 
-使用Formily React渲染引擎包:
+使用 Formily React 渲染引擎包:
 
 ```bash
 npm install --save @formily/react-schema-renderer
 ```
 
-使用 Formily React包:
+使用 Formily React 包:
 
 ```bash
 npm install --save @formily/react
@@ -71,7 +71,6 @@ https://formilyjs.org
 - [@formily/react](./packages/react/README.zh-cn.md)
 - [@formily/core](./packages/core/README.zh-cn.md)
 
-
 ## 入门案例
 
 [codesandbox](https://codesandbox.io/s/o5up7)
@@ -80,13 +79,11 @@ https://formilyjs.org
 
 - [icejs](https://github.com/alibaba/ice)
 
-
 ## 贡献者
 
-This project exists thanks to all the people who contribute. 
+This project exists thanks to all the people who contribute.
 <a href="https://github.com/alibaba/formily/graphs/contributors"><img src="https://opencollective.com/formily/contributors.svg?width=890" /></a>
 
-
 ## LICENSE
 
 Formily is open source software licensed as

diff --git a/docs/en-us/SUMMARY.md b/docs/en-us/SUMMARY.md
@@ -1,19 +1,19 @@
 - [首页](./README.md)
-- Schema开发指南
+- Schema 开发指南
   - 介绍
   - 快速开始
   - 概念/术语理解
     - 理解表单生命周期
-    - 理解actions/effects
+    - 理解 actions/effects
     - 理解表单路径系统
     - 理解传值属性
     - 理解表单节点树
     - 理解表单组件扩展机制
   - 实践教程
     - 使用布局组件
-    - 使用Effect Hooks
-    - 自定义Effect Hook
-    - 借助Rxjs实现联动逻辑
+    - 使用 Effect Hooks
+    - 自定义 Effect Hook
+    - 借助 Rxjs 实现联动逻辑
     - 实现超复杂联动逻辑
     - 实现联动校验
     - 跨组件操作表单
@@ -34,15 +34,15 @@
   - 快速开始
   - 概念/术语理解
     - 理解表单生命周期
-    - 理解actions/effects
+    - 理解 actions/effects
     - 理解表单路径系统
     - 理解传值属性
     - 理解表单节点树
   - 实践教程
     - 使用布局组件
-    - 使用Effect Hooks
-    - 自定义Effect Hook
-    - 借助Rxjs实现联动逻辑
+    - 使用 Effect Hooks
+    - 自定义 Effect Hook
+    - 借助 Rxjs 实现联动逻辑
     - 实现超复杂联动逻辑
     - 实现联动校验
     - 跨组件操作表单
@@ -56,17 +56,17 @@
 - 其他指南
   - 底层扩展开发
     - 介绍
-    - 理解核心API
-    - 理解Observable Graph
+    - 理解核心 API
+    - 理解 Observable Graph
     - 扩展实现@formily/vue
     - 扩展实现@formily/mini-app
     - FAQ
   - 升级迁移指南
-    - UForm迁移Formily
+    - UForm 迁移 Formily
   - 开发调试指南
     - devtools
   - 贡献指南
-- API手册
+- API 手册
   - Ant Design
     - antd
     - antd-components

diff --git a/docs/zh-cn/README.md b/docs/zh-cn/README.md
@@ -1,7 +1,6 @@
-
 ## 背景
 
-在React中，在受控模式下，表单的整树渲染问题非常明显。特别是对于数据联动的场景，很容易导致页面卡顿，为了解决这个问题，我们将每个表单字段的状态做了分布式管理，从而大大提升了表单操作性能。同时，我们深度整合了JSON Schema协议，可以帮助您快速解决后端驱动表单渲染的问题。
+在 React 中，在受控模式下，表单的整树渲染问题非常明显。特别是对于数据联动的场景，很容易导致页面卡顿，为了解决这个问题，我们将每个表单字段的状态做了分布式管理，从而大大提升了表单操作性能。同时，我们深度整合了 JSON Schema 协议，可以帮助您快速解决后端驱动表单渲染的问题。
 
 ## 特性
 
@@ -25,13 +24,13 @@ npm install --save antd @formily/antd
 npm install --save @alifd/next @formily/next
 ```
 
-使用Formily React渲染引擎包:
+使用 Formily React 渲染引擎包:
 
 ```bash
 npm install --save @formily/react-schema-renderer
 ```
 
-使用 Formily React包:
+使用 Formily React 包:
 
 ```bash
 npm install --save @formily/react
@@ -45,17 +44,15 @@ npm install --save @formily/core
 
 ## 社区
 
-
-| Online Chat Room                                             | 微信                                                         | 钉钉 |
-| ------------------------------------------------------------ | ------------------------------------------------------------ | ---- |
-| [gitter.im](https://gitter.im/alibaba-formily/community?source=orgpage) | <img width="200" src="https://img.alicdn.com/tfs/TB1jhm5VNYaK1RjSZFnXXa80pXa-620-824.png"/> |   <img width="200" src="https://img.alicdn.com/tfs/TB1pHMzUrPpK1RjSZFFXXa5PpXa-620-818.png"/>   |
+| Online Chat Room                                                        | 微信                                                                                        | 钉钉                                                                                        |
+| ----------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
+| [gitter.im](https://gitter.im/alibaba-formily/community?source=orgpage) | <img width="200" src="https://img.alicdn.com/tfs/TB1jhm5VNYaK1RjSZFnXXa80pXa-620-824.png"/> | <img width="200" src="https://img.alicdn.com/tfs/TB1pHMzUrPpK1RjSZFFXXa5PpXa-620-818.png"/> |
 
 ## 贡献者
 
-This project exists thanks to all the people who contribute. 
+This project exists thanks to all the people who contribute.
 <a href="https://github.com/alibaba/formily/graphs/contributors"><img src="https://opencollective.com/formily/contributors.svg?width=890&button=false" /></a>
 
-
 ## LICENSE
 
 Formily is open source software licensed as

diff --git a/docs/zh-cn/SUMMARY.md b/docs/zh-cn/SUMMARY.md
@@ -1,14 +1,13 @@
-
 - 首页
-  - [Formily是什么](./introduction/formily.md)
+  - [Formily 是什么](./introduction/formily.md)
   - [竞品对比](./introduction/comparison.md)
 - Schema Form
   - [介绍](./schema-develop/introduction.md)
   - [快速开始](./schema-develop/quick-start.md)
   - 概念/术语理解
-    - [理解Form Schema](./schema-develop/form-schema.md)
+    - [理解 Form Schema](./schema-develop/form-schema.md)
     - [理解表单生命周期](./schema-develop/lifecycle.md)
-    - [理解actions/effects](./schema-develop/actions-effects.md)
+    - [理解 actions/effects](./schema-develop/actions-effects.md)
     - [理解表单路径系统](./schema-develop/form-path.md)
     - [理解传值属性](./schema-develop/form-value.md)
     - [理解表单状态](./schema-develop/form-state.md)
@@ -28,7 +27,7 @@
   - [快速开始](./jsx-develop/quick-start.md)
   - 概念/术语理解
     - [理解表单生命周期](./jsx-develop/lifecycle.md)
-    - [理解actions/effects](./jsx-develop/actions-effects.md)
+    - [理解 actions/effects](./jsx-develop/actions-effects.md)
     - [理解表单路径系统](./jsx-develop/form-path.md)
     - [理解传值属性](./jsx-develop/form-value.md)
     - [理解表单状态](./jsx-develop/form-state.md)
@@ -43,7 +42,7 @@
   - [FAQ](./jsx-develop/faq.md)
 - Help
   - 升级迁移指南
-    - [UForm迁移Formily](./uform-upgrade.md)
+    - [UForm 迁移 Formily](./uform-upgrade.md)
   - 开发调试指南
     - [Chrome Devtools](./devtools.md)
   - [其他文档/资料](./other-links.md)

diff --git a/docs/zh-cn/contributor.md b/docs/zh-cn/contributor.md
@@ -6,48 +6,55 @@
 
 ## 我可以贡献什么？
 
-* features 新增/修改功能特性
-* unitest 新增/修改单测
-* bugfix 修复现有issue的问题
-* doc 文档改进
-* other 其他
+- features 新增/修改功能特性
+- unitest 新增/修改单测
+- bugfix 修复现有 issue 的问题
+- doc 文档改进
+- other 其他
 
 ## 如何贡献？
 
 #### 拉取仓库
-* 原始仓库：https://github.com/alibaba/formily
-* 目标仓库：folk到自己的github上
-![](https://img.alicdn.com/tfs/TB1NLrjxXY7gK0jSZKzXXaikpXa-2206-490.png)
+
+- 原始仓库：https://github.com/alibaba/formily
+- 目标仓库：fork 到自己的 github 上
+  ![](https://img.alicdn.com/tfs/TB1NLrjxXY7gK0jSZKzXXaikpXa-2206-490.png)
 
 #### 拉取分支
-原始分支是 alibaba/formily master ，拉取后的分支应该是 quirkyshop/formily master
+
+原始分支是 alibaba/formily master，拉取后的分支应该是 quirkyshop/formily master
+
 > 注意：建议分支名为[feat]-[name]，[feat]是这个分支的类型，可选的有[feat][unitest][doc][bugfix][other]，[name]则是名字，自定义就好了。eg. unittest-core(意为：对核心补充单测)
 
 #### 提交代码
-
-代码风格遵循2空格，无分号，非说明请不要在代码中附带任何console相关的方法及debugger。
-开发完成后，到自己folk出来的仓库提交pull request
+
+代码风格遵循 2 空格，无分号，非说明请不要在代码中附带任何 console 相关的方法及 debugger。
+开发完成后，到自己 fork 出来的仓库提交 pull request
 ![](https://img.alicdn.com/tfs/TB1HSvqxkT2gK0jSZFkXXcIQFXa-2050-898.png)
 ![](https://img.alicdn.com/tfs/TB1O.6mxbr1gK0jSZR0XXbP8XXa-1696-254.png)
-> 注意这里的左边目标仓库(base repository是 alibaba/formily master) ，然后右边当前分支自己仓库的 doc-wiki
 
-#### PR规范
+> 注意这里的左边目标仓库(base repository 是 alibaba/formily master) ，然后右边当前分支自己仓库的 doc-wiki
+
+#### PR 规范
+
 参考文档：https://github.com/alibaba/formily/blob/master/.github/GIT_COMMIT_SPECIFIC.md
-* PR名称：格式：`<type>(<scope>): <subject>` 举例：`feat(core): add unit test` 
-* PR内容：列举本次改动的内容
-* PR要求：增加的feat内容，尽量做到注释清晰，相应的单测覆盖要尽可能覆盖
-* BUGFIX要求：如果修改的问题和issues相关，请在内容中附上相关的issueID。
+
+- PR 名称：格式：`<type>(<scope>): <subject>` 举例：`feat(core): add unit test`
+- PR 内容：列举本次改动的内容
+- PR 要求：增加的 feat 内容，尽量做到注释清晰，相应的单测覆盖要尽可能覆盖
+- BUGFIX 要求：如果修改的问题和 issues 相关，请在内容中附上相关的 issueID。
 
 #### 审核与合并
-审核阶段会进入多review的流程，`@janryWang` 负责审核这个改动是否合并，其他同学也会参与讨论，讨论的经过都会留存在github的PR里，钉钉群也会收到相应的通知。
 
-当看到PullRequests列表中的状态变为closed即为合并成功。
+审核阶段会进入多 review 的流程，`@janryWang` 负责审核这个改动是否合并，其他同学也会参与讨论，讨论的经过都会留存在 github 的 PR 里，钉钉群也会收到相应的通知。
+
+当看到 Pull requests 列表中的状态变为 Closed 即为合并成功。
 ![](https://img.alicdn.com/tfs/TB1HUnjxXY7gK0jSZKzXXaikpXa-964-104.png)
 
-#### 同步源仓库变更到folk后的仓库
+#### 同步源仓库变更到 fork 后的仓库
 
 ```shell
-# 首先在自己的分支增加一个upstream，即原仓库
+# 首先在自己的分支增加一个 upstream，即原仓库
 $ git remote add upstream https://github.com/alibaba/formily.git
 # 获取原仓库最新的变更
 $ git fetch upstream
@@ -56,43 +63,52 @@ $ git pull upstream master [当前本地目标分支，不填默认就是当前
 ```
 
 #### 项目开发
-拉取目录到本地后，需要安装依赖，并且由于是多项目管理，互相有依赖，需要用lerna来做到
+
+拉取目录到本地后，需要安装依赖，并且由于是多项目管理，互相有依赖，需要用 lerna 来做到
+
 ```shell
 $ cd formily
-$ npm install #安装整体项目依赖
-$ npm run build #先跑一遍构建
+$ npm install # 安装整体项目依赖
+$ npm run build # 先跑一遍构建
 $ npm run bootstrap  # 安装子项目依赖
-$ npm run build #各自构建子项目lib
+$ npm run build # 各自构建子项目lib
 ```
 
 #### 目录结构
-* core 核心层
-* react UI层，react实现
-* validator 校验器
-* shared 公共逻辑
-* react-shared-component 通用视图组件层
-* react-schema-editor 可视化Schema编辑器
-* react-schema-renderer Schema渲染组件
-* antd/next/meet 生态层
-* antd/next/meet-components 生态组件层
-* printer Schema打印组件
-* devtools 浏览器插件
-* ...
+
+- core 核心层
+- react UI 层，react 实现
+- validator 校验器
+- shared 公共逻辑
+- react-shared-component 通用视图组件层
+- react-schema-editor 可视化 Schema 编辑器
+- react-schema-renderer Schema 渲染组件
+- antd/next/meet 生态层
+- antd/next/meet-components 生态组件层
+- printer Schema 打印组件
+- devtools 浏览器插件
+- ...
 
 #### 开发模式
-举例说明，现在开发core，想要比较有体感的使用某个core的API
+
+举例说明，现在开发 core，想要比较有体感的使用某个 core 的 API
+
 ```shell
 $ cd formily
-$ npm run doc:core # 查看core的demo展示，目录位于 packages/core/README.md
+$ npm run doc:core # 查看 core 的 demo 展示，目录位于 packages/core/README.md
 ```
+
 此时编辑 packages/core/README.md 会在 `watch` 模式下看到 `demo` 的改变，方便直观感受和修改代码
 
 > 更多开发模式请参考源码，我们在各个目录下都提供了示例 `README.md` 的 `demo` 。
 
 #### 单元测试
-举例说明，现在对core进行单测覆盖
+
+举例说明，现在对 core 进行单测覆盖
+
 ```shell
 $ cd formily
 $ npm run test:core # 会执行 packages/core/src/__test__ 下的单元测试
 ```
-> 更多单测形式请参考源码，我们已在源码中提供超过200个单元测试！
+
+> 更多单测形式请参考源码，我们已在源码中提供超过 200 个单元测试！
diff --git a/docs/zh-cn/devtools.md b/docs/zh-cn/devtools.md
@@ -1,6 +1,6 @@
-# Formily Chrome Devtools 
+# Formily Chrome Devtools
 
-目前提供了chrome扩展开发者工具，可以帮助用户方便的查看状态树
+目前提供了 chrome 扩展开发者工具，可以帮助用户方便的查看状态树
 
 ## 下载地址
 
@@ -9,4 +9,3 @@ https://chrome.google.com/webstore/detail/formily-devtools/kkocalmbfnplecdmbadaa
 ## 预览
 
 ![](https://img.alicdn.com/tfs/TB1fnoEvVP7gK0jSZFjXXc5aXXa-2146-1584.png)
-
diff --git a/docs/zh-cn/introduction/comparison.md b/docs/zh-cn/introduction/comparison.md
@@ -1 +1 @@
-# 竞品对比
+# 竞品对比