.editorconfig 生成器

选择项目类型预设,或逐项设置缩进方式、缩进宽度、换行符、字符编码、行尾空格、文件末尾空行和最大行宽,再为 Markdown、YAML、Makefile 等文件单独设置规则,生成 .editorconfig 文件,让团队里每个人的编辑器都按同样的风格保存代码。

EditorConfig 属性说明

属性作用
root = true写在文件顶部,表示到此为止,不再向上级目录查找 .editorconfig
indent_style缩进用空格 space 还是制表符 tab
indent_size缩进宽度;用 tab 时还可以设置 tab_width
end_of_line换行符:lf(Linux、macOS)、crlf(Windows)、cr
charset文件编码,一般为 utf-8
trim_trailing_whitespace保存时删除行尾空格;Markdown 中行尾两个空格表示换行,通常对 *.md 关闭
insert_final_newline文件末尾保留一个空行,让 Git 不出现“No newline at end of file”提示
max_line_length最大行宽,部分编辑器会显示参考线或自动换行
  • 匹配规则:[*] 匹配所有文件,[*.{js,ts}] 匹配多种扩展名,[Makefile] 匹配特定文件名,后面的规则会覆盖前面的。
  • 编辑器支持:JetBrains 系列(IDEA、WebStorm、PyCharm)、Visual Studio、Vim 9 等原生支持;VS Code 需要安装 EditorConfig for VS Code 扩展。
  • 与格式化工具配合:Prettier 会读取 .editorconfig 中的缩进、换行和行宽设置,两者配合可以避免规则冲突。
  • Makefile 必须用 tab:Makefile 的命令行必须以制表符开头,生成的配置会单独设置。

.editorconfig 生成器常见问题

.editorconfig 生成器怎么使用?

点选项目类型预设,在规则卡片中修改各项设置,第一条 [*] 为全局规则,后面的规则针对特定文件并覆盖全局;点“添加文件规则”可新增匹配,右侧实时生成文件,复制或下载后放到项目根目录。

.editorconfig 有什么用?

统一团队成员编辑器的缩进、换行符、编码等设置,避免因为编辑器不同造成代码风格混乱。

换行符选 LF 还是 CRLF?

跨平台项目推荐 LF,Windows 专用的 .NET 项目可以用 CRLF。

VS Code 支持 .editorconfig 吗?

需要安装 EditorConfig for VS Code 扩展,JetBrains 系列编辑器原生支持。

Markdown 为什么不删除行尾空格?

Markdown 中行尾两个空格表示换行,删除后会改变排版。

.editorconfig 生成器的结果应怎样理解?

只包含 EditorConfig 标准属性;不同编辑器对 max_line_length 等属性的支持程度不同。

输入内容会保存或发给外部服务吗?

所有内容只在浏览器本地生成,不会上传。

没有结果或操作失败时先检查什么?

VS Code 中设置不生效,需要安装 EditorConfig for VS Code 扩展;文件放在项目根目录且写了 root = true。

相关工具

正则查找替换 · 开发者快捷键速查表 · SQL 格式化 · YAML 格式化与校验 · 全部开发工具