EC

.editorconfig 生成

一份配置管住整个团队编辑器的缩进


                

如何使用本工具

  1. 选全局缩进风格与宽度,团队里用得最多的是 2 空格 + LF。
  2. 勾上 root = true,这样编辑器不会继续往上找别的项目配置。
  3. 按项目用到的语言勾覆盖规则:Markdown 必须关行尾空格清理,Makefile 必须用 tab。
  4. 右侧出完整 .editorconfig,下方列出语法问题和配置冲突。
  5. 下载后放到仓库根目录,大部分编辑器原生认,VS Code 需要装 EditorConfig 插件。

常见问题

Q:为什么 Markdown 要关掉 trim_trailing_whitespace?

A:因为两个行尾空格在 Markdown 里是硬换行语法。全局开了「删行尾空格」,写好的两行文字会被拼成一段。所以每个 Markdown 覆盖块都要写 `trim_trailing_whitespace = false`,这是 .editorconfig 最常见的覆盖场景。

Q:Makefile 为什么必须 tab?

A:make 只认真实的 Tab 字符(0x09),四个空格看起来一样但会报 missing separator。编辑器如果按全局规则把缩进转成空格,Makefile 立刻就不能用了。所以必须单独加 `[Makefile] indent_style = tab`。

Q:root = true 放子目录会怎样?

A:编辑器只认从文件所在目录往上找到的第一个带 root = true 的 .editorconfig。放在子目录里,只有该子目录及其下级生效,而且会截断更上层的配置——大多数情况下这不是你想要的。生成工具会在这种组合下给提示。

Q:花括号扩展名怎么写?

A:`[*.{js,ts,jsx,tsx}]` 匹配四种后缀;`[*{.lock,.sum}]` 匹配以 .lock 或 .sum 结尾的文件。花括号里不能有空格,逗号后面也不要加空格,否则匹配不到。

Q:tab_width 和 indent_size 有什么区别?

A:indent_size 是编辑器插入多少列的缩进,tab_width 是一个 Tab 字符显示成多宽。indent_style = tab 时必须显式写 tab_width,否则不同编辑器显示宽度不同,看着就对不齐。生成器会自动补这一行。

Q:CRLF 还是 LF?

A:跨平台项目一律 LF。Windows 的 Git 默认会在 checkout 时转 CRLF,但 Docker 容器和 Linux CI 里跑 shell 脚本时,CRLF 会让 `#!/bin/bash` 那行带上 `\r` 然后报 `bad interpreter`。真要在 Windows 上开发,用 .gitattributes 控制转换,别在 .editorconfig 里写 crlf。

Q:VS Code 装了插件还是不生效?

A:检查有没有装 Prettier 之类的格式化插件并设为默认格式化器——这类插件会覆盖 EditorConfig 的部分设置。另外 .editorconfig 只管保存时写进去的内容,已经存在的文件不会自动重写,需要手动格式化一次。