From 5b6f0fbd809baef47e47bbab08310bc253db5014 Mon Sep 17 00:00:00 2001 From: SIMDD Date: Mon, 6 May 2019 13:41:19 +0800 Subject: [PATCH] cli: add formatting tool prettier --- .prettierrc | 10 ++++++++++ docs/getting_started.md | 23 +++++++++++------------ package.json | 13 +++++++++++++ 3 files changed, 34 insertions(+), 12 deletions(-) create mode 100644 .prettierrc diff --git a/.prettierrc b/.prettierrc new file mode 100644 index 00000000..2e518df0 --- /dev/null +++ b/.prettierrc @@ -0,0 +1,10 @@ +{ + "printWidth": 80, + "tabWidth": 2, + "useTabs": false, + "singleQuote": true, + "semi": false, + "trailingComma": "none", + "bracketSpacing": true, + "arrowParens": "avoid" +} diff --git a/docs/getting_started.md b/docs/getting_started.md index b020e547..d0d849af 100644 --- a/docs/getting_started.md +++ b/docs/getting_started.md @@ -19,20 +19,20 @@ title: 快速开始 } ``` -> PS: 可以通过编辑器实时修改预览 +> PS: 可以通过编辑器实时修改预览 从上面的内容可以看出,一个简单页面框架已经基本出来了,这是 AMis 渲染器配置的入口。从 `page` 渲染器开始出发,通过在容器中放置不同的渲染器来配置不同性质的页面。 简单说明以上配置信息。 -* `$schema` 这个字段可以忽略,他是指定当前 JSON 配置是符合指定路径 http://amis.baidu.com/v2/schemas/page.json 的 JSON SCHEMA 文件描述的。PS: 编辑器就是靠这个描述文件提示的,可以 hover 到字段上看效果。 -* `type` 指定渲染器类型,这里指定的类型为 `page`。 更多渲染器类型可以去[这里面查看](/v2/docs/renderers)。 -* `title` 从 title 开始就是对应的渲染模型上的属性了。这里用来指定标题内容。 -* `subTitle` 副标题. -* `remark` 标题上面的提示信息 -* `aside` 边栏区域内容 -* `body` 内容区域的内容 -* `toolbar` 工具栏部分的内容 +- `$schema` 这个字段可以忽略,他是指定当前 JSON 配置是符合指定路径 http://amis.baidu.com/v2/schemas/page.json 的 JSON SCHEMA 文件描述的。PS: 编辑器就是靠这个描述文件提示的,可以 hover 到字段上看效果。 +- `type` 指定渲染器类型,这里指定的类型为 `page`。 更多渲染器类型可以去[这里面查看](/v2/docs/renderers)。 +- `title` 从 title 开始就是对应的渲染模型上的属性了。这里用来指定标题内容。 +- `subTitle` 副标题. +- `remark` 标题上面的提示信息 +- `aside` 边栏区域内容 +- `body` 内容区域的内容 +- `toolbar` 工具栏部分的内容 这里有三个配置都是容器类型的。`aside`、`body` 和 `toolbar`。什么是容器类型?容器类型表示,他能够把其他渲染类型放进来。以上的例子为了简单,直接放了个字符串。字符串类型内部是把他当成了 [tpl](/v2/docs/renderers#tpl) 渲染器来处理,在这里也可以通过对象的形式指定,如以下的例子的 body 区域是完全等价的。 @@ -71,7 +71,6 @@ title: 快速开始 再来看一个表单页面的列子 - ```schema:height="440" { "$schema": "http://amis.baidu.com/v2/schemas/page.json#", @@ -185,8 +184,8 @@ title: 快速开始 "value": "3" }, { - "label": "漂亮", - "value": "紧张" + "label": "紧张", + "value": "4" } ] } diff --git a/package.json b/package.json index c5e5ed76..257d610a 100644 --- a/package.json +++ b/package.json @@ -114,8 +114,10 @@ "fis3-preprocessor-js-require-css": "^0.1.3", "font-awesome": "4.7.0", "highlight.js": "^9.12.0", + "husky": "^2.2.0", "jest": "^24.5.0", "js-yaml": "^3.10.0", + "lint-staged": "^8.1.6", "marked": "^0.3.7", "mobx-wiretap": "^0.12.0", "react-frame-component": "^2.0.0", @@ -149,5 +151,16 @@ "diagnostics": false } } + }, + "husky": { + "hooks": { + "pre-commit": "lint-staged" + } + }, + "lint-staged": { + "*.{js,ts,tsx,jsx,css,less,md}": [ + "prettier --write", + "git add" + ] } }