1 | |
package org.apache.maven.plugin.reactor; |
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-reactor-plugin:1.0", 0 ); |
68 | 0 | append( sb, "", 0 ); |
69 | |
|
70 | 0 | append( sb, "Maven Reactor Plugin 1.0", 0 ); |
71 | 0 | append( sb, "Build a subset of interdependent projects in a reactor", 1 ); |
72 | 0 | append( sb, "", 0 ); |
73 | |
|
74 | 0 | if ( goal == null || goal.length() <= 0 ) |
75 | |
{ |
76 | 0 | append( sb, "This plugin has 5 goals:", 0 ); |
77 | 0 | append( sb, "", 0 ); |
78 | |
} |
79 | |
|
80 | 0 | if ( goal == null || goal.length() <= 0 || "help".equals( goal ) ) |
81 | |
{ |
82 | 0 | append( sb, "reactor:help", 0 ); |
83 | 0 | append( sb, "Display help information on maven-reactor-plugin.\nCall\n\u00a0\u00a0mvn\u00a0reactor:help\u00a0-Ddetail=true\u00a0-Dgoal=<goal-name>\nto display parameter details.", 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, "detail (Default: false)", 2 ); |
91 | 0 | append( sb, "If true, display all settable properties for each goal.", 3 ); |
92 | 0 | append( sb, "", 0 ); |
93 | |
|
94 | 0 | append( sb, "goal", 2 ); |
95 | 0 | append( sb, "The name of the goal for which to show help. If unspecified, all goals will be displayed.", 3 ); |
96 | 0 | append( sb, "", 0 ); |
97 | |
|
98 | 0 | append( sb, "lineLength (Default: 80)", 2 ); |
99 | 0 | append( sb, "The maximum length of a display line, should be positive.", 3 ); |
100 | 0 | append( sb, "", 0 ); |
101 | |
|
102 | 0 | append( sb, "indentSize (Default: 2)", 2 ); |
103 | 0 | append( sb, "The number of spaces per indentation level, should be positive.", 3 ); |
104 | 0 | append( sb, "", 0 ); |
105 | |
} |
106 | |
} |
107 | |
|
108 | 0 | if ( goal == null || goal.length() <= 0 || "make".equals( goal ) ) |
109 | |
{ |
110 | 0 | append( sb, "reactor:make", 0 ); |
111 | 0 | append( sb, "Goal to build a project X and all of the reactor projects on which X depends", 1 ); |
112 | 0 | append( sb, "", 0 ); |
113 | 0 | if ( detail ) |
114 | |
{ |
115 | 0 | append( sb, "Available parameters:", 1 ); |
116 | 0 | append( sb, "", 0 ); |
117 | |
|
118 | 0 | append( sb, "artifactList", 2 ); |
119 | 0 | append( sb, "A list of artifacts to build, e.g. \'com.mycompany:bar,com.mycompany:foo\' or just \'foo,bar\', or just \'foo\'", 3 ); |
120 | 0 | append( sb, "", 0 ); |
121 | |
|
122 | 0 | append( sb, "baseDir", 2 ); |
123 | 0 | append( sb, "Location of the POM file; provided by Maven", 3 ); |
124 | 0 | append( sb, "", 0 ); |
125 | |
|
126 | 0 | append( sb, "collectedProjects", 2 ); |
127 | 0 | append( sb, "A list of every project in this reactor; provided by Maven", 3 ); |
128 | 0 | append( sb, "", 0 ); |
129 | |
|
130 | 0 | append( sb, "continueFromFolder", 2 ); |
131 | 0 | append( sb, "The project folder from which we\'ll resume", 3 ); |
132 | 0 | append( sb, "", 0 ); |
133 | |
|
134 | 0 | append( sb, "continueFromProject", 2 ); |
135 | 0 | append( sb, "The artifact from which we\'ll resume, e.g. \'com.mycompany:foo\' or just \'foo\'", 3 ); |
136 | 0 | append( sb, "", 0 ); |
137 | |
|
138 | 0 | append( sb, "defaultGroup (Default: ${project.groupId})", 2 ); |
139 | 0 | append( sb, "If you don\'t specify a groupId in your artifactList, we\'ll use this as the default groupId.", 3 ); |
140 | 0 | append( sb, "", 0 ); |
141 | |
|
142 | 0 | append( sb, "folderList", 2 ); |
143 | 0 | append( sb, "A list of relative paths to build, e.g. \'foo,baz/bar\'", 3 ); |
144 | 0 | append( sb, "", 0 ); |
145 | |
|
146 | 0 | append( sb, "goals (Default: install)", 2 ); |
147 | 0 | append( sb, "Goals to run on subproject.", 3 ); |
148 | 0 | append( sb, "", 0 ); |
149 | |
|
150 | 0 | append( sb, "printOnly", 2 ); |
151 | 0 | append( sb, "Don\'t really do anything; just print a command that describes what the command would have done", 3 ); |
152 | 0 | append( sb, "", 0 ); |
153 | |
} |
154 | |
} |
155 | |
|
156 | 0 | if ( goal == null || goal.length() <= 0 || "make-dependents".equals( goal ) ) |
157 | |
{ |
158 | 0 | append( sb, "reactor:make-dependents", 0 ); |
159 | 0 | append( sb, "Goal to build a project X and all of the reactor projects that depend on X", 1 ); |
160 | 0 | append( sb, "", 0 ); |
161 | 0 | if ( detail ) |
162 | |
{ |
163 | 0 | append( sb, "Available parameters:", 1 ); |
164 | 0 | append( sb, "", 0 ); |
165 | |
|
166 | 0 | append( sb, "artifactList", 2 ); |
167 | 0 | append( sb, "A list of artifacts to build, e.g. \'com.mycompany:bar,com.mycompany:foo\' or just \'foo,bar\', or just \'foo\'", 3 ); |
168 | 0 | append( sb, "", 0 ); |
169 | |
|
170 | 0 | append( sb, "baseDir", 2 ); |
171 | 0 | append( sb, "Location of the POM file; provided by Maven", 3 ); |
172 | 0 | append( sb, "", 0 ); |
173 | |
|
174 | 0 | append( sb, "collectedProjects", 2 ); |
175 | 0 | append( sb, "A list of every project in this reactor; provided by Maven", 3 ); |
176 | 0 | append( sb, "", 0 ); |
177 | |
|
178 | 0 | append( sb, "continueFromFolder", 2 ); |
179 | 0 | append( sb, "The project folder from which we\'ll resume", 3 ); |
180 | 0 | append( sb, "", 0 ); |
181 | |
|
182 | 0 | append( sb, "continueFromProject", 2 ); |
183 | 0 | append( sb, "The artifact from which we\'ll resume, e.g. \'com.mycompany:foo\' or just \'foo\'", 3 ); |
184 | 0 | append( sb, "", 0 ); |
185 | |
|
186 | 0 | append( sb, "defaultGroup (Default: ${project.groupId})", 2 ); |
187 | 0 | append( sb, "If you don\'t specify a groupId in your artifactList, we\'ll use this as the default groupId.", 3 ); |
188 | 0 | append( sb, "", 0 ); |
189 | |
|
190 | 0 | append( sb, "folderList", 2 ); |
191 | 0 | append( sb, "A list of relative paths to build, e.g. \'foo,baz/bar\'", 3 ); |
192 | 0 | append( sb, "", 0 ); |
193 | |
|
194 | 0 | append( sb, "goals (Default: install)", 2 ); |
195 | 0 | append( sb, "Goals to run on subproject.", 3 ); |
196 | 0 | append( sb, "", 0 ); |
197 | |
|
198 | 0 | append( sb, "printOnly", 2 ); |
199 | 0 | append( sb, "Don\'t really do anything; just print a command that describes what the command would have done", 3 ); |
200 | 0 | append( sb, "", 0 ); |
201 | |
} |
202 | |
} |
203 | |
|
204 | 0 | if ( goal == null || goal.length() <= 0 || "make-scm-changes".equals( goal ) ) |
205 | |
{ |
206 | 0 | append( sb, "reactor:make-scm-changes", 0 ); |
207 | 0 | append( sb, "Goal to build all projects that you personally have changed (according to SCM)", 1 ); |
208 | 0 | append( sb, "", 0 ); |
209 | 0 | if ( detail ) |
210 | |
{ |
211 | 0 | append( sb, "Available parameters:", 1 ); |
212 | 0 | append( sb, "", 0 ); |
213 | |
|
214 | 0 | append( sb, "artifactList", 2 ); |
215 | 0 | append( sb, "A list of artifacts to build, e.g. \'com.mycompany:bar,com.mycompany:foo\' or just \'foo,bar\', or just \'foo\'", 3 ); |
216 | 0 | append( sb, "", 0 ); |
217 | |
|
218 | 0 | append( sb, "baseDir", 2 ); |
219 | 0 | append( sb, "Location of the POM file; provided by Maven", 3 ); |
220 | 0 | append( sb, "", 0 ); |
221 | |
|
222 | 0 | append( sb, "collectedProjects", 2 ); |
223 | 0 | append( sb, "A list of every project in this reactor; provided by Maven", 3 ); |
224 | 0 | append( sb, "", 0 ); |
225 | |
|
226 | 0 | append( sb, "continueFromFolder", 2 ); |
227 | 0 | append( sb, "The project folder from which we\'ll resume", 3 ); |
228 | 0 | append( sb, "", 0 ); |
229 | |
|
230 | 0 | append( sb, "continueFromProject", 2 ); |
231 | 0 | append( sb, "The artifact from which we\'ll resume, e.g. \'com.mycompany:foo\' or just \'foo\'", 3 ); |
232 | 0 | append( sb, "", 0 ); |
233 | |
|
234 | 0 | append( sb, "defaultGroup (Default: ${project.groupId})", 2 ); |
235 | 0 | append( sb, "If you don\'t specify a groupId in your artifactList, we\'ll use this as the default groupId.", 3 ); |
236 | 0 | append( sb, "", 0 ); |
237 | |
|
238 | 0 | append( sb, "folderList", 2 ); |
239 | 0 | append( sb, "A list of relative paths to build, e.g. \'foo,baz/bar\'", 3 ); |
240 | 0 | append( sb, "", 0 ); |
241 | |
|
242 | 0 | append( sb, "goals (Default: install)", 2 ); |
243 | 0 | append( sb, "Goals to run on subproject.", 3 ); |
244 | 0 | append( sb, "", 0 ); |
245 | |
|
246 | 0 | append( sb, "ignoreUnknown (Default: true)", 2 ); |
247 | 0 | append( sb, "Ignore files in the \'unknown\' status (created but not added to source control)", 3 ); |
248 | 0 | append( sb, "", 0 ); |
249 | |
|
250 | 0 | append( sb, "printOnly", 2 ); |
251 | 0 | append( sb, "Don\'t really do anything; just print a command that describes what the command would have done", 3 ); |
252 | 0 | append( sb, "", 0 ); |
253 | |
|
254 | 0 | append( sb, "scmConnection (Default: ${project.scm.connection})", 2 ); |
255 | 0 | append( sb, "The SCM connection/provider info. Should be specified in your POM.", 3 ); |
256 | 0 | append( sb, "", 0 ); |
257 | |
} |
258 | |
} |
259 | |
|
260 | 0 | if ( goal == null || goal.length() <= 0 || "resume".equals( goal ) ) |
261 | |
{ |
262 | 0 | append( sb, "reactor:resume", 0 ); |
263 | 0 | append( sb, "Goal to resume building a reactor at a certain point", 1 ); |
264 | 0 | append( sb, "", 0 ); |
265 | 0 | if ( detail ) |
266 | |
{ |
267 | 0 | append( sb, "Available parameters:", 1 ); |
268 | 0 | append( sb, "", 0 ); |
269 | |
|
270 | 0 | append( sb, "baseDir", 2 ); |
271 | 0 | append( sb, "Location of the file.", 3 ); |
272 | 0 | append( sb, "", 0 ); |
273 | |
|
274 | 0 | append( sb, "collectedProjects", 2 ); |
275 | 0 | append( sb, "(no description available)", 3 ); |
276 | 0 | append( sb, "", 0 ); |
277 | |
|
278 | 0 | append( sb, "continueFromFolder (Default: null)", 2 ); |
279 | 0 | append( sb, "The project folder from which we\'ll resume", 3 ); |
280 | 0 | append( sb, "", 0 ); |
281 | |
|
282 | 0 | append( sb, "continueFromGroup (Default: ${project.groupId})", 2 ); |
283 | 0 | append( sb, "(no description available)", 3 ); |
284 | 0 | append( sb, "", 0 ); |
285 | |
|
286 | 0 | append( sb, "continueFromProject (Default: null)", 2 ); |
287 | 0 | append( sb, "The artifact from which we\'ll resume, e.g. \'com.mycompany:foo\' or just \'foo\'", 3 ); |
288 | 0 | append( sb, "", 0 ); |
289 | |
|
290 | 0 | append( sb, "goals (Default: install)", 2 ); |
291 | 0 | append( sb, "Goals to run on subproject", 3 ); |
292 | 0 | append( sb, "", 0 ); |
293 | |
|
294 | 0 | append( sb, "printOnly", 2 ); |
295 | 0 | append( sb, "Don\'t really do anything; just print a message that describes what the command would have done", 3 ); |
296 | 0 | append( sb, "", 0 ); |
297 | |
} |
298 | |
} |
299 | |
|
300 | 0 | if ( getLog().isInfoEnabled() ) |
301 | |
{ |
302 | 0 | getLog().info( sb.toString() ); |
303 | |
} |
304 | 0 | } |
305 | |
|
306 | |
|
307 | |
|
308 | |
|
309 | |
|
310 | |
|
311 | |
|
312 | |
|
313 | |
|
314 | |
|
315 | |
private static String repeat( String str, int repeat ) |
316 | |
{ |
317 | 0 | StringBuffer buffer = new StringBuffer( repeat * str.length() ); |
318 | |
|
319 | 0 | for ( int i = 0; i < repeat; i++ ) |
320 | |
{ |
321 | 0 | buffer.append( str ); |
322 | |
} |
323 | |
|
324 | 0 | return buffer.toString(); |
325 | |
} |
326 | |
|
327 | |
|
328 | |
|
329 | |
|
330 | |
|
331 | |
|
332 | |
|
333 | |
|
334 | |
|
335 | |
private void append( StringBuffer sb, String description, int indent ) |
336 | |
{ |
337 | 0 | for ( Iterator it = toLines( description, indent, indentSize, lineLength ).iterator(); it.hasNext(); ) |
338 | |
{ |
339 | 0 | sb.append( it.next().toString() ).append( '\n' ); |
340 | |
} |
341 | 0 | } |
342 | |
|
343 | |
|
344 | |
|
345 | |
|
346 | |
|
347 | |
|
348 | |
|
349 | |
|
350 | |
|
351 | |
|
352 | |
|
353 | |
private static List toLines( String text, int indent, int indentSize, int lineLength ) |
354 | |
{ |
355 | 0 | List lines = new ArrayList(); |
356 | |
|
357 | 0 | String ind = repeat( "\t", indent ); |
358 | 0 | String[] plainLines = text.split( "(\r\n)|(\r)|(\n)" ); |
359 | 0 | for ( int i = 0; i < plainLines.length; i++ ) |
360 | |
{ |
361 | 0 | toLines( lines, ind + plainLines[i], indentSize, lineLength ); |
362 | |
} |
363 | |
|
364 | 0 | return lines; |
365 | |
} |
366 | |
|
367 | |
|
368 | |
|
369 | |
|
370 | |
|
371 | |
|
372 | |
|
373 | |
|
374 | |
|
375 | |
private static void toLines( List lines, String line, int indentSize, int lineLength ) |
376 | |
{ |
377 | 0 | int lineIndent = getIndentLevel( line ); |
378 | 0 | StringBuffer buf = new StringBuffer( 256 ); |
379 | 0 | String[] tokens = line.split( " +" ); |
380 | 0 | for ( int i = 0; i < tokens.length; i++ ) |
381 | |
{ |
382 | 0 | String token = tokens[i]; |
383 | 0 | if ( i > 0 ) |
384 | |
{ |
385 | 0 | if ( buf.length() + token.length() >= lineLength ) |
386 | |
{ |
387 | 0 | lines.add( buf.toString() ); |
388 | 0 | buf.setLength( 0 ); |
389 | 0 | buf.append( repeat( " ", lineIndent * indentSize ) ); |
390 | |
} |
391 | |
else |
392 | |
{ |
393 | 0 | buf.append( ' ' ); |
394 | |
} |
395 | |
} |
396 | 0 | for ( int j = 0; j < token.length(); j++ ) |
397 | |
{ |
398 | 0 | char c = token.charAt( j ); |
399 | 0 | if ( c == '\t' ) |
400 | |
{ |
401 | 0 | buf.append( repeat( " ", indentSize - buf.length() % indentSize ) ); |
402 | |
} |
403 | 0 | else if ( c == '\u00A0' ) |
404 | |
{ |
405 | 0 | buf.append( ' ' ); |
406 | |
} |
407 | |
else |
408 | |
{ |
409 | 0 | buf.append( c ); |
410 | |
} |
411 | |
} |
412 | |
} |
413 | 0 | lines.add( buf.toString() ); |
414 | 0 | } |
415 | |
|
416 | |
|
417 | |
|
418 | |
|
419 | |
|
420 | |
|
421 | |
|
422 | |
private static int getIndentLevel( String line ) |
423 | |
{ |
424 | 0 | int level = 0; |
425 | 0 | for ( int i = 0; i < line.length() && line.charAt( i ) == '\t'; i++ ) |
426 | |
{ |
427 | 0 | level++; |
428 | |
} |
429 | 0 | for ( int i = level + 1; i <= level + 4 && i < line.length(); i++ ) |
430 | |
{ |
431 | 0 | if ( line.charAt( i ) == '\t' ) |
432 | |
{ |
433 | 0 | level++; |
434 | 0 | break; |
435 | |
} |
436 | |
} |
437 | 0 | return level; |
438 | |
} |
439 | |
} |