EditorConfig

作者：: truesnow
发布于：: 1年前
收录于：: 工具使用
: 613 0

摘要：# 什么是 EditorConfig？ EditorConfig 帮助开发者定义和维护不同编辑器和 IDE 下一致的编码风格。EditorConfig 项目由一个定义编码风格的 **格式文件** 和一系列使编辑器能读取并应用已定义样式的 **编辑器插件**...

# 什么是 EditorConfig？

EditorConfig 帮助开发者定义和维护不同编辑器和 IDE 下一致的编码风格。EditorConfig 项目由一个定义编码风格的 **格式文件** 和一系列使编辑器能读取并应用已定义样式的 **编辑器插件** 组成。EditorConfig 文件简单易读，并且能与版本控制系统很好地工作。

# 示例文件

以下是 *.editorconfig* 文件设置 Python 和 JavaScript 文件行尾和缩进样式的示例：

```
# EditorConfig 很赞: https://EditorConfig.org

# 大部分 EditorConfig 文件的开头
root = true

#  Unix 样式的换行符，每个文件都有换行符 
[*]
end_of_line = lf
insert_final_newline = true

# 使用大括号 {} 匹配多种文件
# 设置默认字符集
[*.{js,py}]
charset = utf-8

# 缩进为 4 个空格
[*.py]
indent_style = space
indent_size = 4

# Tab 缩进（未指定数量）
[Makefile]
indent_style = tab

# 覆盖 lib 目录下所有 JS 文件的缩进
[lib/**.js]
indent_style = space
indent_size = 2

# 精确匹配 package.json 或 .travis.yml 文件
[{package.json,.travis.yml}]
indent_style = space
indent_size = 2
```

你可以参考 [正在使用 EditorConfig 文件的项目](https://github.com/editorconfig/editorconfig/wiki/Projects-Using-EditorConfig )。

# 文件位置

当打开一个文件时，EditorConfig 插件会查找当前打开文件目录以及父级目录下名为 *.editorconfig* 的文件。当直到查找到 root 文件根目录或一个包含 `root=true` 的 EditorConfig 文件时则停止查找。

EditorConfig 文件从上到下读取，且先找到的规则优先。匹配到的 EditorConfig 中的属性按读取顺序应用，所以离文件越近的属性优先。

**Windows 用户**：要在 Windows 资源管理器中创建一个 *.editorconfig* 文件，你需要创建一个名为 *.editorconfig.* 文件，Windows 将自动重命名为 *.editorconfig*。

# 文件格式详解

EditorConfig 文件使用 INI 格式，和 [Python ConfigParser 库](https://docs.python.org/2/library/configparser.html  ) 使用的格式是兼容的，但是 `[` 和 `]` 在模块名称中是允许的。模块名称是文件路径 [glob](https://en.wikipedia.org/wiki/Glob_(programming) )，与 [.gitignore](https://git-scm.com/docs/gitignore#_pattern_format ) 允许的格式类似。只有斜杠 `/` 是用作目录分隔符以及井号 `#` 或分号 `;` 用于注释。注释应自成一行。EditorConfig 文件应该使用 UTF-8 编码，使用 `CRLF`（Carriage Return Line Feed） 或 `LF`（Line Feed）分隔符。EditorConfig 文件从上到下读取，并且最近的规则优先。

文件路径 glob 模式和当前支持的 EditorConfig 属性解释如下。

## 通配符模式

模块名称中用于通配符匹配的特殊字符：

| 特殊字符 | 解释 |
| --- | --- |
| * | 匹配任意字符型字符串，除了路径分隔符 `/` 
| ** | 匹配任意字符型字符串 | 
| ? | 匹配任意单个字符 |
| [name] | 匹配包含 name 的任意字符 |
| [!name] | 匹配不包含 name 的任意字符 |
| {s1,s2,s3} | 匹配给定字符串的任意一个（逗号分隔）（**EditorConfig 核心 0.11.0 后可用**） |
| {num1..num2} | 匹配在 num1 和 num2 中的任意整型数字，其中 num1 和 num2 可以是正数，也可以是负数 |

特殊字符可以通过反斜杠 `\` 来转义以避免被解析为通配符。

## 支持的属性

注意不是每个插件都支持所有属性。详见 [完整属性列表](https://github.com/editorconfig/editorconfig/wiki/EditorConfig-Properties ) wiki。

**`ident_style`**：缩进样式，设置为 `tab` 或 `space`。

**`indent_size`**：定义缩进的列数的数值。当设置为 `tab` 时，则使用 `tab_width`（如果指定了）的值。

**`tab_width`**：定义 tab 字符的列数的数值。默认等于 `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` 来停止对当前文件查找 *.editorconfig* 文件。

目前所有属性和值都是大小写敏感的。解析时会转换为小写。通常，如果一个属性没有指定，则使用编辑器设置，也就是说，EditorConfig 不影响其他部分。对于任意属性，值 `unset` 用于移除属性的效果，即使之前设置了值。例如，添加 `ident_size = unset` 来取消 `indent_size` 属性的定义（并且使用编辑器默认属性）。

不指定特定 EditorConfig 属性是可以接受的，而且通常是优先的。例如，`tab_width` 不需要指定，除非其值与 `indent_size` 不同。而且，当 `indent_style` 设置为 `tab` 时，不设置 `indet_size` 的值通常是更合人意的，这样读者就可以用他们更喜欢的缩进宽度来浏览文件。另外，如果在你的项目中某个属性没有标准化（例如 `end_of_line`），则最好不设置。

# 不需要插件的编辑器

以下编辑器自带 EditorConfig 的原生支持。一切都能正常运行。
![](http://pb8quxvbv.bkt.clouddn.com/images/articles/201809/Qa8LcP6Fno2VNWOtQ8ye00gkeCvotxHB.png)

# 需要下载插件的编辑器
要在以下编辑器中使用 EditorConfig，你需要安装一个插件。

![](http://pb8quxvbv.bkt.clouddn.com/images/articles/201809/PL6oaYmKo97CEM3UWioyjWTdxBsJLED7.png)

# 参考

- [edirotconfig.org](https://editorconfig.org/  )
- [editorconfig | Github](https://github.com/editorconfig/ )
- [正在使用 EditorConfig 文件的项目](https://github.com/editorconfig/editorconfig/wiki/Projects-Using-EditorConfig )
- [Python ConfigParser Library](https://docs.python.org/2/library/configparser.html )
- glob：https://en.wikipedia.org/wiki/Glob_(programming) 
- [.gitignore](https://git-scm.com/docs/gitignore#_pattern_format )
- [完整属性列表](https://github.com/editorconfig/editorconfig/wiki/EditorConfig-Properties )

文章目录

EditorConfig

所有评论（0）