Property Detail

• File contentRoot

  The content root directory of the module.

  For example see docs for IdeaModule

• boolean downloadJavadoc

  Whether to download and add javadoc associated with the dependency jars.

  For example see docs for IdeaModule

• boolean downloadSources

  Whether to download and add sources associated with the dependency jars.

  For example see docs for IdeaModule

• Set<File> excludeDirs

  ConventionProperty for the directories to be excluded.

  For example see docs for IdeaModule

• final 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.

  For example see docs for IdeaModule

• String jdkName

  The JDK to use for this module. If null, the value of the existing or default ipr XML (inherited) is used. If it is set to 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

  Configures module name, that is the name of the *.iml file.

  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

  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. If null, no entry will be created.

  For example see docs for IdeaModule

• PathFactory pathFactory

• Map<String, File> pathVariables

  The variables to be used for replacing absolute paths in the iml entries. For example, you might add a GRADLE_USER_HOME variable to point to the Gradle user home dir.

  For example see docs for IdeaModule

• final Project project

  An owner of this IDEA module.

  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<String, Map<String, Collection<Configuration>>> scopes

  The keys of this map are the IDEA scopes. Each key points to another map that has two keys, plus and minus. The values of those keys are collections of Configuration objects. The files of the plus configurations are added minus the files from the minus configurations. See example below...

  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<String, Iterable<File>> singleEntryLibraries

• Set<File> sourceDirs

  The directories containing the production sources.

  For example see docs for IdeaModule

• File testOutputDir

  The output directory for test classes. If null, no entry will be created.

  For example see docs for IdeaModule

• Set<File> testSourceDirs

  The directories containing the test sources.

  For example see docs for IdeaModule

Constructor Detail

• IdeaModule(Project project, IdeaModuleIml iml)

Method Detail

• File getOutputFile()

  Configures output *.iml file. It's optional because the task should configure it correctly for you (including making sure it is unique in the multi-module build). If you really need to change the output file name (or the module name) it is much easier to do it via the moduleName property!

  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)

  Enables advanced configuration like tinkering with the output XML or affecting the way existing *.iml content is merged with gradle build information.

  For example see docs for IdeaModule.

• void mergeXmlModule(Module xmlModule)

• Set<Dependency> resolveDependencies()

  Resolves and returns the module's dependencies.

  Returns:

  dependencies

• void setOutputFile(File newOutputFile)