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

o Made help goal output plugin name, version and description 

git-svn-id: https://svn.apache.org/repos/asf/maven/plugin-tools/trunk@654891 13f79535-47bb-0310-9956-ffa450edef68
master
Benjamin Bentmann 2008-05-09 17:31:57 +00:00
parent 4c11552445
commit ebd246bba0
1 changed files with 46 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -154,8 +154,8 @@ public class PluginHelpGenerator
descriptor.setImplementation( HELP_MOJO_CLASS_NAME ); descriptor.setImplementation( HELP_MOJO_CLASS_NAME );
} }
descriptor.setDescription( "Display help information on '" + pluginDescriptor.getPluginLookupKey() descriptor.setDescription( "Display help information on " + pluginDescriptor.getArtifactId()
+ "' plugin. Call 'mvn " + descriptor.getFullGoalName() + " -Ddetail=true' to display parameter details." ); + ". Call 'mvn " + descriptor.getFullGoalName() + " -Ddetail=true' to display parameter details." );
return descriptor; return descriptor;
} }
@ -332,8 +332,20 @@ public class PluginHelpGenerator
writer.write( " StringBuffer sb = new StringBuffer();" + LS ); writer.write( " StringBuffer sb = new StringBuffer();" + LS );
writer.write( LS ); writer.write( LS );
writer.write( " sb.append( \"The '" + pluginDescriptor.getPluginLookupKey() + "' plugin has "
+ mojoDescriptors.size() + " " writer.write( " sb.append( \"" + pluginDescriptor.getId() + "\" ).append( \"\\n\" );" + LS );
writer.write( " sb.append( \"\\n\" );" + LS );
writer.write( LS );
writer.write( " sb.append( \""
+ StringUtils.escape( pluginDescriptor.getName() + " " + pluginDescriptor.getVersion() )
+ "\" ).append( \"\\n\" );" + LS );
writer.write( " appendDescription( sb, \"" + toDescription( pluginDescriptor.getDescription() )
+ "\", DEFAULT_INDENT );" + LS );
writer.write( " sb.append( \"\\n\" );" + LS );
writer.write( LS );
writer.write( " sb.append( \"This plugin has " + mojoDescriptors.size() + " "
+ ( mojoDescriptors.size() > 1 ? "goals" : "goal" ) + ":\" ).append( \"\\n\" );" + LS ); + ( mojoDescriptors.size() > 1 ? "goals" : "goal" ) + ":\" ).append( \"\\n\" );" + LS );
writer.write( " sb.append( \"\\n\" );" + LS ); writer.write( " sb.append( \"\\n\" );" + LS );
@ -356,12 +368,9 @@ public class PluginHelpGenerator
private static void writeGoal( Writer writer, MojoDescriptor descriptor ) private static void writeGoal( Writer writer, MojoDescriptor descriptor )
throws IOException throws IOException
{ {
String goal = descriptor.getFullGoalName(); writer.write( " sb.append( \"" + descriptor.getFullGoalName() + "\" ).append( \"\\n\" );" + LS );
String description = StringUtils.isNotEmpty( descriptor.getDescription() ) ? writer.write( " appendDescription( sb, \"" + toDescription( descriptor.getDescription() )
StringUtils.escape( toText( descriptor.getDescription() ) ) : "No description available."; + "\", DEFAULT_INDENT );" + LS );
writer.write( " sb.append( \"" + goal + "\" ).append( \"\\n\" );" + LS );
writer.write( " appendDescription( sb, \"" + description + "\", DEFAULT_INDENT );" + LS );
if ( descriptor.getParameters() != null && descriptor.getParameters().size() > 0 ) if ( descriptor.getParameters() != null && descriptor.getParameters().size() > 0 )
{ {
@ -403,8 +412,7 @@ public class PluginHelpGenerator
if ( expression == null || !expression.startsWith( "${component." ) ) if ( expression == null || !expression.startsWith( "${component." ) )
{ {
String parameterName = parameter.getName(); String parameterName = parameter.getName();
String parameterDescription = StringUtils.isNotEmpty( parameter.getDescription() ) ? String parameterDescription = toDescription( parameter.getDescription() );
StringUtils.escape( toText( parameter.getDescription() ) ) : "No description available.";
String parameterDefaultValue = parameterName String parameterDefaultValue = parameterName
+ ( StringUtils.isNotEmpty( parameter.getDefaultValue() ) ? " (Default: '" + ( StringUtils.isNotEmpty( parameter.getDefaultValue() ) ? " (Default: '"
+ parameter.getDefaultValue() + "')" : "" ); + parameter.getDefaultValue() + "')" : "" );
@ -500,15 +508,31 @@ public class PluginHelpGenerator
writer.write( " }" + LS ); writer.write( " }" + LS );
} }
/**
* Gets the effective string to use for the plugin/mojo/parameter description.
*
* @param description The description of the element, may be <code>null</code>.
* @return The effective description string, never <code>null</code>.
*/
private static String toDescription( String description )
{
if ( StringUtils.isNotEmpty( description ) )
{
return StringUtils.escape( toText( description ) );
}
else
{
return "(no description available)";
}
}
/** /**
* Remove HTML tags from a string * Remove HTML tags from a string
* *
* @param str * @param str
* @return a String with HTML tags into pure text * @return a String with HTML tags into pure text
* @throws IOException if any
*/ */
protected static String toText( String str ) protected static String toText( String str )
throws IOException
{ {
if ( StringUtils.isEmpty( str ) ) if ( StringUtils.isEmpty( str ) )
{ {
@ -555,7 +579,14 @@ public class PluginHelpGenerator
} }
}; };
try
{
parser.parse( new StringReader( PluginUtils.makeHtmlValid( str ) ), htmlCallback, true ); parser.parse( new StringReader( PluginUtils.makeHtmlValid( str ) ), htmlCallback, true );
}
catch ( IOException e )
{
throw new RuntimeException( e );
}
return StringUtils.replace( sb.toString(), "\"", "'" ); // for CDATA return StringUtils.replace( sb.toString(), "\"", "'" ); // for CDATA
} }