第三十九章. IDEA 插件

build.gradle

apply plugin: 'idea'

若要完整覆盖现有 IDEA 文件，请执行clean任务和其相应的生成任务，例如gradle
cleanIdea idea (按此顺序)。如果你想要让它成为默认行为，请将tasks.idea.dependsOn(cleanIdea)添加到构建脚本中。这样一来，我们就没有必要显式执行
clean 任务。

完整覆盖同样可以用于个人文件，例如通过执行gradle
cleanIdeaModule ideaModule。

1. 读取文件;如果它不存在，则使用由 Gradle 提供的默认版本
2. beforeMerged的
   hook 会随着一个表示现有文件的域对象执行
3. 从 Gradle 构建推断出来或在 eclipse DSL 中显示定义的配置会与现有的内容合并在一起
4. whenMerged的
   hook 会随着一个表示持久化的域对象执行
5. withXml的 hook
   会随着一个表示将被持久化的XML的 raw 执行
6. 最终的 XML 被持久化

表 39.4. Idea 插件 hook

一个完全覆盖会导致现有的所有内容被丢弃，从而丢失在
IDE 中直接做的任何修改。beforeMerged hook
可以实现只覆盖现有的某些部分的内容。下面的示例从Module域对象中删除现有的所有依赖关系:

idea.module.iml {
    beforeMerged { module ->
        module.dependencies.clear()
    }
}

生成的模块文件将只包含 Gradle 生成的依赖项，而没有其他可能存在于原始文件的依赖项。(对于依赖项，这也是默认行为。)其他部分的模块文件将会被保留或合并。对项目文件中的模块路径的处理也是一样：

idea.project.ipr {
    beforeMerged { project ->
        project.modulePaths.clear()
    }
}

WhenMerged hook
允许操作完全填充的域对象。通常，这是自定义 IDEA 文件的首选方法。下面的例子展示了如何导出一个 IDEA 模块的所有依赖项：

idea.module.iml {
    whenMerged { module ->
        module.dependencies*.exported = true
    }
}

WithXml hook
允许在文件写入到磁盘之前，操纵内存中的 XML 的表示形式。尽管 Groovy 的 XML 支持对其有很大作用，但这种方法比起操纵域对象依然不大方便 。作为回报，你可以对生成的文件进行全面的控制，包括未由域对象建模的那些部分。

idea.project.ipr {
    withXml { provider ->
        provider.node.component.find { it.@name == 'VcsDirectoryMappings' }.mapping.@vcs = 'Git'
    }
}