EditorConfig

EditorConfig

话题相关词汇:EditorConfig统一代码风格规范文件
1 篇话题相关文章,更新时间:

什么是 EditorConfig ?

EditorConfig 文件用于约定和规范代码风格。

.editorconfig 隐藏配置文件存在于项目根目录。

EditorConfig 是跨各种代码编辑器和 IDE (集成开发环境)的,它不依赖于任何特定的语言、框架或代码编辑器,目的是让同一个项目的多个开发人员可以保持统一的代码风格,比如缩进方式和缩进大小、文件编码格式、文件默认末尾一个换行符等。

EditorConfig 本身是一个与编程语言、编辑器无关的配置文件,它依赖代码编辑器或 IDE 的第三方工具或插件来实现对文件中声明的规则的支持,读取解析配置后达到约定代码风格的目的。

示例文件

以下 .editorconfig 文件是为 Python 和 JavaScript 文件设置行尾和缩进样式的示例文件。

# top-most EditorConfig file
root = true

# Unix-style newlines with a newline ending every file
[*]
end_of_line = lf
insert_final_newline = true

# Matches multiple files with brace expansion notation
# Set default charset
[*.{js,py}]
charset = utf-8

# 4 space indentation
[*.py]
indent_style = space
indent_size = 4

# Tab indentation (no size specified)
[Makefile]
indent_style = tab

# Indentation override for all JS under lib directory
[lib/**.js]
indent_style = space
indent_size = 2

# Matches the exact files either package.json or .travis.yml
[{package.json,.travis.yml}]
indent_style = space
indent_size = 2

.editorconfig 文件存放位置

当打开一个文件时,EditorConfig插件会在打开文件的目录和每个父目录中寻找一个名为.editorconfig的文件。如果达到了根文件路径或找到了root=true的EditorConfig文件,对.editorconfig文件的搜索将停止。

EditorConfig文件是从上到下阅读的,最新发现的规则优先考虑。匹配的EditorConfig部分的属性会按照它们被读取的顺序应用,所以较近的文件中的属性会被优先考虑。

对于Windows用户。要在Windows Explorer中创建一个.editorconfig文件,你需要创建一个名为.editorconfig的文件(注意后面的点),Windows Explorer会自动为你重命名为.editorconfig。

EditorConfig 使用方法

  1. 在年及其插件安装的地方搜索 EditorConfig,安装 EditorConfig 插件;
  2. 打开插件帮助文档,按步骤编辑 EditorConfig 配置文件即可;
  3. 可能需要重新打开编辑器。

几乎所有现代编辑器都支持 EditorConfig!

参考资料:https://editorconfig.org/