用好EditorConfig

原创 shuyaqian 随笔 前端 243阅读 2017-06-10 15:54:00 举报

源代码漂亮的程序员不一定是好程序员,但反过来就一定不是!
怎样让使用不同编辑器的开发者在共同开发一个项目时“无痛”地遵循编码规范(编码风格)?

1.在项目根创建一个名为 .editorconfig 的文件。该文件的内容定义该项目的编码规范。EditorConfig 支持的编码规范在后文会有详细的介绍。
2.安装与编辑器对应的 EditorConfig 插件。

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

EditorConfig 支持的常用的编码规范,如下:
charset:文件编码。可选值

  • latin1
  • utf-8。一般用这个。
  • utf-16be
  • utf-16le
    indent_style: 缩进类型。可选值
  • space
  • tab
    indent_size: 缩进数量。可选值
  • 整数。一般设置 2 或 4。
  • tab
    insert_final_newline:是否在文件的最后插入一个空行。可选值
  • true
  • false
    end_of_line:换行符格式。说明见Wiki:换行。可选值
  • lf。一般用这个。
  • crlf
  • cr
    trim_trailing_whitespace:是否删除行尾的空格。可选值
  • true
  • false

附上我常用的code,麻麻再也不用担心我常换IDE了!**javascript 代码**

评论 ( 0 )
最新评论
暂无评论

赶紧努力消灭 0 回复