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

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

24
0
0
0

EditorConfig 在线生成器

可视化配置 .editorconfig 文件,统一团队代码风格,让不同编辑器保持一致的编码规范。

预设模板:
仅顶层 .editorconfig 文件需要设置为 true
针对不同文件类型设置不同规则
实时预览 · .editorconfig

            

常见问题与知识点

EditorConfig 是一种跨编辑器的配置文件格式,用于定义和维护一致的编码风格。通过 .editorconfig 文件,团队成员无论使用 VS Code、IntelliJ、Sublime Text 还是其他编辑器,都能自动应用统一的缩进、换行符、字符集等规则,避免因编辑器差异导致的代码风格不一致问题。大多数现代编辑器都原生支持或通过插件支持 EditorConfig。

当编辑器打开一个文件时,EditorConfig 会从文件所在目录开始向上查找 .editorconfig 文件,直到找到设置了 root = true 的文件为止。这意味着你可以在项目根目录的 .editorconfig 中设置 root = true,阻止编辑器继续向上查找,避免受到系统级别或父目录配置的影响。通常建议在项目根目录的 .editorconfig 中设置此属性。

EditorConfig 专注于最基本的代码格式设置(缩进风格、换行符、字符集等),它不关心代码的具体语法或风格细节。Prettier 是一个更强大的代码格式化工具,能处理代码的具体格式(如引号、分号、换行位置等)。ESLint 则主要用于代码质量检查和风格规范。三者可以很好地配合使用:EditorConfig 提供编辑器层面的基础设置,Prettier 和 ESLint 提供更精细的代码格式和质量控制。

EditorConfig 的匹配模式遵循"最后匹配优先"原则。当多个 section 的匹配模式都适用于当前文件时,在文件中靠后出现的、更具体的匹配模式会覆盖前面更通用的模式。例如,[*.js] 会覆盖 [*] 中相同的属性设置。因此建议将通用配置 [*] 放在文件最前面,将针对特定文件类型的配置放在后面。

VS Code 需要安装 EditorConfig for VS Code 插件。安装后,VS Code 会自动检测项目中的 .editorconfig 文件,并优先应用其中的设置(覆盖 VS Code 自身的用户设置)。你可以在 VS Code 扩展商店搜索 "EditorConfig" 安装,安装后无需额外配置即可生效。

indent_style = space 时,indent_size 决定每次缩进使用多少个空格(通常为 2 或 4)。当 indent_style = tab 时,tab_width 决定一个 Tab 字符在编辑器中显示的宽度。indent_size 在 tab 模式下通常设为 tab 或不设置。对于 Makefile 这类文件,由于语法要求必须使用 Tab,应设置 indent_style = tab