1 | |
package org.apache.maven.plugin.doap; |
2 | |
|
3 | |
import java.util.ArrayList; |
4 | |
import java.util.Iterator; |
5 | |
import java.util.List; |
6 | |
|
7 | |
import org.apache.maven.plugin.AbstractMojo; |
8 | |
import org.apache.maven.plugin.MojoExecutionException; |
9 | |
|
10 | |
|
11 | |
|
12 | |
|
13 | |
|
14 | |
|
15 | |
|
16 | |
|
17 | |
|
18 | 0 | public class HelpMojo |
19 | |
extends AbstractMojo |
20 | |
{ |
21 | |
|
22 | |
|
23 | |
|
24 | |
|
25 | |
|
26 | |
private boolean detail; |
27 | |
|
28 | |
|
29 | |
|
30 | |
|
31 | |
|
32 | |
|
33 | |
private java.lang.String goal; |
34 | |
|
35 | |
|
36 | |
|
37 | |
|
38 | |
|
39 | |
|
40 | |
private int lineLength; |
41 | |
|
42 | |
|
43 | |
|
44 | |
|
45 | |
|
46 | |
|
47 | |
private int indentSize; |
48 | |
|
49 | |
|
50 | |
|
51 | |
public void execute() |
52 | |
throws MojoExecutionException |
53 | |
{ |
54 | 0 | if ( lineLength <= 0 ) |
55 | |
{ |
56 | 0 | getLog().warn( "The parameter 'lineLength' should be positive, using '80' as default." ); |
57 | 0 | lineLength = 80; |
58 | |
} |
59 | 0 | if ( indentSize <= 0 ) |
60 | |
{ |
61 | 0 | getLog().warn( "The parameter 'indentSize' should be positive, using '2' as default." ); |
62 | 0 | indentSize = 2; |
63 | |
} |
64 | |
|
65 | 0 | StringBuffer sb = new StringBuffer(); |
66 | |
|
67 | 0 | append( sb, "org.apache.maven.plugins:maven-doap-plugin:1.1", 0 ); |
68 | 0 | append( sb, "", 0 ); |
69 | |
|
70 | 0 | append( sb, "Maven DOAP Plugin", 0 ); |
71 | 0 | append( sb, "Plugins which generate a DOAP file from information in a POM.", 1 ); |
72 | 0 | append( sb, "", 0 ); |
73 | |
|
74 | 0 | if ( goal == null || goal.length() <= 0 ) |
75 | |
{ |
76 | 0 | append( sb, "This plugin has 2 goals:", 0 ); |
77 | 0 | append( sb, "", 0 ); |
78 | |
} |
79 | |
|
80 | 0 | if ( goal == null || goal.length() <= 0 || "generate".equals( goal ) ) |
81 | |
{ |
82 | 0 | append( sb, "doap:generate", 0 ); |
83 | 0 | append( sb, "Generate a Description of a Project (DOAP) file from the main information found in a POM.\nNote: The generated file is tailored for use by projects at Apache.", 1 ); |
84 | 0 | append( sb, "", 0 ); |
85 | 0 | if ( detail ) |
86 | |
{ |
87 | 0 | append( sb, "Available parameters:", 1 ); |
88 | 0 | append( sb, "", 0 ); |
89 | |
|
90 | 0 | append( sb, "about (Default: ${project.url})", 2 ); |
91 | 0 | append( sb, "The about URI-reference which should be displayed in the DOAP file. Example:\n<rdf:RDF>\n\u00a0\u00a0<Project\u00a0rdf:about=\'http://maven.apache.org/\'>\n\u00a0\u00a0...\n\u00a0\u00a0</Project>\n</rdf:RDF>\nSee http://www.w3.org/TR/1999/REC-rdf-syntax-19990222/#aboutAttr\n", 3 ); |
92 | 0 | append( sb, "", 0 ); |
93 | |
|
94 | 0 | append( sb, "artifact", 2 ); |
95 | 0 | append( sb, "An artifact to generate the DOAP file against.\nExample:\n<artifact>\n\u00a0\u00a0<groupId>given-artifact-groupId</groupId>\n\u00a0\u00a0<artifactId>given-artifact-artifactId</artifactId>\n\u00a0\u00a0<version>given-artifact-version</version>\n</artifact>\n\nSee Javadoc\n", 3 ); |
96 | 0 | append( sb, "", 0 ); |
97 | |
|
98 | 0 | append( sb, "asfExtOptions", 2 ); |
99 | 0 | append( sb, "Specific ASF extensions parameters, i.e. options that POM doesn\'t have any notions but required by ASF DOAP requirements.\nExample:\n<asfExtOptions>\n\u00a0\u00a0<included>true</included>\n\u00a0\u00a0<charter>The\u00a0mission\u00a0of\u00a0the\u00a0Apache\u00a0XXX\u00a0project\u00a0is\u00a0to\u00a0create\u00a0and\u00a0maintain\u00a0software\n\u00a0\u00a0libraries\u00a0that\u00a0provide\u00a0...</charter>\n\u00a0\u00a0...\n</asfExtOptions>\nNote: By default, <asfExtOptions><included/></asfExtOptions> will be automatically set to true if the project is hosted at ASF.\nSee Javadoc\n", 3 ); |
100 | 0 | append( sb, "", 0 ); |
101 | |
|
102 | 0 | append( sb, "category", 2 ); |
103 | 0 | append( sb, "Deprecated. Since 1.0. Instead of, configure <doapOptions><category/></doapOptions> parameter.", 3 ); |
104 | 0 | append( sb, "", 0 ); |
105 | 0 | append( sb, "The category which should be displayed in the DOAP file.", 3 ); |
106 | 0 | append( sb, "", 0 ); |
107 | |
|
108 | 0 | append( sb, "doapFile (Default: doap_${project.artifactId}.rdf)", 2 ); |
109 | 0 | append( sb, "The name of the DOAP file that will be generated.", 3 ); |
110 | 0 | append( sb, "", 0 ); |
111 | |
|
112 | 0 | append( sb, "doapOptions", 2 ); |
113 | 0 | append( sb, "Specific DOAP parameters, i.e. options that POM doesn\'t have any notions.\nExample:\n<doapOptions>\n\u00a0\u00a0<programmingLanguage>java</programmingLanguage>\n</doapOptions>\n\nSee Javadoc\n", 3 ); |
114 | 0 | append( sb, "", 0 ); |
115 | |
|
116 | 0 | append( sb, "extOptions", 2 ); |
117 | 0 | append( sb, "Extensions parameters.\nExample:\n<extOptions>\n\u00a0<extOption>\n\u00a0\u00a0\u00a0<xmlnsPrefix>labs</xmlnsPrefix>\n\u00a0\u00a0\u00a0<xmlnsNamespaceURI>http://labs.apache.org/doap-ext/1.0#</xmlnsNamespaceURI>\n\u00a0\u00a0\u00a0<extensions>\n\u00a0\u00a0\u00a0\u00a0<status>active</status>\n\u00a0\u00a0\u00a0</extensions>\n\u00a0</extOption>\n</extOptions>\nSee Javadoc\n", 3 ); |
118 | 0 | append( sb, "", 0 ); |
119 | |
|
120 | 0 | append( sb, "lang (Default: en)", 2 ); |
121 | 0 | append( sb, "The value for the xml:lang attribute used by the <rdf:RDF/>, <description/> and <shortdesc/> elements.\nPOM doesn\'t have any notions about language.\nSee http://www.w3.org/TR/REC-xml/#sec-lang-tag\n", 3 ); |
122 | 0 | append( sb, "", 0 ); |
123 | |
|
124 | 0 | append( sb, "language", 2 ); |
125 | 0 | append( sb, "Deprecated. Since 1.0. Instead of, configure <doapOptions><programmingLanguage/></doapOptions> parameter.", 3 ); |
126 | 0 | append( sb, "", 0 ); |
127 | 0 | append( sb, "The programming language which should be displayed in the DOAP file.", 3 ); |
128 | 0 | append( sb, "", 0 ); |
129 | |
|
130 | 0 | append( sb, "outputDirectory (Default: ${project.reporting.outputDirectory})", 2 ); |
131 | 0 | append( sb, "The output directory of the DOAP file that will be generated.", 3 ); |
132 | 0 | append( sb, "", 0 ); |
133 | |
|
134 | 0 | append( sb, "skip (Default: false)", 2 ); |
135 | 0 | append( sb, "Specifies whether the DOAP generation should be skipped.", 3 ); |
136 | 0 | append( sb, "", 0 ); |
137 | |
|
138 | 0 | append( sb, "validate (Default: true)", 2 ); |
139 | 0 | append( sb, "Flag to validate the generated DOAP.", 3 ); |
140 | 0 | append( sb, "", 0 ); |
141 | |
} |
142 | |
} |
143 | |
|
144 | 0 | if ( goal == null || goal.length() <= 0 || "help".equals( goal ) ) |
145 | |
{ |
146 | 0 | append( sb, "doap:help", 0 ); |
147 | 0 | append( sb, "Display help information on maven-doap-plugin.\nCall\n\u00a0\u00a0mvn\u00a0doap:help\u00a0-Ddetail=true\u00a0-Dgoal=<goal-name>\nto display parameter details.", 1 ); |
148 | 0 | append( sb, "", 0 ); |
149 | 0 | if ( detail ) |
150 | |
{ |
151 | 0 | append( sb, "Available parameters:", 1 ); |
152 | 0 | append( sb, "", 0 ); |
153 | |
|
154 | 0 | append( sb, "detail (Default: false)", 2 ); |
155 | 0 | append( sb, "If true, display all settable properties for each goal.", 3 ); |
156 | 0 | append( sb, "", 0 ); |
157 | |
|
158 | 0 | append( sb, "goal", 2 ); |
159 | 0 | append( sb, "The name of the goal for which to show help. If unspecified, all goals will be displayed.", 3 ); |
160 | 0 | append( sb, "", 0 ); |
161 | |
|
162 | 0 | append( sb, "indentSize (Default: 2)", 2 ); |
163 | 0 | append( sb, "The number of spaces per indentation level, should be positive.", 3 ); |
164 | 0 | append( sb, "", 0 ); |
165 | |
|
166 | 0 | append( sb, "lineLength (Default: 80)", 2 ); |
167 | 0 | append( sb, "The maximum length of a display line, should be positive.", 3 ); |
168 | 0 | append( sb, "", 0 ); |
169 | |
} |
170 | |
} |
171 | |
|
172 | 0 | if ( getLog().isInfoEnabled() ) |
173 | |
{ |
174 | 0 | getLog().info( sb.toString() ); |
175 | |
} |
176 | 0 | } |
177 | |
|
178 | |
|
179 | |
|
180 | |
|
181 | |
|
182 | |
|
183 | |
|
184 | |
|
185 | |
|
186 | |
|
187 | |
private static String repeat( String str, int repeat ) |
188 | |
{ |
189 | 0 | StringBuffer buffer = new StringBuffer( repeat * str.length() ); |
190 | |
|
191 | 0 | for ( int i = 0; i < repeat; i++ ) |
192 | |
{ |
193 | 0 | buffer.append( str ); |
194 | |
} |
195 | |
|
196 | 0 | return buffer.toString(); |
197 | |
} |
198 | |
|
199 | |
|
200 | |
|
201 | |
|
202 | |
|
203 | |
|
204 | |
|
205 | |
|
206 | |
|
207 | |
private void append( StringBuffer sb, String description, int indent ) |
208 | |
{ |
209 | 0 | for ( Iterator it = toLines( description, indent, indentSize, lineLength ).iterator(); it.hasNext(); ) |
210 | |
{ |
211 | 0 | sb.append( it.next().toString() ).append( '\n' ); |
212 | |
} |
213 | 0 | } |
214 | |
|
215 | |
|
216 | |
|
217 | |
|
218 | |
|
219 | |
|
220 | |
|
221 | |
|
222 | |
|
223 | |
|
224 | |
|
225 | |
private static List toLines( String text, int indent, int indentSize, int lineLength ) |
226 | |
{ |
227 | 0 | List lines = new ArrayList(); |
228 | |
|
229 | 0 | String ind = repeat( "\t", indent ); |
230 | 0 | String[] plainLines = text.split( "(\r\n)|(\r)|(\n)" ); |
231 | 0 | for ( int i = 0; i < plainLines.length; i++ ) |
232 | |
{ |
233 | 0 | toLines( lines, ind + plainLines[i], indentSize, lineLength ); |
234 | |
} |
235 | |
|
236 | 0 | return lines; |
237 | |
} |
238 | |
|
239 | |
|
240 | |
|
241 | |
|
242 | |
|
243 | |
|
244 | |
|
245 | |
|
246 | |
|
247 | |
private static void toLines( List lines, String line, int indentSize, int lineLength ) |
248 | |
{ |
249 | 0 | int lineIndent = getIndentLevel( line ); |
250 | 0 | StringBuffer buf = new StringBuffer( 256 ); |
251 | 0 | String[] tokens = line.split( " +" ); |
252 | 0 | for ( int i = 0; i < tokens.length; i++ ) |
253 | |
{ |
254 | 0 | String token = tokens[i]; |
255 | 0 | if ( i > 0 ) |
256 | |
{ |
257 | 0 | if ( buf.length() + token.length() >= lineLength ) |
258 | |
{ |
259 | 0 | lines.add( buf.toString() ); |
260 | 0 | buf.setLength( 0 ); |
261 | 0 | buf.append( repeat( " ", lineIndent * indentSize ) ); |
262 | |
} |
263 | |
else |
264 | |
{ |
265 | 0 | buf.append( ' ' ); |
266 | |
} |
267 | |
} |
268 | 0 | for ( int j = 0; j < token.length(); j++ ) |
269 | |
{ |
270 | 0 | char c = token.charAt( j ); |
271 | 0 | if ( c == '\t' ) |
272 | |
{ |
273 | 0 | buf.append( repeat( " ", indentSize - buf.length() % indentSize ) ); |
274 | |
} |
275 | 0 | else if ( c == '\u00A0' ) |
276 | |
{ |
277 | 0 | buf.append( ' ' ); |
278 | |
} |
279 | |
else |
280 | |
{ |
281 | 0 | buf.append( c ); |
282 | |
} |
283 | |
} |
284 | |
} |
285 | 0 | lines.add( buf.toString() ); |
286 | 0 | } |
287 | |
|
288 | |
|
289 | |
|
290 | |
|
291 | |
|
292 | |
|
293 | |
|
294 | |
private static int getIndentLevel( String line ) |
295 | |
{ |
296 | 0 | int level = 0; |
297 | 0 | for ( int i = 0; i < line.length() && line.charAt( i ) == '\t'; i++ ) |
298 | |
{ |
299 | 0 | level++; |
300 | |
} |
301 | 0 | for ( int i = level + 1; i <= level + 4 && i < line.length(); i++ ) |
302 | |
{ |
303 | 0 | if ( line.charAt( i ) == '\t' ) |
304 | |
{ |
305 | 0 | level++; |
306 | 0 | break; |
307 | |
} |
308 | |
} |
309 | 0 | return level; |
310 | |
} |
311 | |
} |