首发于极光日报
为什么应该在你的项目中使用 EditorConfig

为什么应该在你的项目中使用 EditorConfig

简评:对于我自己来说,既有 PC 也有 Mac,并且都会有编程的需求,也会用到多种 IDE,EditorConfig 确实帮我摆脱了重复设置代码规范这件麻烦事。

现在已经 2017 年了,但还是有很多人陷入在 tabs vs spaces 之类的争论中。不是每个人都在严格要求自己的代码规范和风格,对于多人协作的项目这容易出现问题,毕竟每个人所用的 IDE 和编辑器都可能不同。

这里就要介绍下 EditorConfig 了,你只需配置一个 .editorconfig 文件,在其中设置好要遵守的代码规范,放在项目的根目录下,就能够在几乎所有的主流 IDE 和编辑器中复用了,可以将 .editorconfig 文件也提交到版本控制系统中,就不需要针对不同 IDE 和编辑器再单独进行设置了。

目前无需插件直接支持的有:

需要额外安装插件的有:

插件列表:EditorConfig Download a Plugin

语法也很简单,这是一个简单的例子:

# indicate this is the root of the project
root = true

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

[*.html]
indent_size = 4
max_line_length = 80

[*.md]
trim_trailing_whitespace = false

目前支持的属性:EditorConfig-Properties

当然如果你使用的工具不在以上的话,可以自己开发一个插件,官方也有相应的教程:

github.com/editorconfig

官方网站:EditorConfig
目前在使用 EditorConfig 的项目已经有包括 jQuery, LibreOffice, Node.js, Ionic 等在内的数十个知名项目。

具体项目列表可以看看:editorconfig/projects
原文:Why you should be using an EditorConfig file in your project

扩展阅读:


欢迎关注:知乎专栏「极光日报」,每天为 Makers 导读三篇优质英文文章。

编辑于 2017-03-22 00:26