.editorconfig 小白教程：让团队代码风格保持一致！

当团队规模不断扩大，或是项目需要多名成员协作开发时，代码风格的不统一总会带来一些隐性成本。比如：缩进使用空格还是制表符、文件末尾是否需要新行、换行符是 LF 还是 CRLF …… 这些问题并不影响代码逻辑本身，但却常常在团队合作中产生冲突和不必要的讨论。
好在，我们有一个简洁轻量的解决方案：
.editorconfig。

1. 什么是 .editorconfig？

EditorConfig 是一个能够帮助开发者在不同的编辑器和 IDE 中定义并维护一致的编码风格的工具。通过在项目根目录放置一个名为 .editorconfig 的配置文件，你可以指定统一的缩进方式、字符编码、换行符风格等，团队里的每个人在使用兼容 EditorConfig 的编辑器时，项目的代码风格都会自动保持一致。

2. 为什么要使用 .editorconfig？

1. 减少不必要的合并冲突
   当团队成员使用了不同的编辑器，或者在编辑器中有不同的本地代码风格设置时，往往会造成一些无意义的更改，比如把别人的四个空格改成制表符，再或者从 CRLF 改成 LF 等。使用 .editorconfig 能够在源头统一约定和规范，减少此类冲突。
2. 团队协作更高效
   对于新加入的成员或者新的协作者，无需手动去配置编辑器，只要编辑器支持 EditorConfig（多数主流编辑器和 IDE 都支持），打开项目后就能自动应用项目约定的风格。
3. 跨平台一致性
   在 Windows、macOS、Linux 等不同操作系统之间换行符不统一往往带来很多困扰，有了 .editorconfig 后，在不同操作系统也能保证一致的换行符和缩进等风格。

3. .editorconfig 文件格式简介

一个最常见的 .editorconfig 文件一般由以下部分组成：

1. Root 配置
   通常放在文件的开头，使用 root = true 表示这是该项目的最顶层配置文件。如果在更上层目录下仍然存在 .editorconfig 文件，则会被忽略。

   root = true

## 匹配文件的规则

每个段落以 [pattern] 的形式定义规则。

[*] 表示匹配任何文件。
也可以指定更明确的匹配，如 [*.js] 只对 js 文件生效；[Makefile] 只对名称为 Makefile 的文件生效。

属性配置

不同的属性指定不同的风格限制，常见的属性包括：

• indent_style: 缩进类型（tab 或 space）
• indent_size: 缩进大小（整数或 tab）
• charset: 字符编码（常见为 utf-8、latin1 等）
• end_of_line: 换行符类型（lf、crlf、cr）
• insert_final_newline: 文件末尾是否添加空行（true 或 false）
• trim_trailing_whitespace: 移除行尾多余空格（true 或 false）

4. 如何创建和使用 .editorconfig？

在项目根目录创建 .editorconfig 文件

如果你的项目以前没有使用过 EditorConfig，可以手动在项目根目录下创建一个名为 .editorconfig 的文件，并把想要统一的规则写进去。

启用 EditorConfig 支持

大多数主流 IDE 或编辑器（如 VS Code、IntelliJ IDEA、WebStorm、Android Studio 等）都内置或可通过插件支持 EditorConfig。
一旦你的编辑器启用了该功能，就会自动解析 .editorconfig 规则并对打开的文件生效。

提交到版本控制

将 .editorconfig 文件一同提交到版本库（Git、SVN 等），让团队里每个人都能共享相同的代码风格配置。

5. 常见的 .editorconfig 示例

以下是一个比较常见的 .editorconfig 配置示例：

表示这是根目录下的配置文件

root = true

通用配置，对所有文件生效

[*]
indent_style = space
indent_size = 4
charset = utf-8
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true

针对 Markdown 文件的特殊配置

[*.md]
trim_trailing_whitespace = false

针对 Makefile 的特殊配置

[Makefile]
indent_style = tab

在这个配置里：

• 我们用空格作为缩进风格，大小为 4。
• 统一使用 utf-8 编码，并且换行符为 LF。
• 文件末尾自动保留一个换行 (true)。
• 一般情况下都会删除行尾空格，但是 Markdown 文件的行尾空格在某些情况下有特殊用途，所以这里特例设置为不去除。
• Makefile 的缩进通常必须使用制表符，这里单独进行指定。

6. 常见问题解答

我的编辑器是不是不支持 .editorconfig？

大多数流行编辑器均支持 EditorConfig。如果你使用的编辑器不支持，可以搜索关键字 “EditorConfig + 编辑器名称” 看看是否有相关插件。

为什么我修改了 .editorconfig 后，没有生效？

• 确认 .editorconfig 文件是否在项目根目录，并且 root = true。
• 检查编辑器设置里是否开启了对 EditorConfig 的支持。
• 部分编辑器需要重启或者重新打开文件来加载新的配置。

我的团队里有人使用不同的 IDE，会不会冲突？

只要各自的 IDE 版本或其相应插件版本支持 EditorConfig，并且都能正确读取 .editorconfig，就不会产生冲突。

7. 小结

.editorconfig 是一种非常轻量级且实用的工具，能够有效帮助团队统一代码风格，减少合并冲突与无意义的差异。你只需编写一个简短的配置文件，并确保团队所有成员都使用支持 EditorConfig 的编辑器即可享受它带来的便利。

如果你还没有尝试在项目中使用 .editorconfig，不妨在下一个新项目或者现有项目里加上它吧。相信你会发现，很多让人头疼的风格问题从此迎刃而解！