Details

    • Type: New Feature New Feature
    • Status: Open Open
    • Priority: Major Major
    • Resolution: Unresolved
    • Affects Version/s: 2.0-alpha-3
    • Fix Version/s: 2.x
    • Component/s: Generator
    • Labels:
      None
    • Environment:
      windows xp sp2; java sun 1.6.0_07; maven 2.0.9
    • Number of attachments :
      0

      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
        ant elder added a comment -

        +1, having a property description would be really useful

        Show
        ant elder added a comment - +1, having a property description would be really useful
        Hide
        Herve 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
        Herve 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
        ant 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
        ant 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.

          People

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

            Dates

            • Created:
              Updated: