editorconfig文件的使用

最新推荐文章于 2025-06-21 07:25:03 发布

无名的高山

最新推荐文章于 2025-06-21 07:25:03 发布

阅读量3.2k

点赞数 4

CC 4.0 BY-SA版权

文章标签： editorconfig 代码规范

本文链接：https://blog.youkuaiyun.com/gstianfu/article/details/81410223

EditorConfig是一种跨编辑器的配置文件，支持多种编辑器及IDE，有助于实现代码风格的一致性。它支持递归查找上级目录，允许特定于文件类型的配置，并且仅涉及通用代码样式。这种配置方式方便团队和个人使用。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

.editorconfig是一种通用的编辑器（或者IDE）配置文件，几乎全部的主流编辑器都內建了或者通过插件完成了对.editorconfig文件的解析和支持。

下面会具体的说明我们采用.editorconfig的作为通用配置的一些原因，以及.editorconfig一些比较有意义的特性。这些特性不仅仅对于个人开发有意义，在一个团队或者组织内部，使用公共的.editorconfig文件，也可以以极低的成本带来非常好的整体代码一致性。

首先就是上面已经提到的.editorconfig对于编辑器或者IDE的通用性。这就可以让使用不同编辑器和不同开发语言的开发人员，无论是Emacs还是Vim，无论是Python还是Javascript，都可以遵循相同的配置文件的来规范代码的一些基本的样式。甚至如果需要修改一些自己不经常维护的代码（不在自己的日常职责之内），比如后端工程师修改一些前端的代码（也许后端工程师会用一个自己常用的编辑器来修改，但这个编辑器很可能不是前端的常用的），都可以通过.editorconfig规范基本的样式。哪怕是只有自己一个人在用的时候，可以可以统一自己的不同的编辑器或者IDE的基础样式。

第二个要说到的是.editorconfig的向上级目录递归上溯的特性。使用支持的编辑器打开文件后，编辑器会首先在当前目录下寻找.editorconfig文件，然后递归的逐级上溯寻找每一层上级目录的.editorconfig文件，知道达到根目录或者带有root=true属性的文件为止。对于所有找到的这些文件来说，任何一个属性，都是以最先找到的.editorconfig中的对应属性为准，也就是说下级目录的属性会覆盖上级目录的相同属性的设定。比如所，如果我们有一个全部代码的根目录~/code/，可以把.editorconfig文件就放在这个目录下，那么~/code/下的任何目录，类似~/code/super-awesome-scroller/, ~/code/backend/middleware/queue/等等，都可以这个配置文件作为统一的基础配置。同时，因为下级目录中的.editorconfig可以覆盖上级目录中的相同属性，我们也可以把团队的配置文件作为基础配置，在一个个性化的项目中，可以在这个基础上，再定义专门用于这个项目的代码样式。

第三个是.editorconfig基于文件类型的筛选机制，每一种配置都可以针对文件类型来具体配置。这样在设定给团队的的不同的开发岗位的的统一基础代码样式，并且对每一种语言都进行针对性的配置，避免不同的开发语言之间的配置的冲突。

第四个是.editorconfig仅配置一些通用的代码样式，比如每一行的末尾是LF还是CRLF（这个属性就非常有用，可以用来统一分别在Windows和*nix操作系统上编辑的代码）。这样可以尽可能减少对的具体的语言的干预，针对每一种语言，我们仍然可以去设定具体的样式，比如加不加分号等等。一个可以通用的标准，一定是一个兼容性强，只规定最基本的属性的标准。这样也可以让.editorconfig更加的通用。

从第三点和第四点来说，.editorconfig是一个比较容易的做到一个团队，一个统一的基础代码样式文件的代码样式配置机制。这样的配置文件不仅仅可以辅助个人的开发，也可以作为技术团队一个整体的基础标准。

最后，补充几种常用编辑器中，editorconfig的配置方法：

Emacs

emacs对于editorconfig的支持需要安装一个插件，https://github.com/editorconfig/editorconfig-emacs，可以从release中下载一个版本出来，然后加压到比如~/.emacs.d/editorconfig-emacs/中，那么可以在.emacs配置文件中加入

(add-to-list 'load-path "~/.emacs.d/editorconfig-emacs")

(require 'editorconfig)

(editorconfig-mode 1)

注意这个插件需要依赖editorconfig core，如果在Windows中，可以通过chocolatey安装：

choco install editorconfig.core