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

时间:2018-03-29 22:36:12

标签: java maven intellij-idea editorconfig

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

我们所有人都使用IntelliJ,它具有从URL下载checkstyle规则的功能,但似乎没有办法通过.editorconfig规则来实现。

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

对于不熟悉EditorConfig的人,更多信息为here

2 个答案:

答案 0 :(得分:0)

我做了一个工具来解决这种问题。它是作为NPM软件包开发的,但它基本上只是命令行工具,因此在这种情况下应该可以使用。如果您使用Exec Maven Plugin执行类似npx your-dictator-name@version的操作。

该工具称为Dictator Builder,可帮助创建“独裁者”。独裁者是包含“可写事物”的命令行工具,您的.editorconfig可以是“可写事物”的一部分。

在您的情况下,您可以使用类似以下内容的.dictatable-config.json

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

答案 1 :(得分:0)

引用与您提到的相同的EditorConfig docs

打开文件时,EditorConfig插件会在打开的文件目录和每个父目录中查找名为.editorconfig的文件。如果到达根文件路径或找到带有.editorconfig的EditorConfig文件,将停止对root=true文件的搜索。

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

通过将文件存储在 one 存储库中并在父目录中为其创建 symlink ,可以进一步改善此问题:

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