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