editorconfig文件配置

什么是EditorConfig?

EditorConfig 有助于为跨各种编辑器和 IDE 处理同一项目的多个开发人员保持一致的编码风格。EditorConfig 项目包含用于定义编码样式的文件格式和一组文本编辑器插件,使编辑器能够读取文件格式并遵守定义的样式。EditorConfig 文件易于阅读,并且可以很好地与版本控制系统配合使用。 

参考官网:EditorConfig

下面贴出项目中的常规配置: 

# http://editorconfig.org

root = true

[*] # 表示所有文件适用
charset = utf-8 # 设置文件字符集为 utf-8
indent_style = space # 缩进风格(tab | space)
indent_size = 2 # 缩进大小
end_of_line = lf # 控制换行类型(lf | cr | crlf)
trim_trailing_whitespace = true # 去除行首的任意空白字符
insert_final_newline = true # 始终在文件末尾插入一个新行

[*.md] # 表示仅 md 文件适用以下规则
max_line_length = off
trim_trailing_whitespace = false

以vue项目为例,可以到vue官方仓库中去看看人家怎么写的,也是不错的借鉴方式。

其实大体是差不多的。 

vscode编辑器默认好像不支持.editorconfig,所以需要安装一个插件:

然后就会读取项目中相应的.editorconfig配置并执行代码规范了。

猜你喜欢

转载自blog.csdn.net/weixin_45719444/article/details/128434562
今日推荐