editorConfig编辑器配置

    当多人团队进行一个项目开发时，每个人可能喜欢的编辑器不同，有人喜欢Webstrom、有人喜欢sublime、还有人喜欢Hbuilder。

    这个时候，问题便迎面而来，如何使使用不同编辑器的开发者能够轻松惬意的遵守最基本的代码规范呢？

    最后终于找到了editorConfig这个东东，发现在这里配置的代码规范规则优先级高于编辑器默认的代码格式化规则。比如我使用的是Webstrom编辑器，我每一次写完代码之后，都习惯性的按下“Ctrl+Alt+L”快捷键去整理代码格式。如果我没有配置editorconfig，执行的就是编辑器默认的代码格式化规则；如果我已经配置了editorConfig，则按照我设置的规则来，从而忽略浏览器的设置。

    EditorConfig包含一个用于定义代码格式的文件和一批编辑器插件，这些插件是让编辑器读取配置文件并以此来格式化代码。

    下面说说它的常用配置和使用方法：

一、常用属性配置

1、root<boolean>
是否是顶级配置文件，设置为true的时候才会停止搜索.editorconfig文件。

2、charset<"latin" | "utf-8" | "utf-8-bom" | "utf-16be" | "utf-16le">
编码格式

3、indent_style<"tab" | "space">
缩进方式

4、indent_size<number>
缩进大小

5、end_of_line<"lf" | "cr" | "crlf">
换行符类型

6、insert_final_newline<boolean>
是否让文件以空行结束

7、trim_trailing_whitespace<boolean>
是否删除行尾空格

8、max_line_length<number>
最大行宽。

二、常用文件名匹配

1、*
匹配除/之外的任意字符

2、**
匹配任意字符串

3、?
匹配任意单个字符

4、[name]
匹配name字符

5、[!name]
不匹配name字符

6、[s1,s2,s3]
匹配给定的字符串

7、[num1..num2]
匹配num1到mun2直接的整数

三、使用方法

1、下载编辑器的相关插件。

2、在项目根目录下，新建.editorconfig文件。

3、配置示例，如下图所示：

image.png

<meta charset="utf-8">

四、参考网站

EditorConfig官网：https://editorconfig.org

Atom网站：https://atom.io/packages/editorconfig

GitHub：https://github.com/sindresorhus/atom-editorconfig

五、使用建议

配合代码检查工具使用，比如说：ESLint或TSLint，统一代码风格。

六、支持的编辑器

image.png

虽然editor编辑器的可用配置并不多，但目前现有的一些配置也差不多能满足最基本格式需求。

---

原文链接：https://www.jianshu.com/p/00ac7bd5e74e