jade-idea:idea

Goal for generating IDEA files from a POM. This plug-in provides the ability to generate IDEA project files (.ipr, .iml and .iws files) for IDEA

Mojo Attributes:

  • Requires a Maven 2.0 project to execute.
  • Invokes the execution of the lifecycle phase generate-sources prior to executing itself.

Optional Parameters

Name Type Description
projectHelper MavenProjectHelper project-helper instance, used to make addition of resources simpler
artifactResolver ArtifactResolver Used to look up Artifacts in the local or remote repository.
artifactFactory ArtifactFactory Used to look up Artifacts in the local or remote repository.
localRepository ArtifactRepository The local repository
pluginArtifacts Artifact> The plugin dependency artifacts
maven2AntManager Maven2AntManager The manager to link maven project with an Ant project.
nameProvider ProjectNameProvider No description.
artifactMetadataSource ArtifactMetadataSource No description.
groupDefinitions GroupDefinition> No description.
templatesPath String Absolute path for the workspace/module/project templates
overwrite boolean Whether to update the existing project files or overwrite them. Default value is false.
externalModules String> A list of external modules to nbe added to the project
wagonManager WagonManager No description.
linkModules boolean Whether to link the reactor projects as dependency modules or as libraries Default value is true.
deploymentDescriptorFile String Specify the location of the deployment descriptor file, if one is provided
useFullNames boolean Whether to use full artifact names when referencing libraries Default value is false.
downloadSources boolean Enables/disables the downloading of source attachments Default value is false.
downloadJavadocs boolean Enables/disables the downloading of javadoc attachements Default value is false.
sourceClassifier String Sets the classifier string attached to an artifact source archive name Default value is sources.
javadocClassifier String Sets the classifier string attached to an artifact javadoc archive name Default value is javadoc.
libraries Library[] An optional set of Library objects that allow you to specify a comma separated list of source dirs, class dirs, or to indicate that the library should be excluded from the module. For example: 
 <libraries>
  <library>
      <name>webwork</name>
      <sources>file://$webwork$/src/java</sources>
      <!--
      <classes>...</classes>
      <exclude>true</exclude>
      -->
  </library>
 </libraries>
exclude String A comma-separated list of directories that should be excluded. These directories are in addition to those already excluded, such as target.
dependenciesAsLibraries boolean Causes the module libraries to use a short name for all dependencies. This is very convenient but has been reported to cause problems with IDEA. Default value is true.
ideaPlugin boolean Tell IntelliJ IDEA that this module is an IntelliJ IDEA Plugin Default value is false.
attemptDownloadMgr AttemptDownloadManager No description.
jdkName String Specify the name of the registered IDEA JDK to use for the project.
jdkLevel String Specify the version of the JDK to use for the project for the purpose of enabled assertions and 5.0 language features. The default value is the specification version of the executing JVM.
wildcardResourcePatterns String Specify the resource pattern in wildcard format, for example "?*.xml;?*.properties". Currently supports 4.x and 5.x. The default value is any file without a java extension ("!?*.java"). Because IDEA doesn't distinguish between source and resources directories, this is needed. Please note that the default value includes package.html files as it's not possible to exclude those. Default value is !?*.java.
ideaVersion String Specify the version of idea to use. This is needed to identify the default formatting of project-jdk-name used by idea. Currently supports 4.x and 5.x.

This will only be used when parameter jdkName is not set. Default value is 5.x.

Parameter Details

projectHelper

project-helper instance, used to make addition of resources simpler

  • Type: org.apache.maven.project.MavenProjectHelper
  • Required: No
artifactResolver Used to look up Artifacts in the local or remote repository.
  • Type: org.apache.maven.artifact.resolver.ArtifactResolver
  • Required: No
artifactFactory Used to look up Artifacts in the local or remote repository.
  • Type: org.apache.maven.artifact.factory.ArtifactFactory
  • Required: No
localRepository The local repository
  • Type: org.apache.maven.artifact.repository.ArtifactRepository
  • Required: No
  • Expression: ${localRepository}
pluginArtifacts The plugin dependency artifacts
  • Type: java.util.List<org.apache.maven.artifact.Artifact>
  • Required: No
  • Expression: ${plugin.artifacts}
maven2AntManager The manager to link maven project with an Ant project.
  • Type: org.jfrog.jade.plugins.common.ant.Maven2AntManager
  • Required: No
