Chapter 28. The Idea Plugin

If you want Gradle to completely overwrite existing Idea files you can specify this on the command line by executing something like gradle cleanIdea idea or gradle cleanIdeaModule ideaModule. You can specify this also in the build script. Just make the generating tasks depending on the deleting tasks. You can tailor this to your needs. You could make the idea task dependent on the cleanIdea task. If you only want to overwrite for example the module files you simply make the ideaModule task dependent on the cleanIdeaModule task.

Doing a complete overwrite removes all your manual customizations. This might be not what you want. Therefore Gradle provides the option for a partial overwrite. You can hook into the phase just after the existing Idea files have populated the domain objects. You could then for example remove all the dependencies from the module object.

ideaModule {
    beforeConfigured { module ->
        module.dependencies.clear()
    }
}

The generated XML will have all sections of the existing Idea module file, except for the dependencies, where only the information of the build script is used. You could do something similar for the project file.

ideaProject {
    beforeConfigured { project ->
        project.modulePaths.clear()
    }
}

You can also hook into the phase after the existing Idea files and the build script metadata have populated the domain objects. You could then for example export all the dependencies of the module object.

ideaModule {
    whenConfigured { module ->
        module.dependencies*.exported = true
    }
}

You can also hook into the phase after the XML DOM is fully populated but not written to disk. That hook provides total control over what is generated.

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