EditorConfig
说明
- EditorConfig有助于为跨越各种编辑器和IDE的同一项目的多个开发人员维护一致的编码样式。因为不同编辑器格式化代码的风格是不一样的,如果没有配置editorconfig,执行的就是编辑器默认的代码格式化规则;
- EditorConfig项目由用于定义编码样式的文件格式和一组文本编辑器插件组成,这些插件使编辑器能够读取文件格式并遵循定义的样式。
一、.editorconfig文件
创建:在项目根目录创建 .editorconfig
文件。
作用:在编辑器中打开文件时,EditorConfig 插件会在该文件目录以及父目录中查找 .editorconfig 文件。当我们编辑某一个文件时,编辑器会根据 .editorconfig 配置规则格式化该文件。
配置示例:
# 如果发现 root=true,则将停止搜索。
root = true
[*]
# 编码格式
charset = utf-8
# 缩进方式
indent_style = space
# 缩进大小
indent_size = 2
# 换行符类型 "lf" | "cr" | "crlf"
end_of_line = lf
# 是否让文件以空行结束
insert_final_newline = true
# 是否删除行尾空格
trim_trailing_whitespace = true
# 额外配置
[{src/**,vue.config.js}]
indent_size = 4
二、配置规则
语法
符号 | 匹配 |
---|---|
[] | 以下所有的匹配规则都必须写在 [] 里面 |
* | 匹配除路径分隔符(/)之外的任何字符串 |
** | 匹配任何字符串 |
? | 匹配任何单个字符 |
! | 匹配任何不在名称中的单个字符 |
{s1,s2,s3} | 匹配给定的任何字符串(以逗号分隔)(自EditorConfig Core 0.11.0起可用) |
{num1…num2} | 匹配num1和num2之间的任何整数,其中num1和num2可以是正数或负数 |
注意事项
{s1,s2,s3}
:,
前后不能有空格- 可以使用反斜杠转义特殊字符,这样它们就不会被解释为通配符模式