EditorConfig是干嘛的?

作者: 北辰_狼月 | 来源:发表于2019-11-15 00:44 被阅读0次

    我们在项目中,经常会看到一个文件,它叫做.editorconfig,那么,它究竟是干嘛的呢?

    先设想一个场景,一个大型项目,可能有很多位同事一起工作,而由于习惯的不同,导致他们用的编辑器五花八门,有vscode,有webstorm,有sublime,等等,它们默认的格式化设置是不同的,有的是2格缩进,有的则是4格。规则的不同,导致代码风格的差异,这样就会给后期的运维工作带来不可预料的风险。so bad!

    timg (6).jpeg

    所以,EditorConfig就是来做这件事的工具,它的作用就是

    帮助跨不同的编辑器和ide为多个开发人员维护一致的编码风格

    ok,这样我们就知道那个.editorconfig是干嘛的,那么接下来,就是它怎么使用的呢?

    配置EditorConfig

    1. 安装插件

    每个编辑器都有相应的插件,这里以vscode为例,vscode要安装的插件如下


    editorconfig.png

    2. 配置.editorconfig文件

    以下是一份简单的配置文件的例子

    
    # 是否是顶级配置文件,设置为true的时候才会停止搜索.editorconfig文件
    root = true
    
    [*]
    # 文件编码格式,一般为utf-8
    charset = utf-8
    # 缩进类型
    indent_style = space
    # 缩进数量
    indent_size = 2
    # 换行符类型格式,一般用lf
    end_of_line = lf
    # 末尾行后加多一行空行
    insert_final_newline = true
    

    以上,就是你要做的事,so easy!那么就去做吧

    相关文章

      网友评论

        本文标题:EditorConfig是干嘛的?

        本文链接:https://www.haomeiwen.com/subject/bnodictx.html