.editorconfig

253 阅读2分钟

vscode需要安装扩展才能生效

很多编辑器捆绑了对EditorConfig的原生支持,但是部分编辑器类似 vscode 需要扩展名 EditorConfig for VS Code 效果图

image.png

通配符模式

用于通配符匹配的部分名称中识别的特殊字符:

*匹配任何字符串,路径分隔符 ( /)除外
**匹配任意字符串
?匹配任何单个字符
[name]匹配名称中的任何单个字符
[!name]匹配任何不在名称中的单个字符
{s1,s2,s3}匹配任何给定的字符串(用逗号分隔)(从 EditorConfig Core 0.11.0 开始可用
{num1..num2}匹配num1num2之间的任何整数,其中 num1 和 num2 可以是正数或负数

支持的属性

  • root: 应在文件顶部的任何部分之外指定的特殊属性。设置为true以停止.editorconfig对当前文件的文件搜索
  • charset: 设置为latin1utf-8utf-8-bomutf-16beutf-16le来控制字符集
  • indent_style: 设置为tabspace分别使用硬制表符或软制表符。
  • indent_size:(制表符长度)一个整数,定义用于每个缩进级别的列数和软制表符的宽度(如果支持)。当设置为"tab" tab_width 时,将使用(如果指定)的值。
  • tab_width: 一个整数,定义用于表示制表符的列数,默认值是取的indent_size的值。
  • end_of_line: 设置为"lf"、"cr"或"crlf"以控制换行符的表示方式。

如果文件使用 CRLF,您将在每行末尾看到字符串 ^M$,其中 ^M 表示回车,$ 表示换行。下面是一个示例:

    line one^M$
    line two^M$
    line three^M$

如果文件使用 LF,那么您只会看到美元符号:

    line one$
    line two$
    line three$
  • insert_final_newline: 设置为"true"以确保文件在保存时以换行符结尾,设置为"false"以确保它不会
  • trim_trailing_whitespace: 设置为"true"以删除换行符之前的任何空白字符,设置为"false"以确保不删除。

常用文件属性

# https://editorconfig.org
root = true

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

[*.md]
insert_final_newline = false
trim_trailing_whitespace = false

详细配置参考官网 EditorConfig