| OLD | NEW |
| (Empty) |
| 1 <!--- | |
| 2 Copyright (c) 2015, the Dartino project authors. Please see the AUTHORS file | |
| 3 for details. All rights reserved. Use of this source code is governed by a | |
| 4 BSD-style license that can be found in the LICENSE.md file. | |
| 5 --> | |
| 6 | |
| 7 # Design for Fletch Command Line Interface commands | |
| 8 | |
| 9 The overall structure of commands in Fletch should follow: | |
| 10 | |
| 11 ``` | |
| 12 fletch verb [zero or more verbs or object-nouns] | |
| 13 ``` | |
| 14 | |
| 15 The outermost verb is the group of actions to be performed | |
| 16 (for example, 'help'). Subsequent verbs are either 'sub-verbs' | |
| 17 (for example, 'debug step') or are the target of the outer verbs | |
| 18 (for example 'help debug'). | |
| 19 | |
| 20 Object-nouns are the target of the command (for example, 'fletch show changes') | |
| 21 | |
| 22 The overall aim here is to provide the ability to 'vocalise' the instructions, | |
| 23 in other words to say them to yourself as you type them. | |
| 24 | |
| 25 ## Some examples | |
| 26 | |
| 27 ``` | |
| 28 fletch debug step | |
| 29 ``` | |
| 30 | |
| 31 should perform the next step of execution. | |
| 32 | |
| 33 ``` | |
| 34 fletch help | |
| 35 ``` | |
| 36 | |
| 37 should provide 'top level' help, whereas: | |
| 38 | |
| 39 ``` | |
| 40 fletch help debug | |
| 41 ``` | |
| 42 should provide help about debug. | |
| 43 | |
| 44 | |
| 45 ## Exceptions | |
| 46 | |
| 47 Help should be supported everywhere as a top level verb and a sub-verb, | |
| 48 in other words: | |
| 49 | |
| 50 ``` | |
| 51 fletch help debug | |
| 52 ``` | |
| 53 and | |
| 54 ``` | |
| 55 fletch debug help | |
| 56 ``` | |
| 57 | |
| 58 Should display the same text. | |
| OLD | NEW |