首页 技术设计 工具

# 一、.editorconfig 文件是什么？

在项目里，大多时候都能看到.editorconfig 文件，刚开始总是忽视掉它，认为它不太重要。但是，它的存在，必定有它的理由，于是，抽空来研究一下，它是什么，能做什么。

官网是这么介绍 EditorConfig 的，“EditorConfig 帮助开发人员在不同的编辑器和 IDE 之间定义和维护一致的编码样式。EditorConfig 项目由用于定义编码样式的文件格式和一组文本编辑器插件组成，这些插件使编辑器能够读取文件格式并遵循定义的样式。EditorConfig 文件易于阅读，并且与版本控制系统配合使用。”

不同的开发人员，不同的编辑器，有不同的编码风格，而 EditorConfig 就是用来协同团队开发人员之间的代码的风格及样式规范化的一个工具，而.editorconfig 正是它的默认配置文件。

# 二、示例文件

# 告诉EditorConfig插件，这是根文件，不用继续往上查找root = true
# 匹配全部文件
[*]
# 结尾换行符，可选"lf"、"cr"、"crlf"
end_of_line = lf
# 在文件结尾插入新行
insert_final_newline = true
# 删除一行中的前后空格
trim_trailing_whitespace = true
# 匹配js和py结尾的文件
[*.{js,py}]
# 设置字符集
charset = utf-8

# 匹配py结尾的文件
[*.py]
# 缩进风格，可选"space"、"tab"
indent_style = space
# 缩进的空格数
indent_size = 4

# 以下匹配，类同
[Makefile]
indent_style = tab# tab的宽度tab_width = 4
# 以下匹配，类同
[lib/**.js]
indent_style = space
indent_size = 2

[{package.json,.travis.yml}]
indent_style = space
indent_size = 2

# 三、注意事项、配置说明

1、如果是 windows 用户，如果无法创建.editorconfig 文件，则需要先创建.editorconfig. 文件，系统会自动重命名成.editorconfig 文件。

2、EditorConfig 的匹配规则是从上往下，即先定义的规则优先级比后定义的优先级要高。

3、插件安装，在 GitHub 上已经有了各种流行编辑器的插件源代码，可根据说明安装。

4、对于 VS Core，对应的插件名是 EditorConfig for VS Code。

5、这里列举了 VS Code 支持的规则：

  • indent_style
  • indent_size
  • tab_width
  • end_of_line
  • insert_final_newline
  • trim_trailing_whitespace

# 四、写在最后

总体上来说，EditorConfig 的配置还比较简单，官网的文档也不难理解，使用起来，真心不错，值得推荐。