Spring Roo
  1. Spring Roo
  2. ROO-232

Modification of Roo commands to enhance usability and consistency between add-ons

    Details

    • Type: Improvement Improvement
    • Status: Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: 1.0.0.A1, 1.0.0.A2, 1.0.0.M1, 1.0.0.M2, 1.0.0.RC1
    • Fix Version/s: 1.0.0.RC2
    • Component/s: @ ROO SHELL
    • Labels:
      None

      Description

      Roo's current command names have evolved over a lengthy period. New add-ons have been created and existing add-ons have addressed additional requirements. In addition, a wider audience of people have tried Roo and reported their experience in learning commands and intuitively understanding what the present commands mean. Invariably this evolution has resulted in a better understanding of usage patterns and provides considerable scope for revisiting the existing command names and improving them for consistency, expressiveness and memorisation ease.

      This issue will result in existing command names changing. Command options (ie those portions of a command prefixed by a double-hyphen), on the other hand, will not be reviewed as part of this task. This is because command options are not nearly as critical for learning Roo as are command names, as once a command name has been established the tab-completing shell interface guides the user through the mandatory and optional command options in an intelligent and easy-to-use manner anyway.

      The main area of intended improvement is to identify the desired output artifact at the beginning of the command. For example, "create controller" would become "controller create" (or similar). In addition, where possible the differentiation between installation and post-installation setup is to be removed. As such, "install jpa" would become "persistence setup" and the "update jpa" would be removed.

      This task has been deferred until now so that a detailed understanding of version 1.0.0 commands would be reached.

        Activity

        Hide
        Ben Alex added a comment -

        SVN revision 283 contains the following modified commands, updated *.roo sample scripts and updated hint information.

        add dependency -> dependency add
        add field boolean -> field boolean
        add field date jdk -> field date
        add field date jpa -> field date
        add field email template -> field email template
        add field jms template -> field jms template
        add field number -> field number
        add field reference jpa -> field reference
        add field set jpa -> field set
        add field string -> field string
        configure email template -> email template setup
        configure logging -> logging setup
        create project -> project
        database properties -> database properties list
        database remove -> database properties remove
        database set -> database properties set
        generate class file -> class
        insert field -> field other
        install bundlor -> bundlor setup 
        install email provider -> email sender setup
        install finder -> finder add
        install jms -> jms setup
        install jpa exception translation -> persistence exception translation
        install jpa -> persistence setup
        install security -> security setup
        install web flow -> web flow
        list finders for -> finder list
        metadata summary -> metadata status
        metadata timings -> metadata status
        new controller automatic -> controller scaffold
        new controller manual -> controller class
        new dod -> dod
        new integration test -> test integration
        new java jms listener -> jms listener class
        new mock test -> test mock
        new persistent class jpa -> entity
        new selenium test -> selenium test
        polling information -> poll status
        polling speed -> poll speed
        property file details -> properties list
        property file remove -> properties remove
        property file set -> properties set
        remove dependency -> dependency remove
        update jpa -> persistence setup
        
        Show
        Ben Alex added a comment - SVN revision 283 contains the following modified commands, updated *.roo sample scripts and updated hint information. add dependency -> dependency add add field boolean -> field boolean add field date jdk -> field date add field date jpa -> field date add field email template -> field email template add field jms template -> field jms template add field number -> field number add field reference jpa -> field reference add field set jpa -> field set add field string -> field string configure email template -> email template setup configure logging -> logging setup create project -> project database properties -> database properties list database remove -> database properties remove database set -> database properties set generate class file -> class insert field -> field other install bundlor -> bundlor setup install email provider -> email sender setup install finder -> finder add install jms -> jms setup install jpa exception translation -> persistence exception translation install jpa -> persistence setup install security -> security setup install web flow -> web flow list finders for -> finder list metadata summary -> metadata status metadata timings -> metadata status new controller automatic -> controller scaffold new controller manual -> controller class new dod -> dod new integration test -> test integration new java jms listener -> jms listener class new mock test -> test mock new persistent class jpa -> entity new selenium test -> selenium test polling information -> poll status polling speed -> poll speed property file details -> properties list property file remove -> properties remove property file set -> properties set remove dependency -> dependency remove update jpa -> persistence setup

          People

          • Assignee:
            Ben Alex
            Reporter:
            Ben Alex
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved: