editorConfig编辑器配置

系统管理员 2024-02-19 12:23 84阅读 0赞

当多人团队进行一个项目开发时，每个人可能喜欢的编辑器不同，有人喜欢Webstrom、有人喜欢sublime、还有人喜欢Hbuilder。这个时候，问题便迎面而来，如何帮助开发人员在不同的编辑器和IDE中定义和维护一致的编码风格呢？

那就是使用editorConfig，在这里配置的代码规范规则优先级高于编辑器默认的代码格式化规则。比如我使用的是Webstrom编辑器，我每一次写完代码之后，都习惯性的按下“Ctrl+Alt+L”快捷键去整理代码格式。如果我没有配置editorconfig，执行的就是编辑器默认的代码格式化规则；如果我已经配置了editorConfig，则按照我设置的规则来，从而忽略浏览器的设置。

目前主流的编辑器或者 IDE 基本上都有对应的 EditorConfig 插件，有的是内置支持的，有的需要独立安装（webstrom是内置安装滴）。

下面说说它的常用配置：

【通配符】
    
    *                匹配除/之外的任意字符串
    **               匹配任意字符串
    ?                匹配任意单个字符
    [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文件

使用方法：在项目根目录下，新建.editorconfig文件，配置规范，如下图所示：

![70][]

[70]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/29/868358548cdd49cd9e350b14199a451d.png