4、项目规范

EditorConfig

1.说明

　　在多人合作的项目中，每个人的开发习惯是不同的。以缩进来说，有的人习惯使用 space 键来进行缩进，有的人喜欢用 tab 键，有的人喜欢设置缩进为 4 个空格，有的人喜欢设置为 2 个空格。这样产生的后果就是每个人修改后的代码在格式上总是不统一的，那么提交到 git 上就会代码风格不一致，变得丑陋无比。

2.链接

　　EditorConfig官网

　　EditorConfig完整配置属性说明表

　　好奇，项目根目录下的.editorconfig文件

3.安装

　　EditorConfig for VS Code

　　Ps:不同的IDE搜索EditorConfig插件安装即可

4.创建约束文件

　　在根目录下创建.editorconfig文件

4.1.原代码

root = true

[*]
charset=utf-8
end_of_line=lf
insert_final_newline=true
indent_style=space
indent_size=2
max_line_length = 100

[*.{yml,yaml,json}]
indent_style = space
indent_size = 2

[*.md]
trim_trailing_whitespace = false

[Makefile]
indent_style = tab

4.2注释版

#告诉EditorConfig插件，这是根文件，不用继续往上查找
root = true

#匹配全部文件
[*]
#使用`utf-8`字符集。
charset=utf-8
#结尾换行符，可选`lf`、`cr`、`crlf`
end_of_line=lf
#在文件结尾插入新行
insert_final_newline=true
#缩进的样式为空格
indent_style=space
#缩进为2
indent_size=2
#行最大长度为100
max_line_length = 100

#匹配以`.yml`、`.yaml`、`.json`结尾的文件
[*.{yml,yaml,json}]
indent_style = space
indent_size = 2

#匹配以`.md`结尾的文件
[*.md]
trim_trailing_whitespace = false

#
[Makefile]
indent_style = tab

5.测试

　　在项目的 js 文件中使用 tab 键进行缩进，分别修改 indent_size 属性值为 2 和 4，观察是否有变化。如果没有任何变化，说明还没有安装 Editorconfig 插件