Skip to content

Commit 6549681

Browse files
committed
Merge remote-tracking branch 'wechat/master'
2 parents e5d2c79 + eade47d commit 6549681

18 files changed

+2851
-22
lines changed

doc/es6编码规范.md

Lines changed: 2154 additions & 0 deletions
Large diffs are not rendered by default.
29 KB
Loading

doc/image/eslint提示.png

22.4 KB
Loading

doc/image/eslint检查.png

2.38 KB
Loading

doc/image/inspections设置.png

75.2 KB
Loading
57.5 KB
Loading
54.7 KB
Loading

doc/image/webstorm提示.png

21.7 KB
Loading

doc/react编码规范.md

Lines changed: 529 additions & 0 deletions
Large diffs are not rendered by default.

doc/代码风格.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# 编码规范
2+
虽然说代码风格没有好坏之分,只要始终坚持同一种风格就行。但是在团队协作的时候,不能只顾着坚持自己的风格,团队成员应该遵守相同的代编码规范。当然这首先需要一份团队成员都认可的编码规范。
3+
4+
在javascript的世界里,Airbnb维护的编码规范是比较流行的,用来作为团队的编码规范是不错的选择。
5+
[airbnb编码规范](https://github.com/airbnb/javascript)
6+
其中包括了es5,es6,react的代码规范,github上也有翻译后的中文版
7+
[es6编码规范](https://github.com/yuche/javascript)
8+
[react编码规范](https://github.com/JasonBoy/javascript/tree/master/react)
9+
10+
# 检查工具
11+
如何在检查自己写的代码是否符合编码规范呢,可以使用eslint工具。
12+
1. 安装eslint
13+
```npm install eslint --save-dev```
14+
2.安装es6+react规则集和配置
15+
```npm install eslint-plugin-import eslint-plugin-react eslint-plugin-jsx-a11y eslint-config-airbnb --save-dev```
16+
3.在工程跟目录下面添加eslint配置文件.eslintrc
17+
```
18+
{
19+
"extends": "airbnb"
20+
}
21+
```
22+
4.在package.json中添加脚本调用eslint,并指定要检查的文件或文件夹,多个文件或文件夹之间用空格分开
23+
```
24+
"scripts": {
25+
"start": "node node_modules/react-native/local-cli/cli.js start",
26+
"lint": "eslint index.android.js index.ios.js"
27+
}
28+
```
29+
然后执行npm run lint即可。
30+
![eslint命令行执行结果](image/eslint命令行执行结果.png)
31+
32+
# eslint与webstorm集成
33+
除了直接调用命令行执行eslint外,还可以使用webstorm来集成eslint。一般来讲,在编码过程中比较适合通过webstorm来执行eslint,因为这样会得到即时提示。在准备提交代码之前,使用命令行跑一遍eslint检查一下是个好习惯,另外在发布之前,也可以用命令行执行eslint做最后的检查。
34+
35+
打开“菜单->设置->语言和框架->javascript->代码质量工具->eslint”
36+
![webstorm中eslint配置](image/webstorm中eslint配置.png)
37+
然后webstorm中就能看到eslint的检查提示
38+
![eslint提示](image/eslint提示.png)
39+
40+
**注意:webstorm自带的检查可能会与eslint检查冲突,建议关闭webstorm自带的检查。**
41+
比如对象和数组的最后一项在airbnb的编码规则中是要求加上逗号的。但是如果加上逗号以后,webstorm自带的检查又会提示说最后一项不应该加逗号。
42+
![eslint检查](image/eslint检查.png)
43+
![webstorm提示](image/webstorm提示.png)
44+
45+
打开“菜单->设置->编辑器->inspections”
46+
![inspections设置](image/inspections设置.png)
47+
首先将javascript整个勾全部去掉,然后单独选中下面的eslint,如果觉得需要某些检查项,可以按照需求勾选。
48+
49+
# webstorm代码格式化
50+
airbnb编码规则中有些关于格式的规则可以使用webstorm的代码格式化配置来解决,只要重新格式化一下代码就能直接符合编码规则,比如:
51+
* 16.1 使用大括号包裹所有的多行代码块。
52+
* 16.2 如果通过 if 和 else 使用多行代码块,把 else 放在 if 代码块关闭括号的同一行。
53+
* 18.1 使用 2 个空格作为缩进。
54+
* 18.2 在花括号前放一个空格。
55+
* 18.3 在控制语句( if 、 while 等)的小括号前放一个空格。在函数调用及声明中,不在函数的参数列表前加空格。
56+
* 18.4 使用空格把运算符隔开。
57+
58+
打开“菜单->设置->编辑器->代码风格->javascript”
59+
![webstorm代码风格设置](image/webstorm代码风格设置.png)

0 commit comments

Comments
 (0)