统一代码风格工具--editorConfig

未分类

前言

在团队开发中,同一的代码格式是必要的.但是不同开发人员的代码风格不同,代码编辑工具的默认格式也不相同,这样就造成代码的differ.而editorConfig可以帮助开发人员在不同的编辑器和IDE中定义和维护一致的编码风格.本文将详细介绍同一代码风格工具editorConfig

概述

• editorConfig 不是什么软件,而是一个名称为.editorConfig的自定义文件.该文件用来定义项目的编码规范,编辑器的行为会与.editorconfig 文件中定义的一致,并且其优先级比编辑器自身设置的要高,这在多人合作开发项目时十分有用而且有必要.
• 有些编辑器默认支持,如webstorm;而有些编辑器则需要安装editorConfig插件,如ATOM,Sublime,VS Code等.
• 当打开一个文件时,EditorConfig插件会在打开文件的目录和其每一级父目录查找.editorconfig 文件,知道有一个配置文件 root = ture
• EditorConfig 的配置文件时从上往下读取的并且最近的 EditorConfig 配置文件会最先读取.匹配 EditorConfig 配置文件中的配置项会按照读取顺序被应用,所以最近的配置文件中的配置项会拥有优先权
• 如果.editorconfig文件没有进行某些配置,则使用编辑器默认的配置

文件语法

• editorConfig 配置文件需要是 UTF-8字符集编码的,以回车换行或换行作为一行的分隔符
• 斜线(/)被用作为一个路径分割符,井号(#)或分号(;)被用作于注释.注释需要与注释符号写在同一行

通配符

属性
所有的属性和值都是忽略大小写的.解析时它们都是小写的

实例

下面的实例中使用 4 个空格来缩进,并不是说按一下空格会自动打出 4 个空格来,也不是说要连按 4 下空格;而是按 tab 键时,编辑器会自动输出 4 个空格的宽度,而不是之前默认的制表符(\t)

# editorconig.org
root = true
[*]
charset = utf-8
indent_size = 4
indent_style = space
insert_final_newline = true
trim_trailing_whitespace = true
[*.md]
trim_trailing_whitespace = false