stephenc
/
maven-plugin-tools
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

[MPLUGIN-115] Limit detail help output to a single goal 

git-svn-id: https://svn.apache.org/repos/asf/maven/plugin-tools/trunk@657555 13f79535-47bb-0310-9956-ffa450edef68
master
Benjamin Bentmann 2008-05-18 12:52:12 +00:00
parent f7ade15c6a
commit f3a91b5cfd
1 changed files with 32 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
maven-plugin-tools-api/src/main/java/org/apache/maven/tools/plugin/generator/PluginHelpGenerator.java
View File

@ -158,7 +158,8 @@ public class PluginHelpGenerator
} }
descriptor.setDescription( "Display help information on " + pluginDescriptor.getArtifactId() descriptor.setDescription( "Display help information on " + pluginDescriptor.getArtifactId()
+ ". Call 'mvn " + descriptor.getFullGoalName() + " -Ddetail=true' to display parameter details." ); + ". Call <pre> mvn " + descriptor.getFullGoalName()
+ " -Ddetail=true -Dgoal=&lt;goal-name&gt;</pre> to display parameter details." );
try try
{ {
@ -171,6 +172,15 @@ public class PluginHelpGenerator
param.setExpression( "${detail}" ); param.setExpression( "${detail}" );
descriptor.addParameter( param ); descriptor.addParameter( param );
} }
{
Parameter param = new Parameter();
param.setName( "goal" );
param.setType( "java.lang.String" );
param.setDescription( "The name of the goal for which to show help."
+ " If unspecified, all goals will be displayed." );
param.setExpression( "${goal}" );
descriptor.addParameter( param );
}
{ {
Parameter param = new Parameter(); Parameter param = new Parameter();
param.setName( "lineLength" ); param.setName( "lineLength" );
@ -393,9 +403,12 @@ public class PluginHelpGenerator
writer.write( " append( sb, \"\", 0 );" + LS ); writer.write( " append( sb, \"\", 0 );" + LS );
writer.write( LS ); writer.write( LS );
writer.write( " append( sb, \"This plugin has " + mojoDescriptors.size() + " " writer.write( " if ( goal == null || goal.length() <= 0 )" + LS );
writer.write( " {" + LS );
writer.write( " append( sb, \"This plugin has " + mojoDescriptors.size() + " "
+ ( mojoDescriptors.size() > 1 ? "goals" : "goal" ) + ":\", 0 );" + LS ); + ( mojoDescriptors.size() > 1 ? "goals" : "goal" ) + ":\", 0 );" + LS );
writer.write( " append( sb, \"\", 0 );" + LS ); writer.write( " append( sb, \"\", 0 );" + LS );
writer.write( " }" + LS );
writer.write( LS ); writer.write( LS );
@ -416,17 +429,21 @@ public class PluginHelpGenerator
private static void writeGoal( Writer writer, MojoDescriptor descriptor ) private static void writeGoal( Writer writer, MojoDescriptor descriptor )
throws IOException throws IOException
{ {
writer.write( " append( sb, \"" + StringUtils.escape( descriptor.getFullGoalName() ) + "\", 0 );" + LS ); writer.write( " if ( goal == null || goal.length() <= 0 || \""
writer.write( " append( sb, \"" + toDescription( descriptor.getDescription() ) + "\", 1 );" + LS ); + StringUtils.escape( descriptor.getGoal() ) + "\".equals( goal ) )" + LS );
writer.write( " {" + LS );
writer.write( " append( sb, \"" + StringUtils.escape( descriptor.getFullGoalName() ) + "\", 0 );"
+ LS );
writer.write( " append( sb, \"" + toDescription( descriptor.getDescription() ) + "\", 1 );" + LS );
writer.write( " append( sb, \"\", 0 );" + LS );
if ( descriptor.getParameters() != null && descriptor.getParameters().size() > 0 ) if ( descriptor.getParameters() != null && descriptor.getParameters().size() > 0 )
{ {
writer.write( " if ( detail )" + LS ); writer.write( " if ( detail )" + LS );
writer.write( " {" + LS ); writer.write( " {" + LS );
writer.write( " append( sb, \"\", 0 );" + LS ); writer.write( " append( sb, \"Available parameters:\", 1 );" + LS );
writer.write( " append( sb, \"Available parameters:\", 1 );" + LS ); writer.write( " append( sb, \"\", 0 );" + LS );
writer.write( " append( sb, \"\", 0 );" + LS );
for ( Iterator it = descriptor.getParameters().iterator(); it.hasNext(); ) for ( Iterator it = descriptor.getParameters().iterator(); it.hasNext(); )
{ {
@ -439,11 +456,10 @@ public class PluginHelpGenerator
} }
} }
writer.write( " }" + LS ); writer.write( " }" + LS );
} }
writer.write( LS ); writer.write( " }" + LS );
writer.write( " append( sb, \"\", 0 );" + LS );
writer.write( LS ); writer.write( LS );
} }
@ -460,8 +476,9 @@ public class PluginHelpGenerator
+ ( StringUtils.isNotEmpty( parameter.getDefaultValue() ) ? " (Default: " + ( StringUtils.isNotEmpty( parameter.getDefaultValue() ) ? " (Default: "
+ StringUtils.escape( parameter.getDefaultValue() ) + ")" : "" ); + StringUtils.escape( parameter.getDefaultValue() ) + ")" : "" );
writer.write( " append( sb, \"" + parameterDefaultValue + "\", 2 );" + LS ); writer.write( " append( sb, \"" + parameterDefaultValue + "\", 2 );" + LS );
writer.write( " append( sb, \"" + parameterDescription + "\", 3 );" + LS ); writer.write( " append( sb, \"" + parameterDescription + "\", 3 );" + LS );
writer.write( " append( sb, \"\", 0 );" + LS );
} }
} }