Logic: Add command aliases #785

yamgent · 2018-01-01T15:04:17Z

Part of #784. Rebased, and also added tests + docs.

Proposed commit message:

In order to invoke a command, the user has to type the full command
word. For example, to invoke the AddCommand, the user has to type
"add ...".

As such commands are commonly used, typing the full command word can
be inconvenient.

Let's teach AddressBookParser to accept command aliases as another
way of invoking the commands. For example, if the alias for
AddCommand is "a", the user can type "a n/John Doe" instead of
"add n/John Doe" to accomplish the same task.

Note: This PR is used as an example for future developers. Do not merge!

CanIHasReview-bot · 2018-01-01T15:20:50Z

v1

@yamgent submitted v1 for review.

[v1 1/11] AddressBookParser: Add alias for AddCommand
[v1 2/11] AddressBookParser: Add alias for EditCommand
[v1 3/11] AddressBookParser: Add alias for SelectCommand
[v1 4/11] AddressBookParser: Add alias for DeleteCommand
[v1 5/11] AddressBookParser: Add alias for ClearCommand
[v1 6/11] AddressBookParser: Add alias for FindCommand
[v1 7/11] AddressBookParser: Add alias for ListCommand
[v1 8/11] AddressBookParser: Add alias for HistoryCommand
[v1 9/11] AddressBookParser: Add alias for UndoCommand
[v1 10/11] AddressBookParser: Add alias for RedoCommand
[v1 11/11] UserGuide: Add command aliases

(📚 Archive)

Checkout this PR version locally

git fetch https://github.com/se-edu/addressbook-level4.git refs/pr/785/1/head:BRANCHNAME

where BRANCHNAME is the name of the local branch you wish to fetch this PR to.

Zhiyuan-Amos

[8/11]

Zhiyuan-Amos · 2018-01-03T06:20:45Z

src/test/java/seedu/address/logic/parser/AddressBookParserTest.java

