Details

    • Type: New Feature New Feature
    • Status: Closed
    • Priority: Major Major
    • Resolution: Auto Closed
    • Affects Version/s: 2.0-alpha-3
    • Fix Version/s: None
    • Component/s: Generator
    • Labels:
      None
    • Environment:
      windows xp sp2; java sun 1.6.0_07; maven 2.0.9

      Description

      Could we show a description of the requiredProperty to the user instead of their name at generator prompt?
      I think it could be more user friendly! I have to provide an extra readme.txt to explain how to use the requiredProperties.

        Activity

        Hide
        Michael Osipov added a comment -

        This issue has been auto closed because it has been inactive for a long period of time. If you think this issue still applies, retest your problem with the most recent version of Maven and the affected component, reopen and post your results.

        Show
        Michael Osipov added a comment - This issue has been auto closed because it has been inactive for a long period of time. If you think this issue still applies, retest your problem with the most recent version of Maven and the affected component, reopen and post your results.
        Hide
        Anthony Elder added a comment -

        An example of a property is:

        <requiredProperty key="includeTuscanyRuntime">
        <defaultValue>Y</defaultValue>
        </requiredProperty>

        https://svn.apache.org/repos/asf/tuscany/sca-java-2.x/trunk/maven/archetypes/quickstart/src/main/resources/META-INF/maven/archetype-metadata.xml

        You can run that architype with

        mvn archetype:generate -DarchetypeCatalog=http://tuscany.apache.org

        and choose archetype 3 and then it lets you set the values for the properties, one being includeTuscanyRuntime as defined above, but it just prompts as:

        Define value for property 'includeTuscanyRuntime': Y:

        Which isn't that descriptive and gives no help about what includeTuscanyRuntime means. The suggestion is to extend the requiredProperty definition to include a description saying what the property does, perhaps like this:

        <requiredProperty key="includeTuscanyRuntime">
        <defaultValue>Y</defaultValue>
        <description>Should the Tuscany runtime dependencies be included in the generated pom.xml?</description>
        </requiredProperty>

        and then have that description displayed when prompting for the property value. Or else perhaps don't show the description by default but support entering a question mark ? at the prompt which then causes the description to be shown.

        Thanks for looking anyway, fixing this JIRA and also http://jira.codehaus.org/browse/ARCHETYPE-308 would then have achetypes working in a much much more user friendly way.

        Show
        Anthony Elder added a comment - An example of a property is: <requiredProperty key="includeTuscanyRuntime"> <defaultValue>Y</defaultValue> </requiredProperty> https://svn.apache.org/repos/asf/tuscany/sca-java-2.x/trunk/maven/archetypes/quickstart/src/main/resources/META-INF/maven/archetype-metadata.xml You can run that architype with mvn archetype:generate -DarchetypeCatalog= http://tuscany.apache.org and choose archetype 3 and then it lets you set the values for the properties, one being includeTuscanyRuntime as defined above, but it just prompts as: Define value for property 'includeTuscanyRuntime': Y: Which isn't that descriptive and gives no help about what includeTuscanyRuntime means. The suggestion is to extend the requiredProperty definition to include a description saying what the property does, perhaps like this: <requiredProperty key="includeTuscanyRuntime"> <defaultValue>Y</defaultValue> <description>Should the Tuscany runtime dependencies be included in the generated pom.xml?</description> </requiredProperty> and then have that description displayed when prompting for the property value. Or else perhaps don't show the description by default but support entering a question mark ? at the prompt which then causes the description to be shown. Thanks for looking anyway, fixing this JIRA and also http://jira.codehaus.org/browse/ARCHETYPE-308 would then have achetypes working in a much much more user friendly way.
        Hide
        Hervé Boutemy added a comment -

        any suggestion?
        I didn't write the initial code, then I'm not sure I understand precisely the intent: any help appreciated

        Show
        Hervé Boutemy added a comment - any suggestion? I didn't write the initial code, then I'm not sure I understand precisely the intent: any help appreciated
        Hide
        Anthony Elder added a comment -

        +1, having a property description would be really useful

        Show
        Anthony Elder added a comment - +1, having a property description would be really useful

          People

          • Assignee:
            Unassigned
            Reporter:
            Marcelo Romulo Fernandes
          • Votes:
            8 Vote for this issue
            Watchers:
            10 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development