VS Code 插件 EditorConfig for VS Code

背景:在一次项目开发中,我和同事使用的都是 VS Code 编辑器,但同事的缩进是4个空格,而我的编辑器缩进是2个空格。尽管我已经对 VS Code 编辑器进行了如下设置:

虽然我对 VS Code 编辑器进行了如上图一样的设置,依然没有改变两个空格的缩进。这样产生的后果就是每个人修改后的代码在格式上总是不统一的,那么提交到 git 上就会代码风格不一致,变得非常丑陋。

我是一个有着代码强迫症的人,因此我决定要彻底解决这个让人难受的问题,经过两个小时的研究后,最终将问题锁定在 VS Code 插件:EditorConfig for VS Code。

本篇文章主要介绍 VS Code 插件:EditorConfig for VS Code

EditorConfig for VS Code

作用:

当大家在协同工作时,不可能永远是一个人维护一个项目,当多个人参与一个项目,每个人使用的编辑器不一样,代码风格自然也不一样,那么如何让使用不同编辑器的开发者能够轻松惬意的遵守最基本的代码规范呢?

而 EditorConfig 正好可以解决这个问题,在这里配置的代码规范规则优先级高于编辑器默认的代码格式化规则。如果没有配置 editorConfig,在格式化时将会执行编辑器默认的代码格式化规则;如果配置了editorConfig,则按照 editorConfig 中的配置来格式化代码,从而忽略编辑器默认的代码格式化规则。

EditorConfig 包含一个用于定义代码格式的文件和一批编辑器插件,这些插件是让编辑器读取配置文件并以此来格式化代码。

安装:

步骤一:在 VS Code 编辑器插件扩展中查找 EditorConfig for VS Code 并安装

步骤二:在项目根目录中创建 .editorconfig 文件(如果已经存在,则不用创建,可直接进行配置),并进行配置,配置选项参考 Supported Properties 或者参考:complete list of properties.

步骤三:配置 .editorconfig 文件时的格式参考文件:Example file

步骤四:以下是我的项目根目录中 .editorconfig  文件中的配置

注意:如果要在项目根目录中 .editorconfig 文件中的配置生效,一定要在 VS Code 编辑器中安装 EditorConfig for VS Code 插件,否则 .editorconfig 文件中的配置不生效。

 EditorConfig for VS Code 与 ESLintTSLint 的比较:

这时候你或许有些疑惑,因为 EditorConfig for VS Code 的作用是在团队开发中保持代码规范使得代码风格一致,而 ESLint 或 TSLint 也是在团队开发中保持代码规范,使得代码风格一直,它们之间在功能上是不是有些重复,在一个项目中同时拥有这些是不是有些冗余。我对这个问题的简单理解是这样的:

EditorConfig for VS Code 这个插件只能简单的配置一些规范,并不能完全满足代码规范的需求,所以还需要其它代码检查工具配合使用,比如说:ESLint或StyleLint,统一代码风格。





参考网址:

EditorConfig:https://editorconfig.org/

https://www.jianshu.com/p/fac7dde906cc

https://www.cnblogs.com/jiaoshou/p/11252055.html

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