2019-12/editorconfig


项目内的 .editorcongfig文件

帮助开发人员在不同编辑器和ide之间定义和维护一致的编码样式 。
editorconfig项目由用于定义编码样式的文件格式和一组文本编译器插件组成,
这些插件使编辑器能够读取文件格式并遵循定义样式。editorconfig文件易于阅读并且版本控制系统配合使用。

不同的开发人员,不同的编辑器 有不同的编码风格,有不同的编码风格,而EditorConfig就是用来协同团队开发人员之间的代码的风格及样式规范化的一个工具,而.editorconfig正是它的默认配置文件。

* editorconfig为Python和JavaScript文件设置行尾和缩进样式的示例文件。

示例文件

# editorconfig.org
# 告诉插件这是跟文件 不用继续往上查找
root = true
# 匹配全部文件
[*]
# 定义编码
charset = utf-8
# 结尾换行符和 可以“lf”、“cr”、“crlf”
end_of_line = lf
# 在文件结尾插入新行
insert_final_newline = true
# 删除一行中的前后空格
trim_trailing_whitespace = true
indent_style = space
indent_size = 2
# 匹配py结尾的文件
[*.py]
# 缩进字数
indent_size = 4
# 缩进风格 可选“space”“tab”
# indent_style=space

注意事项

  1. 如果windows用户无法创建 .editorconfig文件则需要创建 editorconfig. 系统会自动重命名成 .editorconfig
  2. 插件安装
  3. 对应vscore 对应的插件名称EditorConfig for VS Code