第39章 IDEAプラグイン

To completely rewrite existing IDEA files, execute a clean task together with its corresponding generation task, like "gradle cleanIdea idea" (in that order). If you want to make this the default behavior, add "tasks.idea.dependsOn(cleanIdea)" to your build script. This makes it unnecessary to execute the clean task explicitly.

既存のIDEAファイルを完全に上書きするには、クリーンタスクを、対応する生成タスクと一緒に使用してください。例えば、gradle cleanIdea ideaをこの順序で使用します。 デフォルトでそのように動作させたいのであれば、tasks.idea.dependsOn(cleanIdea)というコードをビルドスクリプトに追加してください。明示的にクリーンタスクを実行する必要がなくなります。

This strategy can also be used for individual files that the plugin would generate. For instance, this can be done for the “.iml” file with “gradle cleanIdeaModule ideaModule”.

この戦略はプラグインが生成する個々のファイルに対しても適用可能で、例えば “.iml”ファイルに対して" gradle cleanIdeaModule ideaModule"のようにできます。

A complete rewrite causes all existing content to be discarded, thereby losing any changes made directly in the IDE. The beforeMerged hook makes it possible to overwrite just certain parts of the existing content. The following example removes all existing dependencies from the Module domain object: 完全な上書きは、既存の内容を全て破棄するので、IDEで直接行った変更も失われてしまいます。 beforeMergedフックを使うと、既存の内容のうち特定の部分だけを上書きすることができます。 次の例では、Moduleドメインオブジェクトから、既存の依存関係を全て削除しています。

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

The resulting module file will only contain Gradle-generated dependency entries, but not any other dependency entries that may have been present in the original file. (In the case of dependency entries, this is also the default behavior.) Other sections of the module file will be either left as-is or merged. The same could be done for the module paths in the project file: 結果として生成されるモジュールファイルには、Gradleが生成した依存関係のエントリのみが含まれており、元のファイルにあった他のエントリは含まれていません(依存関係エントリの場合、これがデフォルトの動作でもあります)。 そして、モジュールファイルの別のセクションはそのまま、またはマージされた状態で残されます。 同じことはプロジェクトファイルのモジュールパスを使用しても実現可能です。

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

The whenMerged hook allows you to manipulate the fully populated domain objects. Often this is the preferred way to customize IDEA files. Here is how you would export all the dependencies of an IDEA module: whenMergedフックを使うと、読み込まれた全てのドメインオブジェクトを操作できます。 IDEAファイルをカスタマイズするときは、多くの場合このフックを使うのが好ましい方法です。例えば、IDEAモジュールの全ての依存関係をエクスポートするには、以下のようにします。

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

The withXmlhook allows you to manipulate the in-memory XML representation just before the file gets written to disk. Although Groovy's XML support makes up for a lot, this approach is less convenient than manipulating the domain objects. In return, you get total control over the generated file, including sections not modeled by the domain objects. withXmlフックを使うと、メモリ内のXMLデータを、ファイルに書き出される直前に操作できます。 GroovyのXMLサポートで大幅にフォローされるものの、このアプローチはドメインオブジェクトを操作する方法ほど便利ではありません。 その代わり、ドメインオブジェクトで表現されないような部分も含め、生成されるファイルの全てを制御することができます。

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