EditorConfig——统一代码风格工具
1、为什么使用EditorConfig？
在团队开发中，统一的代码格式是必要的。
但是不同开发人员的代码风格不同，代码编辑工具的默认格式也不相同，在大型项目开发中，这样就造成不能开发人员代码的风格不同。
而editorConfig可以帮助开发人员在不同的编辑器和IDE中定义和维护一致的编码风格。
你好！ 这是你第一次使用 Markdown编辑器 所展示的欢迎页。如果你想学习如何使用Markdown编辑器, 可以仔细阅读这篇文章，了解一下Markdown的基本语法知识。
2、EditorConfig简介
editorConfig不是什么软件，而是一个名称为.editorconfig的自定义文件。
editorConfig文件用来定义项目的编码规范，编辑器的行为会与.editorconfig 文件中定义的一致，并且其优先级比编辑器自身的设置要高。
Webstorm 2017.1 版本之后都是自动安装这个插件的，有些编辑器则需要安装editorConfig插件。
3、EditorConfig工作方式
当打开一个文件时，EditorConfig插件会在打开文件的目录和其每一级父目录查找.editorconfig文件，直到有一个配置文件root=true。
EditorConfig的配置文件是从上往下读取的并且最近的EditorConfig配置文件会被最先读取。
匹配EditorConfig配置文件中的配置项会按照读取顺序被应用, 所以最近的配置文件中的配置项拥有优先权。
如果.editorconfig文件没有进行某些配置，则使用编辑器默认的设置。
4、EditorConfig语法
| 通配符 | 意义 |
|---|---|
| * | 匹配除/之外的任意字符串 |
| ** | 匹配任意字符串 |
| ？ | 匹配任意单个字符 |
| [name] | 匹配name中的任意一个单一字符 |
| [!name] | 匹配不存在name中的任意一个单一字符 |
| {a1,a2,a3} | 匹配给定的字符串中的任意一个 |
| {num1 . . num2} | 匹配num1到num2之间的任意一个整数, 这里的num1和num2可以为正整数也可以为负整数 |
文件格式
EditorConfig文件使用INI格式。斜杠(/)作为路径分隔符，#作为注释。
示例 .editorconfig 文件
# http://editorconfig.org
# 控制 .editorconfig 是否生效的字段
root = true
[*]
#缩进风格：空格
indent_style = space
#缩进大小2
indent_size = 2
#换行符lf
end_of_line = lf
#字符集utf-8
charset = utf-8
#是否删除行尾的空格
trim_trailing_whitespace = true
#是否在文件的最后插入一个空行
insert_final_newline = true
[*.md]
trim_trailing_whitespace = false
[Makefile]
indent_style = tab
属性说明
| 通配符 | 意义 |
|---|---|
| indent_style | 设置缩进风格(tab是硬缩进，space为软缩进) |
| indent_size | 用一个整数定义的列数来设置缩进的宽度，如果indent_style为tab，则此属性默认为tab_width |
| tab_width | 用一个整数来设置tab缩进的列数。默认是indent_size |
| end_of_line | 设置换行符，值为lf、cr和crlf |
| charset | 设置编码，值为latin1、utf-8、utf-16be和utf-16le |
| trim_trailing_whitespace | 设为true表示会去除换行行首的任意空白字符 |
| insert_final_newline | 设为true表示使文件以一个空白行结尾 |
| root | 表示是最顶层的配置文件，发现设为true时，才会停止查找.editorconfig文件 |