+        assertTrue(parser.parseCommand(HistoryCommand.COMMAND_ALIAS + " 3") instanceof HistoryCommand);
+
+        try {
+            parser.parseCommand("histories");


this test is unnecessary cos it's the exact same thing in the above test :P

Zhiyuan-Amos

[11/11] Missing update for select.

Zhiyuan-Amos

Just some minor nits! I'll just approve first; after this can tag prof for review ^^

Zhiyuan-Amos · 2018-01-03T06:26:20Z

docs/UserGuide.adoc

@@ -46,6 +46,7 @@ e.g. typing *`help`* and pressing kbd:[Enter] will open the help window.
 ====
 *Command Format*

+* Some commands may have an alias, which you can also use to execute the command e.g. for `add`, its alias is `a`, so you can either type `add n/John Doe` or `a n/John Doe`.


Some commands ~~may~~ have an alias

~~e.g. for add, its alias is a, so you can either type add n/John Doe or a n/John Doe.~~ e.g. to add a person to the address book, you can type either add n/John Doe or a n/John Doe.

CanIHasReview-bot · 2018-01-04T05:54:31Z

v2

@yamgent submitted v2 for review.

[v2 1/11] AddressBookParser: Add alias for AddCommand
[v2 2/11] AddressBookParser: Add alias for EditCommand
[v2 3/11] AddressBookParser: Add alias for SelectCommand
[v2 4/11] AddressBookParser: Add alias for DeleteCommand
[v2 5/11] AddressBookParser: Add alias for ClearCommand
[v2 6/11] AddressBookParser: Add alias for FindCommand
[v2 7/11] AddressBookParser: Add alias for ListCommand
[v2 8/11] AddressBookParser: Add alias for HistoryCommand
[v2 9/11] AddressBookParser: Add alias for UndoCommand
[v2 10/11] AddressBookParser: Add alias for RedoCommand
[v2 11/11] UserGuide: Add command aliases

(📚 Archive) (📈 Interdiff between v1 and v2)

Checkout this PR version locally

git fetch https://github.com/se-edu/addressbook-level4.git refs/pr/785/2/head:BRANCHNAME

where BRANCHNAME is the name of the local branch you wish to fetch this PR to.

yamgent · 2018-01-04T05:54:53Z

@Zhiyuan-Amos thanks for the review.

damithc

Thanks for updating the PR @yamgent

Zhiyuan-Amos · 2018-01-06T14:37:55Z

Oh @yamgent, have to update DG to link to this PR instead of the older PR.

In order to invoke AddCommand, the user has to type "add ...". As the command is commonly used, typing the full command word "add" can be troublesome. Let's teach AddressBookParser to accept the alias "a" as another way of invoking the AddCommand.

In order to invoke EditCommand, the user has to type "edit ...". As the command is commonly used, typing the full command word "edit" can be troublesome. Let's teach AddressBookParser to accept the alias "e" as another way of invoking the EditCommand.

In order to invoke SelectCommand, the user has to type "select ...". As the command is commonly used, typing the full command word "select" can be troublesome. Let's teach AddressBookParser to accept the alias "s" as another way of invoking the SelectCommand.

In order to invoke DeleteCommand, the user has to type "delete ...". As the command is commonly used, typing the full command word "delete" can be troublesome. Let's teach AddressBookParser to accept the alias "d" as another way of invoking the DeleteCommand.

In order to invoke ClearCommand, the user has to type "clear". As the command is commonly used, typing the full command word "clear" can be troublesome. Let's teach AddressBookParser to accept the alias "c" as another way of invoking the ClearCommand.

In order to invoke FindCommand, the user has to type "find ...". As the command is commonly used, typing the full command word "find" can be troublesome. Let's teach AddressBookParser to accept the alias "f" as another way of invoking the FindCommand.

In order to invoke ListCommand, the user has to type "list". As the command is commonly used, typing the full command word "list" can be troublesome. Let's teach AddressBookParser to accept the alias "l" as another way of invoking the ListCommand.

In order to invoke HistoryCommand, the user has to type "history". As the command is commonly used, typing the full command word "history" can be troublesome. Let's teach AddressBookParser to accept the alias "h" as another way of invoking the HistoryCommand.

In order to invoke UndoCommand, the user has to type "undo". As the command is commonly used, typing the full command word "undo" can be troublesome. Let's teach AddressBookParser to accept the alias "u" as another way of invoking the UndoCommand.

In order to invoke RedoCommand, the user has to type "redo". As the command is commonly used, typing the full command word "redo" can be troublesome. Let's teach AddressBookParser to accept the alias "r" as another way of invoking the RedoCommand.

CanIHasReview-bot · 2018-08-09T03:53:48Z

v3

@yamgent submitted v3 for review.

[v3 1/11] AddressBookParser: Add alias for AddCommand
[v3 2/11] AddressBookParser: Add alias for EditCommand
[v3 3/11] AddressBookParser: Add alias for SelectCommand
[v3 4/11] AddressBookParser: Add alias for DeleteCommand
[v3 5/11] AddressBookParser: Add alias for ClearCommand
[v3 6/11] AddressBookParser: Add alias for FindCommand
[v3 7/11] AddressBookParser: Add alias for ListCommand
[v3 8/11] AddressBookParser: Add alias for HistoryCommand
[v3 9/11] AddressBookParser: Add alias for UndoCommand
[v3 10/11] AddressBookParser: Add alias for RedoCommand
[v3 11/11] UserGuide: Add command aliases

(📚 Archive) (📈 Interdiff between v2 and v3) (📈 Range-Diff between v2 and v3)

Checkout this PR version locally

git fetch https://github.com/se-edu/addressbook-level4.git refs/pr/785/3/head:BRANCHNAME

where BRANCHNAME is the name of the local branch you wish to fetch this PR to.

yamgent · 2018-08-09T07:04:10Z

Changelog:

79a313f: We must now use PersonUtil#getEditPersonDescriptorDetails(EditPersonDescriptor) instead of PersonUtil#getPersonDetails(Person) when generating the input command for editing a particular person.

CanIHasReview-bot added the s.ToReview label Jan 1, 2018

Zhiyuan-Amos reviewed Jan 3, 2018

View reviewed changes

Zhiyuan-Amos approved these changes Jan 3, 2018

View reviewed changes

Zhiyuan-Amos added s.Ongoing and removed s.ToReview labels Jan 3, 2018

yamgent force-pushed the getting-started-logic branch 2 times, most recently from 0d8443a to 2cb223c Compare January 4, 2018 05:45

CanIHasReview-bot added s.ToReview and removed s.Ongoing labels Jan 4, 2018

yamgent requested a review from damithc January 4, 2018 05:55

damithc approved these changes Jan 5, 2018

View reviewed changes

yamgent closed this Jan 7, 2018

yamgent reopened this Jan 8, 2018

yamgent added pr.Answer Pull request is answer for a tutorial in developer guide. Do not actually merge. and removed s.ToReview labels Jan 8, 2018

Zhiyuan-Amos mentioned this pull request Jan 24, 2018

Rebase PRs used in suggested programming tasks #784

Closed

yamgent mentioned this pull request Aug 4, 2018

Rebase all answer PRs #891

Closed

7 tasks

yamgent force-pushed the getting-started-logic branch from 2cb223c to 720567b Compare August 9, 2018 03:08

yamgent added 6 commits August 9, 2018 11:48

yamgent added 4 commits August 9, 2018 11:48

UserGuide: Add command aliases

79a313f

yamgent force-pushed the getting-started-logic branch from 720567b to 79a313f Compare August 9, 2018 03:48

CanIHasReview-bot added the s.ToReview label Aug 9, 2018

yamgent requested a review from a team August 9, 2018 03:54

Zhiyuan-Amos approved these changes Aug 9, 2018

View reviewed changes

yamgent requested review from damithc and removed request for damithc August 10, 2018 01:27

damithc approved these changes Aug 10, 2018

View reviewed changes

Zhiyuan-Amos removed the s.ToReview label Aug 15, 2018

damithc closed this Dec 11, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Logic: Add command aliases #785

Logic: Add command aliases #785

yamgent commented Jan 1, 2018 •

edited by damithc

Loading

CanIHasReview-bot commented Jan 1, 2018

Zhiyuan-Amos left a comment

Zhiyuan-Amos Jan 3, 2018

Zhiyuan-Amos left a comment

Zhiyuan-Amos left a comment

Zhiyuan-Amos Jan 3, 2018

CanIHasReview-bot commented Jan 4, 2018

yamgent commented Jan 4, 2018

damithc left a comment

Zhiyuan-Amos commented Jan 6, 2018

CanIHasReview-bot commented Aug 9, 2018

yamgent commented Aug 9, 2018 •

edited

Loading

Logic: Add command aliases #785

Logic: Add command aliases #785

Conversation

yamgent commented Jan 1, 2018 • edited by damithc Loading

CanIHasReview-bot commented Jan 1, 2018

v1

Zhiyuan-Amos left a comment

Choose a reason for hiding this comment

Zhiyuan-Amos Jan 3, 2018

Choose a reason for hiding this comment

Zhiyuan-Amos left a comment

Choose a reason for hiding this comment

Zhiyuan-Amos left a comment

Choose a reason for hiding this comment

Zhiyuan-Amos Jan 3, 2018

Choose a reason for hiding this comment

CanIHasReview-bot commented Jan 4, 2018

v2

yamgent commented Jan 4, 2018

damithc left a comment

Choose a reason for hiding this comment

Zhiyuan-Amos commented Jan 6, 2018

CanIHasReview-bot commented Aug 9, 2018

v3

yamgent commented Aug 9, 2018 • edited Loading

yamgent commented Jan 1, 2018 •

edited by damithc

Loading

yamgent commented Aug 9, 2018 •

edited

Loading