项目根目录下的.editorconfig文件+Idea CodeStyle样式设置

超、凢脫俗 2021-06-10 20:40 398阅读 0赞

## 一、.editorconfig文件是什么？ ##

在项目里，大多时候都能看到.editorconfig文件，刚开始总是忽视掉它，认为它不太重要。但是，它的存在，必定有它的理由，于是，抽空来研究一下，它是什么，能做什么。

[官网][Link 1]是这么介绍EditorConfig的，“EditorConfig帮助开发人员在不同的编辑器和IDE之间定义和维护一致的编码样式。EditorConfig项目由用于定义编码样式**的文件格式**和一组**文本编辑器插件组成**，这些**插件**使编辑器能够读取文件格式并遵循定义的样式。EditorConfig文件易于阅读，并且与版本控制系统配合使用。”

不同的开发人员，不同的编辑器，有不同的编码风格，而EditorConfig就是用来协同团队开发人员之间的代码的风格及样式规范化的一个工具，而.editorconfig正是它的默认配置文件。

## 二、示例文件 ##

# 告诉EditorConfig插件，这是根文件，不用继续往上查找
    root = true
    
    # 匹配全部文件
    [*]
    # 结尾换行符，可选"lf"、"cr"、"crlf"
    end_of_line = lf
    # 在文件结尾插入新行
    insert_final_newline = true
    # 删除一行中的前后空格
    trim_trailing_whitespace = true
    # 匹配js和py结尾的文件
    [*.{js,py}]
    # 设置字符集
    charset = utf-8
    
    # 匹配py结尾的文件
    [*.py]
    # 缩进风格，可选"space"、"tab"
    indent_style = space
    # 缩进的空格数
    indent_size = 4
    
    # 以下匹配，类同
    [Makefile]
    indent_style = tab
    # tab的宽度
    tab_width = 4
    
    # 以下匹配，类同
    [lib/**.js]
    indent_style = space
    indent_size = 2
    
    [{package.json,.travis.yml}]
    indent_style = space
    indent_size = 2

## 三、注意事项、配置说明 ##

1、如果是windows用户，如果无法创建.editorconfig文件，则需要先创建.editorconfig.文件，系统会自动重命名成.editorconfig文件。

2、EditorConfig的匹配规则是从上往下，即先定义的规则优先级比后定义的优先级要高。

3、插件安装，在GitHub上已经有了各种流行编辑器的[插件源代码][Link 2]，可根据说明安装。

4、对于VS Core，对应的插件名是[EditorConfig for VS Code][]。

5、这里列举了[VS Code支持的规则][VS Code]：

*  `indent_style`
 *  `indent_size`
 *  `tab_width`
 *  `end_of_line`
 *  `insert_final_newline`
 *  `trim_trailing_whitespace`

`-----------------------------------------------------------------------------------------------------------------------------------------------------`

Idea + editorConfig 样式设置问题：[https://www.jianshu.com/p/be41e701f6bd][https_www.jianshu.com_p_be41e701f6bd]

# 背景 #

前段时间 copy 了一个手脚架项目，然后用 idea 进行编码。结果发现一个很歧异的现象，IDEA 设置了换行符为 crlf，但是不生效。甚至我直接改了页面上的换行符为 CRLF ，但是只要我一改代码保存后，换行符就立刻变回 LF。  
在此之前先讲讲基本的 IDEA 设置换行符：

1.  setting->Code style 设置所有文件。
    
    ![42d2f8bb57fac70a0d4be475feaa27f3.png][]
    
     
2.  设置单个文件换行符。
    
    ![174421026f2819a533d201e65b76b638.png][]

但是困难在于，上面那两种方法都无法解决我的问题。

# 问题分析与解决 #

最终找了好久，发现忽略了项目中的 .editorconfig 文件，才发现原来 .editorconfig 是可以设置换行符的。并且会覆盖了 idea 的设置。因为 .editorconfig 本身就是用于帮助开发人员在不同 IDE 下维护一样的样式格式。.editorconfig 控制换行符的方法：

[*]
    end_of_line = crlf
    
    # [] 这个 section 可以指定所有文件，也可以某个后缀([*.json])，当然也可以指定某个文件([pom.xml])

# 总结 #

所以综上，修改换行符，除了 IDE 的设置，也可以用 .editorconfig 来设置的。

[Link 1]: https://editorconfig.org/
[Link 2]: https://github.com/editorconfig/
[EditorConfig for VS Code]: https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig
[VS Code]: https://github.com/editorconfig/editorconfig-vscode
[https_www.jianshu.com_p_be41e701f6bd]: https://www.jianshu.com/p/be41e701f6bd
[42d2f8bb57fac70a0d4be475feaa27f3.png]: /images/20210527/a13d81d7d4ff48bbbad2047a129424fb.png
[174421026f2819a533d201e65b76b638.png]: /images/20210527/328beb7a688a4a838f9ef42e662f549f.png