.editorconfig 生成器

跨 IDE 统一代码规范,终结“空格还是制表符”的团队争论

配置编辑器
快速预设:
规则列表

暂无规则,请点击下方按钮添加

.editorconfig 预览
# 配置文件预览将显示在此...

EditorConfig:终结编码风格的“宗教战争”

面临的挑战

在一个团队中,每个开发者都有自己偏好的编辑器(VS Code, WebStorm, Vim)和配置习惯。有人喜欢 2 空格缩进,有人喜欢 4 空格,还有人坚持使用 Tab。当这些代码混合提交到 Git 时,会产生大量的格式冲突,让代码审查(Code Review)变成一场噩梦。

我们的解决方案

EditorConfig 提供了一种极其简单且强大的方式来统一规范。通过在项目根目录放置一个 .editorconfig 文件,无论开发者使用什么 IDE,编辑器都会自动读取该配置并应用相同的缩进、换行和字符集规则。本生成器让您通过可视化界面快速配置这些规则,无需记忆复杂的语法。

为什么每个项目都需要 .editorconfig?

虽然现代 IDE 都有自己的设置,但 EditorConfig 具有不可替代的优势:

  • 跨编辑器兼容 : 几乎所有主流编辑器都通过插件或内置功能支持它。
  • 随项目走 : 配置保存在 Git 仓库中,新克隆项目的开发者无需任何额外配置即可获得一致体验。
  • 针对性强 : 可以为不同的文件类型(如 .js , .py , Makefile )定义完全不同的风格规则。
  • 轻量级 : 相比于复杂的 Linter 配置,EditorConfig 仅关注最基础的文件格式,学习成本极低。

核心规则解析

  1. indent_style : 决定使用 tab 还是 space 。这是团队协作中最基础也最重要的规则。
  2. indent_size : 当使用空格缩进时,决定一个缩进代表多少个空格。
  3. end_of_line : 统一换行符为 lf (Unix) 或 crlf (Windows)。这能有效避免跨平台开发时的 Git 状态异常。
  4. trim_trailing_whitespace : 自动删除行尾多余的空格,保持代码洁净。
  5. insert_final_newline : 确保文件以一个空行结尾,这是许多 POSIX 工具的要求。

使用建议

建议将 .editorconfig 放在项目的根目录,并设置 root = true 以防止编辑器向上层目录寻找其他配置。对于大型单体仓库(Monorepo),您也可以在子目录放置额外的配置文件来覆盖特定目录的规则。

隐私声明

本生成器完全基于纯前端技术开发。您的所有配置操作、文件匹配模式和参数选择均在您的本地浏览器内处理。我们不会收集或存储您的任何配置信息,您可以放心生成任何商业或私有项目的规范文件。