安装 Atom 插件 EditorConfig

统一代码风格的问题

当多人共同开发一个项目的时候,往往会出现大家用不同编辑器的情况。就前端开发者来说,有人喜欢 Sublime,有人喜欢 Webstorm , 也有人喜欢 Atom,还有人喜欢 Vim,HBuilder 等等。各种不同编程语言的开发者喜欢各种不同的编辑器。

问题来了,如何让使用不同编辑器的开发者在共同开发一个项目时“无痛”地遵循编码规范(编码风格)?

EditorConfig 能很好的“无痛”地解决上面问题。

EditorConfig介绍

EditorConfig 是一套用于统一代码工具的解决方案。

EditorConfig 可以帮助开发者在不同的编辑器和 IDE 之间定义和维护一致的代码风格。EditorConfig 包含一个用于定义代码格式的配置文件 .editorconfig 和一个编辑器插件 EditorConfig,这个插件可以让编辑器读取配置文件并依此格式化代码。

EditorConfig 工作原理

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

EditorConfig 的使用

使用 EditorConfig 来解决上面的问题。只需两步:

  1. 在项目根创建一个名为 .editorconfig 的文件,该文件的内容定义该项目的编码规范;
  2. 安装与编辑器对应的 EditorConfig 插件。

在windows下使用时,在要使用editorconfig的项目目录里创建 .editorconfig. 的文件,这样系统会自动命名为.editorconfig

配置信息比如:

# coding styles between different editors and IDEs
# editorconfig.org

root = true

[*]

# Change these settings to your own preference
indent_style = space
indent_size = 4

# We recommend you to keep these unchanged
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = false

[*.{js,html,blade.php,css,scss}]
indent_style = space
indent_size = 2

[*.md]
trim_trailing_whitespace = false

将 .editorconfig 加入到版本控制中

$ git add -A
$ git commit -m "Add .editorconfig"

你可能感兴趣的:(安装 Atom 插件 EditorConfig)