EditorConfig介绍与安装

最新推荐文章于 2023-10-29 16:34:06 发布

biubiu640

最新推荐文章于 2023-10-29 16:34:06 发布

阅读量6.8k

点赞数

前言

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

概述

　　editorConfig不是什么软件，而是一个名称为.editorconfig的自定义文件。该文件用来定义项目的编码规范，编辑器的行为会与.editorconfig 文件中定义的一致，并且其优先级比编辑器自身的设置要高，这在多人合作开发项目时十分有用而且必要

　　Editorconfig项目由两部分组成，一个是.editorconfig 的文件格式（format）,一个是editorconfig 插件（plugin）编辑器默认支持editorConfig，如webstorm；而有些编辑器则需要安装editorConfig插件，如ATOM、Sublime、VS Code等

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

　　EditorConfig的配置文件是从上往下读取的并且最近的EditorConfig配置文件会被最先读取. 匹配EditorConfig配置文件中的配置项会按照读取顺序被应用, 所以最近的配置文件中的配置项拥有优先权

　　如果.editorconfig文件没有进行某些配置，则使用编辑器默认的设置

文件语法

　　editorConfig配置文件需要是UTF-8字符集编码的, 以回车换行或换行作为一行的分隔符

　　斜线(/)被用作为一个路径分隔符，井号(#)或分号(;)被用作于注释. 注释需要与注释符号写在同一行

【通配符】

*                匹配除/之外的任意字符串
**               匹配任意字符串
?                匹配任意单个字符
[name]           匹配name中的任意一个单一字符
[!name]          匹配不存在name中的任意一个单一字符
{s1,s2,s3}       匹配给定的字符串中的任意一个(用逗号分隔) 
{num1..num2}   　匹配num1到num2之间的任意一个整数, 这里的num1和num2可以为正整数也可以为负整数

【属性】

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

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文件

实例

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

# editorconfig.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

EditorConfig 的插件

目前主流的编辑器或者 IDE 基本上都有对应的 EditorConfig 插件，有的是内置支持的，有的需要独立安装。需要注意的是，不用的插件对 EditorConfig 属性的支持度不一样，后面具体介绍每个 IDE 的插件时可以关注下。下图所示的编辑器或者 IDE 已经内置了 EditorConfig 的插件，因此无需独立安装配置，直接使用即可，可以看到 WebStorm 不需要独立安装 EditorConfig 的插件。

image_1aluh83v0u7ftut41rf2j1q4e9.png-178.5kB

下图所示的编辑器或者 IDE 目前尚未内置对 EditorConfig 的支持，因此如果要使用 EditorConfig 的功能的话需要首先下载插件。上篇文章中介绍的 Atom，Sublime Text 3，Visual Studio Code 都需要安装插件，Deco 也没有内置对 EditorConfig 的支持，但目前也没找到对应的插件，也就是说 Deco 不支持 EditorConfig 的使用，毕竟它才是一个新生儿。