88[ react编码规范] ( https://github.com/JasonBoy/javascript/tree/master/react )
99
1010# 检查工具
11- 如何在检查自己写的代码是否符合编码规范呢,可以使用eslint工具。
11+ 如何在检查自己写的代码是否符合编码规范呢,可以使用eslint工具。
12121 . 安装eslint
13- ``` npm install eslint --save-dev ```
13+ ``` npm install eslint --save-dev ```
14142.安装es6+react规则集和配置
15- ``` npm install eslint-plugin-import eslint-plugin-react eslint-plugin-jsx-a11y eslint-config-airbnb --save-dev ```
15+ ``` npm install eslint-plugin-import eslint-plugin-react eslint-plugin-jsx-a11y eslint-config-airbnb --save-dev ```
16163.在工程跟目录下面添加eslint配置文件.eslintrc
1717```
1818{
1919 "extends": "airbnb"
2020}
21- ```
21+ ```
22224.在package.json中添加脚本调用eslint,并指定要检查的文件或文件夹,多个文件或文件夹之间用空格分开
2323```
2424"scripts": {
2525 "start": "node node_modules/react-native/local-cli/cli.js start",
2626 "lint": "eslint index.android.js index.ios.js"
2727 }
28- ```
29- 然后执行npm run lint即可。
28+ ```
29+ 然后执行npm run lint即可。
3030![ eslint命令行执行结果] ( image/eslint命令行执行结果.png )
3131
3232# eslint与webstorm集成
3333除了直接调用命令行执行eslint外,还可以使用webstorm来集成eslint。一般来讲,在编码过程中比较适合通过webstorm来执行eslint,因为这样会得到即时提示。在准备提交代码之前,使用命令行跑一遍eslint检查一下是个好习惯,另外在发布之前,也可以用命令行执行eslint做最后的检查。
3434
35- 打开“菜单->设置->语言和框架->javascript->代码质量工具->eslint”
36- ![ webstorm中eslint配置] ( image/webstorm中eslint配置.png )
37- 然后webstorm中就能看到eslint的检查提示
35+ 打开“菜单->设置->语言和框架->javascript->代码质量工具->eslint”
36+ ![ webstorm中eslint配置] ( image/webstorm中eslint配置.png )
37+ 然后webstorm中就能看到eslint的检查提示
3838![ eslint提示] ( image/eslint提示.png )
3939
4040** 注意:webstorm自带的检查可能会与eslint检查冲突,建议关闭webstorm自带的检查。**
41- 比如对象和数组的最后一项在airbnb的编码规则中是要求加上逗号的。但是如果加上逗号以后,webstorm自带的检查又会提示说最后一项不应该加逗号。
42- ![ eslint检查] ( image/eslint检查.png )
41+ 比如对象和数组的最后一项在airbnb的编码规则中是要求加上逗号的。但是如果加上逗号以后,webstorm自带的检查又会提示说最后一项不应该加逗号。
42+ ![ eslint检查] ( image/eslint检查.png )
4343![ webstorm提示] ( image/webstorm提示.png )
4444
45- 打开“菜单->设置->编辑器->inspections”
46- ![ inspections设置] ( image/inspections设置.png )
45+ 打开“菜单->设置->编辑器->inspections”
46+ ![ inspections设置] ( image/inspections设置.png )
4747首先将javascript整个勾全部去掉,然后单独选中下面的eslint,如果觉得需要某些检查项,可以按照需求勾选。
4848
4949# webstorm代码格式化
@@ -53,6 +53,6 @@ airbnb编码规则中有些关于格式的规则可以使用webstorm的代码格
5353* 18.1 使用 2 个空格作为缩进。
5454* 18.2 在花括号前放一个空格。
5555* 18.3 在控制语句( if 、 while 等)的小括号前放一个空格。在函数调用及声明中,不在函数的参数列表前加空格。
56- * 18.4 使用空格把运算符隔开。
57- 打开“菜单->设置->编辑器->代码风格->javascript”
58- ![ webstorm代码风格设置] ( image/webstorm代码风格设置.png )
56+ * 18.4 使用空格把运算符隔开。
57+ * 打开“菜单->设置->编辑器->代码风格->javascript”
58+ * ![ webstorm代码风格设置] ( image/webstorm代码风格设置.png )
0 commit comments