editorconfig

EditorConfig 有助于跨不同编辑器和 IDE 为处理同一项目的多个开发人员维护一致的编码风格。EditorConfig 项目由用于定义编码样式的文件格式和一组文本编辑器插件组成,这些插件使编辑器能够读取文件格式并遵循已定义的样式。EditorConfig 文件易于阅读,并且可以很好地与版本控制系统一起工作。

Resource

资源 组织 类型
editorconfig editorconfig 文档

常见配置项

rules

  • root: 这个字段表示当前的 EditorConfig 文件是最顶层的配置文件,编辑器在读取配置时会从当前目录开始,向上查找 .editorconfig 文件,当遇到 root=true 时停止查找

  • [*]:这个字段表示以下的规则应用于所有文件。

  • end_of_line = lf:这个字段表示所有文件的行尾应该使用 LF (Line Feed,换行符) 结束。这是 Unix 系统的行尾字符。

  • indent_style = space:这个字段表示缩进应该使用空格。

  • indent_size = 2:这个字段表示缩进的大小应该是 2 个空格。

  • insert_final_newline = true:这个字段表示在文件的最后插入一个新行。

  • trim_trailing_whitespace = true:这个字段表示删除每行末尾的空白字符。

配置实例