EditorConfig 生成器
创建 .editorconfig 文件,确保不同编辑器中的缩进、换行符、字符集和空白字符保持一致。可以选择空格或制表符、缩进大小、LF 或 CRLF、字符集、行尾空白和文件末尾换行符规则,以及可选的最大行长度;还可为 Markdown 和 Makefile 添加常见覆盖规则。
常见问题
.editorconfig 文件是什么?
这是放在项目根目录中的纯文本文件,用于告诉编辑器如何格式化文件,包括缩进、换行符、字符集和空白字符。许多编辑器都原生支持它,包括安装 EditorConfig 扩展的 Visual Studio Code、JetBrains IDE 和 Visual Studio。
为什么文件以 root = true 开头?
root = true 会告诉编辑器停止在上级文件夹中继续查找 .editorconfig 文件,避免本项目的设置与其他设置混在一起。
为什么要在 Markdown 中保留行尾空格?
Markdown 行末尾的两个空格表示硬换行。[*.md] 部分会关闭对该类文件的行尾空白修剪,因此这些换行符会保留下来。
为什么 Makefile 要使用制表符?
make 要求每条配方行开头都必须有一个制表符。[Makefile] 部分会保留制表符,即使项目其他部分使用空格也是如此。如果你已经选择使用制表符,则不会添加此部分。
max_line_length 有什么作用?
它会告诉支持此设置的编辑器在何处换行或显示标尺。许多编辑器会忽略它,而 Prettier 等格式化工具会将其作为打印宽度。输入 0 可省略此设置。
EditorConfig 会重新格式化已有文件吗?
不会。它会影响编辑器写入新修改的方式,以及某些保存操作的行为。运行一次格式化工具,即可让已有文件符合设置。