|
Groovy Documentation | |||||||
FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | PROPERTY | CONSTR | METHOD | DETAIL: FIELD | PROPERTY | CONSTR | METHOD |
java.lang.Object org.gradle.plugins.ide.idea.model.IdeaModule
class IdeaModule
Enables fine-tuning module details (*.iml file) of the IDEA plugin .
Example of use with a blend of all possible properties. Typically you don't have configure this model directly because Gradle configures it for you.
apply plugin: 'java' apply plugin: 'idea' //for the sake of this example, let's introduce a 'provided' configuration configurations { provided provided.extendsFrom(compile) } dependencies { //provided "some.interesting:dependency:1.0" } idea { //if you want parts of paths in resulting files (*.iml, etc.) to be replaced by variables (Files) pathVariables GRADLE_HOME: file('~/cool-software/gradle') module { //if for some reason you want to add an extra sourceDirs sourceDirs += file('some-extra-source-folder') //and some extra test source dirs testSourceDirs += file('some-extra-test-dir') //and some extra dirs that should be excluded by IDEA excludeDirs += file('some-extra-exclude-dir') //if you don't like the name Gradle has chosen name = 'some-better-name' //if you prefer different output folders inheritOutputDirs = false outputDir = file('muchBetterOutputDir') testOutputDir = file('muchBetterTestOutputDir') //if you prefer different SDK than that inherited from IDEA project jdkName = '1.6' //if you need to put 'provided' dependencies on the classpath scopes.PROVIDED.plus += configurations.provided //if 'content root' (as IDEA calls it) of the module is different contentRoot = file('my-module-content-root') //if you love browsing Javadoc downloadJavadoc = true //and hate reading sources :) downloadSources = false } }For tackling edge cases users can perform advanced configuration on resulting xml file. It is also possible to affect the way the IDEA plugin merges the existing configuration via beforeMerged and whenMerged closures.
beforeMerged and whenMerged closures receive Module object
Examples of advanced configuration:
apply plugin: 'java' apply plugin: 'idea' idea { module { iml { //if you like to keep *.iml in a secret folder generateTo = file('secret-modules-folder') //if you want to mess with the resulting xml in whatever way you fancy withXml { def node = it.asNode() node.appendNode('iLoveGradle', 'true') node.appendNode('butAlso', 'I find increasing pleasure tinkering with output *.iml contents. Yeah!!!') } //closure executed after *.iml content is loaded from existing file //but before gradle build information is merged beforeMerged { module -> //if you want skip merging exclude dirs module.excludeFolders.clear() } //closure executed after *.iml content is loaded from existing file //and after gradle build information is merged whenMerged { module -> //you can tinker with Module } } } }
Property Summary | |
---|---|
File |
contentRoot
The content root directory of the module. |
boolean |
downloadJavadoc
Whether to download and add javadoc associated with the dependency jars. |
boolean |
downloadSources
Whether to download and add sources associated with the dependency jars. |
Set |
excludeDirs
ConventionProperty for the directories to be excluded. |
IdeaModuleIml |
iml
See iml(Closure) |
Boolean |
inheritOutputDirs
If true, output directories for this module will be located below the output directory for the project; otherwise, they will be set to the directories specified by #outputDir and #testOutputDir. |
String |
jdkName
The JDK to use for this module. |
String |
name
Configures module name, that is the name of the *.iml file. |
boolean |
offline
If true then external artifacts (e.g. those found in repositories) will not be included in the resulting classpath (only project and local file dependencies will be included). |
File |
outputDir
The output directory for production classes. |
PathFactory |
pathFactory
|
Map |
pathVariables
The variables to be used for replacing absolute paths in the iml entries. |
org |
project
An owner of this IDEA module. |
Map |
scopes
The keys of this map are the IDEA scopes. |
Map |
singleEntryLibraries
|
Set |
sourceDirs
The directories containing the production sources. |
File |
testOutputDir
The output directory for test classes. |
Set |
testSourceDirs
The directories containing the test sources. |
Constructor Summary | |
IdeaModule(Project project, IdeaModuleIml iml)
|
Method Summary | |
---|---|
File
|
getOutputFile()
Configures output *.iml file. |
void
|
iml(Closure closure)
Enables advanced configuration like tinkering with the output xml or affecting the way existing *.iml content is merged with gradle build information |
void
|
mergeXmlModule(Module xmlModule)
|
Set
|
resolveDependencies()
Resolves and returns the module's dependencies. |
void
|
setOutputFile(File newOutputFile)
|
Methods inherited from class Object | |
---|---|
wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll |
Property Detail |
---|
File contentRoot
For example see docs for IdeaModule
boolean downloadJavadoc
For example see docs for IdeaModule
boolean downloadSources
For example see docs for IdeaModule
Set excludeDirs
For example see docs for IdeaModule
final IdeaModuleIml iml
Boolean inheritOutputDirs
For example see docs for IdeaModule
String jdkName
inherited
, the project SDK is used. Otherwise the SDK for the corresponding
value of java version is used for this module
For example see docs for IdeaModule
String name
It's optional because the task should configure it correctly for you. By default it will try to use the project.name or prefix it with a part of a project.path to make sure the module name is unique in the scope of a multi-module build. The 'uniqueness' of a module name is required for correct import into IDEA and the task will make sure the name is unique.
since 1.0-milestone-2
If your project has problems with unique names it is recommended to always run gradle idea from the root, i.e. for all subprojects. If you run the generation of the IDEA module only for a single subproject then you may have different results because the unique names are calculated based on IDEA modules that are involved in the specific build run.
If you update the module names then make sure you run gradle idea from the root, e.g. for all subprojects, including generation of IDEA project. The reason is that there may be subprojects that depend on the subproject with amended module name. So you want them to be generated as well because the module dependencies need to refer to the amended project name. Basically, for non-trivial projects it is recommended to always run gradle idea from the root.
For example see docs for IdeaModule
boolean offline
File outputDir
For example see docs for IdeaModule
PathFactory pathFactory
Map pathVariables
For example see docs for IdeaModule
final org project
If IdeaModule requires some information from gradle this field should not be used for this purpose. IdeaModule instances should be configured with all necessary information by the plugin or user.
Map scopes
Example how to use scopes property to enable 'provided' dependencies in the output *.iml file:
apply plugin: 'java' apply plugin: 'idea' configurations { provided provided.extendsFrom(compile) } dependencies { //provided "some.interesting:dependency:1.0" } idea { module { scopes.PROVIDED.plus += configurations.provided } }
Map singleEntryLibraries
Set sourceDirs
For example see docs for IdeaModule
File testOutputDir
For example see docs for IdeaModule
Set testSourceDirs
For example see docs for IdeaModule
Constructor Detail |
---|
IdeaModule(Project project, IdeaModuleIml iml)
Method Detail |
---|
File getOutputFile()
Please refer to documentation on moduleName property. In IntelliJ IDEA the module name is the same as the name of the *.iml file.
void iml(Closure closure)
For example see docs for IdeaModule
void mergeXmlModule(Module xmlModule)
Set resolveDependencies()
void setOutputFile(File newOutputFile)
Gradle API 1.0-milestone-9