nameProvider No Description.
  • Type: org.jfrog.jade.plugins.common.naming.ProjectNameProvider
  • Required: No
artifactMetadataSource No Description.
  • Type: org.apache.maven.artifact.metadata.ArtifactMetadataSource
  • Required: No
groupDefinitions No Description.
  • Type: java.util.Set<org.jfrog.jade.plugins.common.naming.GroupDefinition>
  • Required: No
templatesPath Absolute path for the workspace/module/project templates
  • Type: java.lang.String
  • Required: No
overwrite Whether to update the existing project files or overwrite them.
  • Type: boolean
  • Required: No
  • Expression: ${overwrite}
  • Default: false
externalModules A list of external modules to nbe added to the project
  • Type: java.util.List<java.lang.String>
  • Required: No
wagonManager No Description.
  • Type: org.apache.maven.artifact.manager.WagonManager
  • Required: No
linkModules Whether to link the reactor projects as dependency modules or as libraries
  • Type: boolean
  • Required: No
  • Expression: ${linkModules}
  • Default: true
deploymentDescriptorFile Specify the location of the deployment descriptor file, if one is provided
  • Type: java.lang.String
  • Required: No
  • Expression: ${deploymentDescriptorFile}
useFullNames Whether to use full artifact names when referencing libraries
  • Type: boolean
  • Required: No
  • Expression: ${useFullNames}
  • Default: false
downloadSources Enables/disables the downloading of source attachments
  • Type: boolean
  • Required: No
  • Expression: ${downloadSources}
  • Default: false
downloadJavadocs Enables/disables the downloading of javadoc attachements
  • Type: boolean
  • Required: No
  • Expression: ${downloadJavadocs}
  • Default: false
sourceClassifier Sets the classifier string attached to an artifact source archive name
  • Type: java.lang.String
  • Required: No
  • Expression: ${sourceClassifier}
  • Default: sources
javadocClassifier Sets the classifier string attached to an artifact javadoc archive name
  • Type: java.lang.String
  • Required: No
  • Expression: ${javadocClassifier}
  • Default: javadoc
libraries An optional set of Library objects that allow you to specify a comma separated list of source dirs, class dirs, or to indicate that the library should be excluded from the module. For example: 
 <libraries>
  <library>
      <name>webwork</name>
      <sources>file://$webwork$/src/java</sources>
      <!--
      <classes>...</classes>
      <exclude>true</exclude>
      -->
  </library>
 </libraries>
  • Type: org.jfrog.jade.plugins.idea.Library[]
  • Required: No
exclude A comma-separated list of directories that should be excluded. These directories are in addition to those already excluded, such as target.
  • Type: java.lang.String
  • Required: No
dependenciesAsLibraries Causes the module libraries to use a short name for all dependencies. This is very convenient but has been reported to cause problems with IDEA.
  • Type: boolean
  • Required: No
  • Expression: ${dependenciesAsLibraries}
  • Default: true
ideaPlugin Tell IntelliJ IDEA that this module is an IntelliJ IDEA Plugin
  • Type: boolean
  • Required: No
  • Default: false
attemptDownloadMgr No Description.
  • Type: org.jfrog.jade.plugins.idea.AttemptDownloadManager
  • Required: No
jdkName Specify the name of the registered IDEA JDK to use for the project.
  • Type: java.lang.String
  • Required: No
  • Expression: ${jdkName}
jdkLevel Specify the version of the JDK to use for the project for the purpose of enabled assertions and 5.0 language features. The default value is the specification version of the executing JVM.
  • Type: java.lang.String
  • Required: No
  • Expression: ${jdkLevel}
wildcardResourcePatterns Specify the resource pattern in wildcard format, for example "?*.xml;?*.properties". Currently supports 4.x and 5.x. The default value is any file without a java extension ("!?*.java"). Because IDEA doesn't distinguish between source and resources directories, this is needed. Please note that the default value includes package.html files as it's not possible to exclude those.
  • Type: java.lang.String
  • Required: No
  • Expression: ${wildcardResourcePatterns}
  • Default: !?*.java
ideaVersion Specify the version of idea to use. This is needed to identify the default formatting of project-jdk-name used by idea. Currently supports 4.x and 5.x. This will only be used when parameter jdkName is not set.
  • Type: java.lang.String
  • Required: No
  • Expression: ${ideaVersion}
  • Default: 5.x