EditorConfig

(1 min to read)

介绍

帮助开发者定义一致的编码样式。不同的编辑器都可以读取和遵守该定义(VSCode需要安装插件)。

常用属性

  • indent_stylespace软缩进,tab硬缩进
  • indent_size:缩进大小
  • end_of_line:设置换行符,lf为换行,即*nix风格
  • charset:设置编码
  • trim_trailing_whitespace:去除末尾空白符
  • insert_final_newline:以空白行结尾
  • root:表示最顶层的配置文件。EditorConfig会不断向上层目录查找配置,遇到root会停止

模板

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
# EditorConfig helps developers define and maintain consistent
# coding styles between different editors or IDEs
# http://editorconfig.org
root = true

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

[*.py]
indent_size = 4

[*.md]
trim_trailing_whitespace = false