多编辑器代码风格一致性的小妙招

304 阅读1分钟

用途

在多编辑器中写代码或者多同事协作时,避免因为编辑器的不同在代码合并时带来多余烦恼,而且能保证代码整体上风格统一,方便进行review。

注:可配合Lint做更细致的约束。

官网

默认支持常用编辑器,配合插件,基本满足大部分编辑器 editorconfig.org/

常用示例

root=true

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

匹配规则

  • * 任何字符串,除了/
  • ** 任何字符串
  • ? 单个字符
  • [name] []中的任何字符
  • [!name] 非[]中的任何字符
  • {s1,s2,s3} 多个匹配字符串

常用配置

  • indent_style: (缩进样式)

    • tab
    • space
  • indent_size: (缩进字符数)

    • 数字
  • end_of_line:(换行符)

    • lf
    • cr
    • crlf
  • charset:(字符编码)

    • latin1
    • utf-8,
    • utf-8-bom
    • utf-16be
    • utf-16le
  • trim_trailing_whitespace:(是否去除换行符前的空白字符)

    • true
    • false
  • insert_final_newline(保存时是否在结尾插入一行):

    • true
    • false
  • root(是否是根目录,不是则继续查找父目录):

    • true
    • false
  • 其他配置项:

    github.com/editorconfi…