通过EditorConfig统一团队的代码风格

作者：梁枫

团队代码风格问题

团队没有统一的风格约定, 经常会出现一个文件由于多个人维护, 导致缩进风格不统一, 一会是tab, 一会是空格, 代码逼格直接low爆了.

想要统一风格, 必须要有一个强制的约定, 但是这个约定很多时候不容易推进, 因为大家用的编辑器或IDE不同, 这个时候就需要引入工具协助开发人员执行代码风格约定.

什么是EditorConfig?

EditorConfig是一个跨编辑器和IDE的工具, 帮助开发者保持一致的代码风格.它由一种代码风格定义文件和多个编辑器及IDE(支持主流编辑器及IDE)的插件构成. 它可以将代码风格定义应用于编辑器及IDE.

EditorConfig实例

EditorConfig的配置是被放到一个名为.editorconfig的文件中的

Windows用户如果创建不了该文件, 可以在文件夹中创建名为.editorconfig.的文件, Windows会自动的将文件命名为.editorconfig

root = true

[*.{js,css}]
charset = utf-8
indent_style = tab
indent_size = 2
trim_trailing_whitespace = true

[package.json]
indent_style = space
indent_size = 2

还有哪些不足

个人觉得配置项还不够, 缺少以下配置

1. 空格
2. 换行
3. 折行

虽然这些内容是代码格式化的范畴了, 但是代码格式化缺少跨编辑器和IDE的配置工具

结语

EditorConfig的配置项虽然比较简洁, 但不妨碍它帮助团队统一代码风格, 至少能统一一下缩进.

网易云大礼包：https://www.163yun.com/gift

本文来自网易实践者社区，经作者梁枫授权发布