关于此工具
.editorconfig 文件能让项目所有贡献者使用的编辑器和 IDE(VS Code、JetBrains、Vim 等,大多原生支持、无需插件)保持一致的缩进、换行符和字符集。设置全局默认值,勾选项目需要的按语言覆盖设置(Markdown 会跳过去除行尾空白,因为两个行尾空格代表换行;Makefile 要求使用真实的制表符),然后复制或下载结果。
一切都在本地根据您的选择生成——不会上传任何内容。把文件放在仓库根目录、.git 旁边并提交;此后编辑器会自动对该目录下所有文件生效。
常见问题
.editorconfig 文件到底有什么作用?
它告诉每一个读取它的编辑器和 IDE(VS Code、JetBrains、Vim、Sublime 等,大多数原生支持)在该文件夹及以下应使用什么缩进、换行符和字符集——这样无论贡献者用哪个编辑器打开项目,都能保持一致,无需任何人手动配置自己的设置。
为什么 Markdown 会跳过去除行尾空白?
在标准 Markdown 中,行尾两个或更多空格会在渲染结果中强制换行——这是有意为之但容易被忽略的语法。全局的去除行尾空白规则会在每次保存文件时悄悄删掉这种格式,因此本生成器的 Markdown 覆盖设置专门为 .md 文件关闭了此规则。
我的编辑器需要插件才能读取这个文件吗?
通常不需要。VS Code、JetBrains 系 IDE(WebStorm、PyCharm、IntelliJ 等)以及其他多款编辑器都原生支持 .editorconfig,开箱即用。少数较旧或较冷门的编辑器确实需要一个小插件——如果添加文件后格式化似乎没有变化,请查阅您所用编辑器的文档;但对大多数贡献者使用的主流编辑器来说,这直接就能生效。
使用此工具时,我的项目配置会被上传吗?
不会。该文件完全根据您在浏览器中所选的复选框和下拉选项生成——由于本来就不会读取任何项目文件,也就没有什么可上传的。可以直接复制结果或下载。