editorconfig配置

editorconfig可以帮助开发人员在不同的编辑器和IDE中定义和维护一致的编码风格。

概述

是一个名称为.editorconfig的自定义文件。该文件用来定义项目的编码规范，编辑器的行为会与.editorconfig文件中定义的一致。

在windows平台上，右键选择“新建” => “文本文档” => “取名为.editorconfig”会报错如下图。

有两个方法创建以.开头的文件。
（1）新建文件时，在文件名最后再添加一个.，文件名部分输入.editorconfig就可以了。
（2）打开命令行，在命令行输入：echo hi > .editorconfig并执行即可。（这样创建的文件中有一个hi内容）

编辑器配置

总结了两个常用的编辑器，webstorm和sublime

（1）webstorm编辑器默认支持editorconfig
（2）sublime需要安装插件EditorConfig

在项目的根目录创建文件.editorconfig

语法

当打开一个文件时，EditorConfig插件会在打开文件的目录和其每一级父目录查找.editorconfig文件，直到有一个配置文件root = true。

文件需要时UTF-8字符集编码的，以回车换行或换行作为一行的分隔符。

通配符

通配符	意义
*	匹配除/之外的任意字符串
**	匹配任意字符串
?	匹配任意单个字符
[name]	匹配name字符
[!name]	匹配非name字符
{s1, s2, s3}	匹配任意给定的字符串

属性

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

indent_style    设置缩进风格(tab是硬缩进，space为软缩进)
indent_size     用一个整数定义的列数来设置缩进的宽度，如果indent_style为tab，则此属性默认为tab_width
tab_width       用一个整数来设置tab缩进的列数。默认是indent_size
end_of_line     设置换行符，值为lf、cr和crlf
charset         设置编码，值为latin1、utf-8、utf-8-bom、utf-16be和utf-16le，不建议使用utf-8-bom
trim_trailing_whitespace  设为true表示会去除换行行首的任意空白字符。
insert_final_newline      设为true表示使文件以一个空白行结尾
root        　　　表示是最顶层的配置文件，发现设为true时，才会停止查找.editorconfig文件

实例

下面实例中用tab来缩进

# editorconfig.org
root = true

[*]
indent_style = tab
indent_size = 4
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

[*.md]
trim_trailing_whitespace = false