无需登录 数据私有 本地保存

EditorConfig 在线生成器 - 统一编辑器代码风格

开发工具 配置 EditorConfig 生成器 配置 风格
29
0
0
0
核心术语
EditorConfig

一种用于定义和维护一致编码风格的文件格式规范。它通过在项目目录中放置名为 .editorconfig 的配置文件，让支持该规范的编辑器自动应用统一的代码格式设置。EditorConfig 不依赖于任何特定的编辑器或 IDE，是一种跨平台、跨编辑器的通用解决方案。它专注于最基本的格式设置，如缩进、换行符和字符编码，不涉及代码语法或逻辑层面的格式化。

.editorconfig 文件

EditorConfig 规范的物理载体，是一个纯文本格式的配置文件。文件名以点开头，位于项目根目录或子目录中。文件内容由一个或多个配置节（Section）组成，每个配置节包含一个匹配模式和一组属性设置。编辑器在打开文件时会从文件所在目录开始向上查找 .editorconfig 文件，直到找到 root = true 的文件为止，然后应用匹配的配置规则。

root 属性

EditorConfig 配置文件中的一个特殊属性，用于指示编辑器是否停止向上查找配置文件。当 root = true 时，编辑器在当前文件中找到 .editorconfig 后会停止继续向上查找父目录的配置文件，避免受到系统级别配置的影响。当 root = false 时，编辑器会继续向上查找。通常建议在项目根目录的 .editorconfig 文件中设置 root = true，以确保项目配置的独立性。

配置节（Section）

.editorconfig 文件中的一个配置单元，由方括号包裹的匹配模式和下方的属性列表组成。例如 [*] 表示匹配所有文件，[*.js] 表示匹配所有 JavaScript 文件。配置节决定了哪些文件会应用其中定义的属性设置。文件可以匹配多个配置节，按照"最后匹配优先"原则应用规则。

配置属性
indent_style

定义缩进使用的字符类型。可选值为 tab（制表符）或 space（空格）。当设置为 tab 时，缩进使用一个 Tab 字符，实际显示宽度由编辑器的 tab_width 设置决定。当设置为 space 时，缩进使用指定数量的空格字符。大多数现代项目推荐使用 space 风格，因为不同编辑器对 Tab 的显示宽度处理可能不一致，而空格的显示效果始终相同。Makefile 等特殊文件则必须使用 tab 缩进。

indent_size

当 indent_style 设置为 space 时，指定每次缩进使用的空格数量。常见的设置值为 2 或 4。前端项目（HTML、CSS、JavaScript）通常使用 2 空格缩进，Python 项目使用 4 空格缩进。该设置不影响 tab 缩进风格下的显示效果。如果同时设置了 tab_width，indent_size 可以设为 tab 以保持一致。

end_of_line

定义换行符的类型。可选值为 lf（Unix 风格，仅换行）、crlf（Windows 风格，回车+换行）或 auto（自动检测）。跨平台项目推荐使用 lf，因为 Git 可以通过配置自动处理换行符转换。Windows 专用项目可以使用 crlf。auto 模式会根据当前操作系统自动选择，但不推荐在团队协作项目中使用，因为不同成员的操作系统可能不同。

charset

定义文件的字符编码格式。常见选项包括 utf-8（推荐，支持所有 Unicode 字符）、utf-8-bom（带 BOM 头的 UTF-8，某些 Windows 工具需要）、latin1（西欧字符集）和 ascii（仅 ASCII 字符）。现代项目强烈推荐使用 utf-8 编码，它能够正确处理中文、日文、韩文等多语言字符，同时与 ASCII 完全兼容。BOM 头在某些工具中可能导致问题，除非有特殊需求，否则建议避免使用 utf-8-bom。

扩展属性
trim_trailing_whitespace

控制是否自动删除行尾的空白字符（空格和制表符）。设置为 true 时，编辑器在保存文件时会自动去除每行末尾的多余空白字符。这有助于保持代码整洁，避免 Git diff 中出现大量由行尾空白引起的无意义变更。大多数项目建议启用此设置。但对于 Markdown 文件，行尾的两个空格表示换行，因此建议为 *.md 文件单独设置 trim_trailing_whitespace = false。

insert_final_newline

控制文件末尾是否自动插入一个空行。设置为 true 时，编辑器会在保存文件时确保文件最后一行以换行符结尾。这是 POSIX 标准的文件格式要求，许多工具（如 cat、diff）都依赖此行为。启用此设置可以避免 Git 在文件末尾缺少换行符时显示 No newline at end of file 警告。大多数项目建议启用此设置。

tab_width

指定一个 Tab 字符在编辑器中显示的等效空格宽度。该属性仅在 indent_style = tab 时有意义。常见的设置值为 4 或 8。不同的编辑器可能有不同的默认 Tab 宽度设置，通过 EditorConfig 统一此设置可以确保所有团队成员看到相同的代码缩进效果。如果同时设置了 indent_size，建议将 tab_width 设置为相同的值以保持视觉一致性。

匹配模式
通配符匹配

EditorConfig 的匹配模式使用类似 .gitignore 的通配符语法。* 匹配任意数量的字符（不包含路径分隔符），** 匹配任意数量的字符（包含路径分隔符），? 匹配单个字符，[abc] 匹配方括号内的任意一个字符。例如，[*] 匹配所有文件，[*.py] 匹配所有 Python 文件，[src/**/*.js] 匹配 src 目录下所有子目录中的 JavaScript 文件。

匹配优先级

当多个配置节的匹配模式都适用于同一个文件时，EditorConfig 遵循"最后匹配优先"原则。在 .editorconfig 文件中靠后出现的配置节会覆盖前面配置节中的同名属性。但不同名的属性会合并生效。因此，建议将通用配置 [*] 放在文件最前面，将特定文件类型的配置放在后面，确保特定配置能正确覆盖通用配置。

🔧 相关工具