Skip to main content

editorconfig

Editorconfig 有助于跨各种编辑器和 IDE 为处理同一项目的多个开发人员维护一致的编码样式。

介绍​

Editorconfig 作为一个在编辑器和 IDE 之间协调代码风格的工具，它的作用不仅仅是让多人协同开发时代码风格一致，更重要的是让代码更加易读易懂。在项目开发中，代码风格的一致性可以提高代码的可维护性和可读性，从而节省时间和开发成本。

使用 ESLint 做代码 lint，那么为什么还要使用 .editorconfig 呢？​

  • ESLint 确实包含 .editorconfig 中的一些属性，如缩进等，但并不全部包含，如 .editorconfig 中的 insert_final_newline 属性 Eslint 就没有。Eslint 更偏向于对语法的提示，如定义了一个变量但是没有使用时应该给予提醒。而 .editorconfig 更偏向于代码风格，如缩进等。
  • ESLint 仅仅支持对 js 文件的校验，而 .editorconfig 不光可以检验 js 文件的代码风格，还可以对 .py（python 文件）、.md（markdown 文件）进行代码风格控制。

根据项目需要，Eslint 和 .editorconfig 并不冲突，同时配合使用可以使代码风格更加优雅。

安装 EditorConfig​

EditorConfig for VS Code

安装 EditorConfig 非常简单，只需要在编辑器或 IDE 中安装 EditorConfig 插件即可。创建 .editorconfig 文件也很简单，只需要在项目根目录下创建一个名为 .editorconfig 的文件，并在其中添加相应的配置项即可。在配置时，可以根据项目需要对不同类型的文件进行不同的配置，如示例中对 Markdown 文件的配置和其他文件的配置不同。创建 .editorconfig，示例内容如下

.editorconfig
# http://editorconfig.org

root = true

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

[*.md]
insert_final_newline = false
trim_trailing_whitespace = false

总结​

ESLint 和 .editorconfig 之间并不冲突，它们各自有自己的作用。ESLint 主要用于语法提示和代码规范检查，而 .editorconfig 则更加专注于代码风格的统一性和可读性。在项目开发中，同时使用 ESLint 和 .editorconfig 可以使代码更加优雅、易读易懂，提高代码的可维护性和可读性。