# editorconfig

editorconfig

# 概述

当多人共同开发一个项目的时候,往往会出现大家用不同编辑器的情况。就前端开发者来说,有人喜欢 Sublime,有人喜欢 Webstorm , 也有人喜欢 Atom,还有人喜欢 VimHBuilder 等等。各种不同编程语言的开发者喜欢各种不同的编辑器。 问题来了,如何让使用不同编辑器的开发者在共同开发一个项目时“无痛”地遵循编码规范?

先抛一个场景:

如果某开发者如果在同时开发两个项目,不幸的是,这两个项目的编码规范有冲突(比如,一个是缩进两个空格,另一个是缩进四个空格)怎么办?还有,如果该项目的某些编码规范编辑器设置不支持(比如,对 JS 文件要缩进两个空格;对 CSS 文件要缩进四个空格)怎么办?还有,不同编辑器设置各不相同等等。

我们可以粗暴的理解.editorconfig类似一份抹平各个不同浏览器下兼容性差异的reset.css文件。

# 安装

首先在根目录创建一份名为.editorconfig的文件,内容如下:

root = true #表明是最顶层的配置文件,发现设为true时,才会停止查找.editorconfig文件

[*] # 对所有文件生效
charset = utf-8
indent_style = space #tab为hard-tabs,space为soft-tabs
indent_size = 2 #设置整数表示规定每级缩进的列数和soft-tabs的宽度
end_of_line = lf #定义换行符,支持lf、cr和crlf
insert_final_newline = true #设为true表明使文件以一个空白行结尾,false反之
trim_trailing_whitespace = true #设为true表示会除去换行行首的任意空白字符,false反之

# 仅对后缀名为 md 的文件生效
[*.md]
trim_trailing_whitespace = false
1
2
3
4
5
6
7
8
9
10
11
12
13

TIP

安装与编辑器对应的 EditorConfig 插件。

当你在编码时,此插件会去查找当前编辑文件的所在文件夹或其上级文件夹中是否有 .editorconfig文件。如果有,则编辑器的行为会与 .editorconfig 文件中定义的一致,并且其优先级高于编辑器自身的设置

editorConfig for VsCode


# 资料

最近更新时间: 1/10/2020, 5:47:17 PM