VsCode EditorConfig 编码规则插件(适用大部分IDE/编辑器)

editorconfig (https://editorconfig.org) 定义一个代码格式配置文件覆盖IDE/编辑器上的代码规则。可以实现多人跨编辑器和IDE开发同一个项目时保持一致的编码风格。安排上EditorConfig后我们再也不用为tabWidth到底是2还是4好伤脑筋啦~

使用非常简单,先去插件市场搜索安装(以VSCode为例,其余):

再到自己项目根目录下新建一个.editorconfig,即用来定义 用户/项目 编码格式的文件。上面安装的EditorConfig插件(上面的EditorConfig for VS Code)使我们的编辑器可以读取.editorconfig并遵循定义的规则。
官方示例配置如下:

# EditorConfig is awesome: https://EditorConfig.org

# 当前目录最顶层的配置文件
root = true

# 设置所有的文件
# 始终在文件末尾插入一个 lf 换行符
[*]
end_of_line = lf
insert_final_newline = true

# 设置所有js/py格式的文件
# 文件字符集为utf-8
[*.{js,py}]
charset = utf-8

# 设置py类型的文件
# 缩进类型为space/软缩进,缩进字符列数为4
[*.py]
indent_style = space
indent_size = 4

# 设置Makefile文件
# 缩进类型为tab缩进(未指定大小)
[Makefile]
indent_style = tab

# 设置在lib目录下所有的JS
# 缩进类型为space/软缩进,缩进字符列数为2
[lib/**.js]
indent_style = space
indent_size = 2

# 设置确切文件 package.json/ 或 .travis/.yml
[{package.json,.travis.yml}]
indent_style = space
indent_size = 2

root: 特殊属性。可以决定这个. editorconfig的代码规范是覆盖用户还是当前项目工作区。只允许在.editorconfig最顶部指定。如果没有指定root = true, EditorConfig 将继续在该项目外部寻找. editorconfig,直到找到一个有root = true.editorconfig文件为止。

如果有多个. editorconfig,并且设置了相同的定义(文件名选择器和属性都一致),会以较近项目的. editorconfig中的属性值优先。

对于VSCode,支持的属性还有以下几个:
  • indent_style[tab|space] 缩进方式
  • indent_size[整数] 缩进列数,定义每个tab的宽度;当设置为'tab'时,将使用tab_width的值(如果定义了)。
  • tab_width[整数] 用于定义一个tab符的列数。默认值为indent_size的值,通常不需要指定。
  • end_of_line (on save):[lf|cr|crlf] 换行符
  • insert_final_newline (on save):[true|false] 若为 true 文件在保存时会以换行符结尾,false 则不以换行符结束
  • trim_trailing_whitespace (on save):[true|false] 若为 true 会删除换行符之前的所有空白字符。
匹配通配符

用于匹配文件名的[](类似选择器)中用来识别匹配的特殊字符

  • *:匹配任意字符串,路径分隔符(/)除外
  • **:匹配任意字符串
  • ?:匹配任意单个字符
  • [name]: 匹配name中的任意单个字符
  • [!name]: 匹配除name以外的任意单个字符
  • {s1,s2,s3}:匹配给定的任意一个字符串(以逗号分隔)(从EditorConfig Core 0.11.0开始可用)
  • {num1..num2}: 匹配num1和num2之间的任何整数,num1和num2可以是正数或负数
最后放一个我项目的常用配置
root = true

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

[*.md]
insert_final_newline = false
trim_trailing_whitespace = false
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,657评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,662评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,143评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,732评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,837评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,036评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,126评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,868评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,315评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,641评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,773评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,470评论 4 333
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,126评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,859评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,095评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,584评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,676评论 2 351

推荐阅读更多精彩内容

  •     当多人团队进行一个项目开发时,每个人可能喜欢的编辑器不同,有人喜欢Webstrom、有人喜欢sublime...
    百里战神阅读 2,033评论 0 0
  • 当多人团队进行一个项目开发时,每个人可能喜欢的编辑器不同,有人喜欢Webstrom、有人喜欢sublime、还有人...
    长城_changcheng阅读 22,184评论 1 23
  • 学完 NuxtJs 发现太好用了,完全不需要担心乱七八槽的配置,全部自己生成,很良心有没有♥。项目中一般 Reac...
    CondorHero阅读 2,053评论 0 2
  • # EditorConfig文件使用INI格式。斜杠(/)作为路径分隔符,#或者;作为注释。路径支持通配符: # ...
    余生社会阅读 709评论 0 0
  • 表达式编辑器 如第2.2节所述,启用表达式编辑器(expeditor)时,它允许用户编辑输入到系统中的表达式,并在...
    业翔阅读 892评论 0 1