p96170835
/
amis
1
0
Fork 1
Code Issues Pull Requests Releases Wiki Activity

cli: add formatting tool prettier

This commit is contained in:
SIMDD 2019-05-06 13:41:19 +08:00
parent 6e1bfd6ea6
commit 5b6f0fbd80
3 changed files with 34 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
.prettierrc Normal file
View File

@ -0,0 +1,10 @@
{
"printWidth": 80,
"tabWidth": 2,
"useTabs": false,
"singleQuote": true,
"semi": false,
"trailingComma": "none",
"bracketSpacing": true,
"arrowParens": "avoid"
}

21
docs/getting_started.md
View File

@ -25,14 +25,14 @@ title: 快速开始
简单说明以上配置信息。 简单说明以上配置信息。
* `$schema` 这个字段可以忽略，他是指定当前 JSON 配置是符合指定路径 http://amis.baidu.com/v2/schemas/page.json 的 JSON SCHEMA 文件描述的。PS: 编辑器就是靠这个描述文件提示的，可以 hover 到字段上看效果。 - `$schema` 这个字段可以忽略，他是指定当前 JSON 配置是符合指定路径 http://amis.baidu.com/v2/schemas/page.json 的 JSON SCHEMA 文件描述的。PS: 编辑器就是靠这个描述文件提示的，可以 hover 到字段上看效果。
* `type` 指定渲染器类型，这里指定的类型为 `page`。 更多渲染器类型可以去[这里面查看](/v2/docs/renderers)。 - `type` 指定渲染器类型，这里指定的类型为 `page`。 更多渲染器类型可以去[这里面查看](/v2/docs/renderers)。
* `title` 从 title 开始就是对应的渲染模型上的属性了。这里用来指定标题内容。 - `title` 从 title 开始就是对应的渲染模型上的属性了。这里用来指定标题内容。
* `subTitle` 副标题. - `subTitle` 副标题.
* `remark` 标题上面的提示信息 - `remark` 标题上面的提示信息
* `aside` 边栏区域内容 - `aside` 边栏区域内容
* `body` 内容区域的内容 - `body` 内容区域的内容
* `toolbar` 工具栏部分的内容 - `toolbar` 工具栏部分的内容
这里有三个配置都是容器类型的。`aside`、`body` 和 `toolbar`。什么是容器类型？容器类型表示，他能够把其他渲染类型放进来。以上的例子为了简单，直接放了个字符串。字符串类型内部是把他当成了 [tpl](/v2/docs/renderers#tpl) 渲染器来处理，在这里也可以通过对象的形式指定，如以下的例子的 body 区域是完全等价的。 这里有三个配置都是容器类型的。`aside`、`body` 和 `toolbar`。什么是容器类型？容器类型表示，他能够把其他渲染类型放进来。以上的例子为了简单，直接放了个字符串。字符串类型内部是把他当成了 [tpl](/v2/docs/renderers#tpl) 渲染器来处理，在这里也可以通过对象的形式指定，如以下的例子的 body 区域是完全等价的。
@ -71,7 +71,6 @@ title: 快速开始
再来看一个表单页面的列子 再来看一个表单页面的列子
```schema:height="440" ```schema:height="440"
{ {
"$schema": "http://amis.baidu.com/v2/schemas/page.json#", "$schema": "http://amis.baidu.com/v2/schemas/page.json#",
@ -185,8 +184,8 @@ title: 快速开始
"value": "3" "value": "3"
}, },
{ {
"label": "漂亮", "label": "紧张",
"value": "紧张" "value": "4"
} }
] ]
} }

13
package.json
View File

@ -114,8 +114,10 @@
"fis3-preprocessor-js-require-css": "^0.1.3", "fis3-preprocessor-js-require-css": "^0.1.3",
"font-awesome": "4.7.0", "font-awesome": "4.7.0",
"highlight.js": "^9.12.0", "highlight.js": "^9.12.0",
"husky": "^2.2.0",
"jest": "^24.5.0", "jest": "^24.5.0",
"js-yaml": "^3.10.0", "js-yaml": "^3.10.0",
"lint-staged": "^8.1.6",
"marked": "^0.3.7", "marked": "^0.3.7",
"mobx-wiretap": "^0.12.0", "mobx-wiretap": "^0.12.0",
"react-frame-component": "^2.0.0", "react-frame-component": "^2.0.0",
@ -149,5 +151,16 @@
"diagnostics": false "diagnostics": false
} }
} }
},
"husky": {
"hooks": {
"pre-commit": "lint-staged"
}
},
"lint-staged": {
"*.{js,ts,tsx,jsx,css,less,md}": [
"prettier --write",
"git add"
]
} }
} }