vscode使用editorconfig插件以及.editorconfig配置文件说明详解

通配符

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

控制指定文件类型的缩进大小

这里可以设置，如下：

[{*.json,*.yml}]
indent_style = space
indent_size = 2

对于.json .yml 文件，使用空格替代tab，并且一个tab会被替换为2个空格。

文件末尾新行

始终在文件末尾插入一个新行

[*]
end_of_line = lf
insert_final_newline = true

对于所有的文件

每一行的尾部自动调整为 Lf 文件的末尾是一个空行

实例

# 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扩展

在vscode里面安装EditorConfig

EditorConfig扩展的作用是读取第一步创建的editorconfig文件中定义的规则，并覆盖user/workspace settings中的对应配置（从这我们也可以看出vscode本身其实是并不直接支持editorconfig的）

全局安装或局部安装

editorconfig依赖包(npm install -g editorconfig | npm install -D editorconfig)
安装editorconfig依赖包主要是因为EditorConfig依赖于editorconfig包，不安装的可能会导致EditorConfig无法正常解析我们在第一步定义的editorconfig文件

使用

打开需要格式化的文件并手动格式化代码（shift+alt+f）

使用建议

配合代码检查工具使用，比如说：ESLint或TSLint，统一代码风格。

 2/3   首页 上一页 1 2 3 下一页 尾页