Maven Help Plugin
  1. Maven Help Plugin
  2. MPH-26

New goal help:help to provide help on how to use helper plugins in maven

    Details

    • Type: Improvement Improvement
    • Status: Closed Closed
    • Priority: Major Major
    • Resolution: Won't Fix
    • Affects Version/s: 2.0
    • Fix Version/s: 2.1
    • Component/s: None
    • Labels:
      None
    • Number of attachments :
      0

      Description

      It is almost impossible to remember the usage of the helper utility plugins in maven. Every single time I have problems with transient dependencies I end up searching google for "maven help plugin" and "maven dependency plugin". That is not good enough.

      The help plugin should have a goal called help, describing the usage of the plugin. This would make help (or, rather, a bootstrap on how to use the help system) available under the obvious command "mvn help:help". This goal could also hint about the existence of the dependency plugin, since many of the difficult problems when using maven are related to complex transitive dependencies.

      The command "mvn -help" should also describe the use of the maven-help-plugin, but I will create a separate issue in the maven core module for that.

        Issue Links

          Activity

          Hide
          Barend Garvelink added a comment -

          I completely agree with Eirik that the help plugin is too difficult to use. I'd like to venture a bit further; I think the goal shouldn't be any less than the ability to run

           
          >mvn help maven-dependency-plugin    #plugin artifactId
          
          
          >mvn help compiler                   #plugin prefix
          
          
          >mvn help                            #displays syntax for the above
          

          Where plugins from both org.apache.maven.plugins and org.codehaus.mojo should be accepted without specifying groupId. I suspect that this can be implemented in a fairly clean manner by introducing a help lifecycle; a launcher tweak may be required to infer -Dplugin= for the second parameter. I think that's an acceptable price to pay.

          I also agree with Andrea's comment in MPH-15 that the -Dfull=true output is a bit verbose, and I think the normal output is too terse. I think the correct level of default verbosity would be to render a console version of the first three sections (intro, required parameters, optional parameters) of the "xxxxx-mojo.html" pages in any plugin site (e.g.). The -Dfull=true parameter can remain supported in its current form.

          Finally, an outputXML parameter as seen in the analysis mojos of the maven-dependency-plugin would be invaluable.

          Show
          Barend Garvelink added a comment - I completely agree with Eirik that the help plugin is too difficult to use. I'd like to venture a bit further; I think the goal shouldn't be any less than the ability to run >mvn help maven-dependency-plugin #plugin artifactId >mvn help compiler #plugin prefix >mvn help #displays syntax for the above Where plugins from both org.apache.maven.plugins and org.codehaus.mojo should be accepted without specifying groupId. I suspect that this can be implemented in a fairly clean manner by introducing a help lifecycle; a launcher tweak may be required to infer -Dplugin= for the second parameter. I think that's an acceptable price to pay. I also agree with Andrea's comment in MPH-15 that the -Dfull=true output is a bit verbose, and I think the normal output is too terse. I think the correct level of default verbosity would be to render a console version of the first three sections (intro, required parameters, optional parameters) of the "xxxxx-mojo.html" pages in any plugin site ( e.g. ). The -Dfull=true parameter can remain supported in its current form. Finally, an outputXML parameter as seen in the analysis mojos of the maven-dependency-plugin would be invaluable.
          Hide
          Vincent Siveton added a comment -

          Should be done by the maven-plugin-plugin
          mvn help:help will display

          ...
          [INFO] [help:help]
          [INFO] The 'org.apache.maven.plugins:maven-help-plugin' plugin has 9 goals:
          
          help:active-profiles
            Lists the profiles which are currently active for this build.
          
          help:system
            Lists the platform details like system properties and environment variables.
          ...
          

          Also MPH-30 could help you.

          Show
          Vincent Siveton added a comment - Should be done by the maven-plugin-plugin mvn help:help will display ... [INFO] [help:help] [INFO] The 'org.apache.maven.plugins:maven-help-plugin' plugin has 9 goals: help:active-profiles Lists the profiles which are currently active for this build. help:system Lists the platform details like system properties and environment variables. ... Also MPH-30 could help you.

            People

            • Assignee:
              Unassigned
              Reporter:
              Eirik Maus
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: