跨多个项目共享单个.editorconfig文件

Question

我的团队在GitHub中维护了几个Java存储库。它们中的每一个在根文件夹中都有一个.editorconfig文件，而且它们都是完全相同的。这使得维护它们有点痛苦，因为它们都必须单独更新。

我们都在使用IntelliJ，它有一个从网址下载检查样式规则的功能，但是似乎没有办法用.editorconfig规则来做到这一点。

我们所有的项目都使用Maven。有没有办法使.editorconfig文件可以通过API访问，并将项目配置为自动下载并将其放在根文件夹中？

对于任何不熟悉EditorConfig的人，请访问here了解更多信息。

Answer 1

我做了一个工具来解决这类问题。它是作为NPM包开发的，但它基本上只是一个命令行工具，因此它应该适用于这种情况。如果你用Exec Maven Plugin执行像npx your-dictator-name@version这样的东西。

这个工具被称为Dictator Builder，它帮助创建“独裁者”。独裁者是包含"dictatable“的命令行工具，你的.editorconfig可以是”dictatable“的一部分。

在您的示例中，您可以拥有一个包含以下内容的.dictatable-config.json：

{
  "message": "Copy editorconfig",
  "actions": [
    {
      "copyFrom": ".editorconfig",
      "target": "."
    }
  ]
}

Answer 2

引用你提到的同一个EditorConfig docs：

打开文件时，EditorConfig插件在打开的文件所在的目录和每个父目录中查找名为.editorconfig的文件。如果到达根文件路径或找到包含root=true的EditorConfig文件，则将停止搜索.editorconfig文件。

因此，最方便、最易于管理的方法是创建一个.editorconfig文件，并将其放在所有存储库的父目录中的某个位置。该文件中必须包含root=true行。

这也许可以通过将文件存储在一个存储库中并在父目录中创建指向它的符号链接来进一步改进：

cd <parent_dir_for_all_repos>
ln -s .../path/to/.editorconfig