Sharing iP code quality feedback [for @tjingsheng] - Round 2

@tjingsheng We did an automated analysis of your code to detect potential areas to improve the code quality. We are sharing the results below, so that you can avoid similar problems in your tP code (which will be graded more strictly for code quality).

IMPORTANT: Note that the script looked for **just a few easy-to-detect problems only**, and **at-most three example are given** i.e., there can be other areas/places to improve.


### Aspect: Tab Usage

No easy-to-detect issues :+1: 


### Aspect: Naming boolean variables/methods

No easy-to-detect issues :+1: 


### Aspect: Brace Style

No easy-to-detect issues :+1: 


### Aspect: Package Name Style

No easy-to-detect issues :+1: 


### Aspect: Class Name Style

No easy-to-detect issues :+1: 


### Aspect: Dead Code

No easy-to-detect issues :+1: 


### Aspect: Method Length

Example from [`src/test/java/command/HelpCommandTest.java` lines `55-119`](https://github.com/tjingsheng/ip/blob/ee942611849084ca34f426092a6ffcb8500f3728/src/test/java/command/HelpCommandTest.java#L55..L119):

```java

    public void testExecuteShowsHelpMessage() {
        // Arrange
        TaskList taskList = new TaskList(null);
        HelpCommand helpCommand = new HelpCommand("help");

        // Act
        String actualOutput = helpCommand.execute(taskList);
        String expectedOutput = "Woof! Woof! Here to help:" + System.lineSeparator()
            + System.lineSeparator()
            + "Available Commands:" + System.lineSeparator() + System.lineSeparator()
            + "1. Todo     : Add a simple to-do task."
            + System.lineSeparator()
            + "   Format   : `todo <description>`" + System.lineSeparator()
            + "   Example  : `todo study`" + System.lineSeparator()
            + System.lineSeparator()
            + "2. Deadline : Add a task with a deadline." + System.lineSeparator()
            + "   Format   : `deadline <description> /by <date>`" + System.lineSeparator()
            + "   Example  : `deadline assignment /by 2023-12-31`" + System.lineSeparator()
            + System.lineSeparator()
            + "3. Event    : Add an event with a start and end date." + System.lineSeparator()
            + "   Format   : `event <description> /from <date> /to <date>`" + System.lineSeparator()
            + "   Example  : `event enjoy /from 2023-11-25 /to 2024-01-14`" + System.lineSeparator()
            + System.lineSeparator()
            + "4. Mark     : Mark a task as completed." + System.lineSeparator()
            + "   Format   : `mark <taskIndex>`" + System.lineSeparator()
            + "   Example  : `mark 1`" + System.lineSeparator()
            + System.lineSeparator()
            + "5. Unmark   : Unmark a completed task as incomplete." + System.lineSeparator()
            + "   Format   : `unmark <taskIndex>`" + System.lineSeparator()
            + "   Example  : `unmark 1`" + System.lineSeparator()
            + System.lineSeparator()
            + "6. Delete   : Delete a task." + System.lineSeparator()
            + "   Format   : `delete <taskIndex>`" + System.lineSeparator()
            + "   Example  : `delete 2`" + System.lineSeparator()
            + System.lineSeparator()
            + "7. List     : View all your tasks." + System.lineSeparator()
            + "   Format   : `list`" + System.lineSeparator()
            + System.lineSeparator()
            + "8. Find     : Search for tasks containing n keywords." + System.lineSeparator()
            + "   Format   : `find <keyword1> ... <keyword n>`" + System.lineSeparator()
            + "   Example  : `find meeting project`" + System.lineSeparator()
            + System.lineSeparator()
            + "9. Sort     : Sort tasks by date and time." + System.lineSeparator()
            + "   Format   : `sort`" + System.lineSeparator()
            + System.lineSeparator()
            + "10. Bye     : Say goodbye to WoofWoof Bot." + System.lineSeparator()
            + "    Format : `bye`" + System.lineSeparator()
            + System.lineSeparator()
            + "11. Help    : Request help on how to use the bot." + System.lineSeparator()
            + "    Format : `help`" + System.lineSeparator()
            + System.lineSeparator()
            + "Notes:" + System.lineSeparator()
            + "- Replace `<description>` with a task description." + System.lineSeparator()
            + "- `<date>` should follow the yyyy-mm-dd date format." + System.lineSeparator()
            + "           e.g. 2023-12-31" + System.lineSeparator()
            + "- `<taskIndex>` should be the index of the task in the list" + System.lineSeparator()
            + "                you want to manage." + System.lineSeparator()
            + System.lineSeparator()
            + "Feel free to ask for help using the `help` command if you" + System.lineSeparator()
            + "have any questions or encounter issues." + System.lineSeparator()
            + "Woof Woof is here to make your life easier!";

        // Assert
        assertEquals(expectedOutput, actualOutput);
    }

```

Example from [`src/test/java/command/SortCommandTest.java` lines `61-347`](https://github.com/tjingsheng/ip/blob/ee942611849084ca34f426092a6ffcb8500f3728/src/test/java/command/SortCommandTest.java#L61..L347):

```java

    public void testExecuteSortTasks() {
        // Arrange
        Task[] tasks = {
            new TodoTask(
                "Task 6",
                true
            ),
            new TodoTask(
                "a"
            ),
            new DeadlineTask(
                "b",
                Woof.parseDateTimeIn("2023-01-01")
            ),
            new DeadlineTask(
                "Task 8",
                Woof.parseDateTimeIn("2023-02-03")
            ),
            new TodoTask(
                "c",
                true
            ),
            new TodoTask(
                "d"
            ),
            new TodoTask(
                "Task 1"
            ),
            new EventTask(
                "e",
                Woof.parseDateTimeIn("2023-01-01"),
                Woof.parseDateTimeIn("2023-01-01"),
                true
            ),
            new TodoTask(
                "f"
            ),
            new EventTask(
                "4",
                Woof.parseDateTimeIn("2023-05-05"),
                Woof.parseDateTimeIn("2023-05-06")
            ),
            new DeadlineTask(
                "g",
                Woof.parseDateTimeIn("2023-01-01")
            ),
            new TodoTask(
                "Task 2",
                true
            ),
            new TodoTask(
                "Task 9"
            ),
            new TodoTask(
                "Task 10"
            ),
            new EventTask(
                "h",
                Woof.parseDateTimeIn("2023-02-15"),
                Woof.parseDateTimeIn("2023-02-15"),
                true
            ),
            new TodoTask(
                "i"
            ),
            new TodoTask(
                "Task 3",
                true
            ),
            new EventTask(
                "j",
                Woof.parseDateTimeIn("2023-03-10"),
                Woof.parseDateTimeIn("2023-03-10")
            ),
            new DeadlineTask(
                "k",
                Woof.parseDateTimeIn("2023-04-20")
            ),
            new EventTask(
                "l",
                Woof.parseDateTimeIn("2023-05-05"),
                Woof.parseDateTimeIn("2023-05-06")
            ),
            new TodoTask(
                "Task 5"
            ),
            new TodoTask(
                "Task 7"
            ),
            new DeadlineTask(
                "Task 13",
                Woof.parseDateTimeIn("2023-06-01")
            ),
            new EventTask(
                "Task 12",
                Woof.parseDateTimeIn("2023-07-15"),
                Woof.parseDateTimeIn("2023-07-16"),
                true
            ),
            new TodoTask(
                "Task 11",
                true
            ),
            new TodoTask(
                "Task 19"
            ),
            new DeadlineTask(
                "Task 15",
                Woof.parseDateTimeIn("2023-08-30")
            ),
            new EventTask(
                "Task 16",
                Woof.parseDateTimeIn("2023-09-10"),
                Woof.parseDateTimeIn("2023-09-11")
            ),
            new TodoTask(
                "Task 17"
            ),
            new TodoTask(
                "Task 18",
                true
            ),
            new EventTask(
                "Task 19",
                Woof.parseDateTimeIn("2023-10-20"),
                Woof.parseDateTimeIn("2023-10-21")
            ),
            new DeadlineTask(
                "Task 20",
                Woof.parseDateTimeIn("2023-11-05")
            ),
            new TodoTask(
                "Task m",
                true
            ),
            new DeadlineTask(
                "Task n",
                Woof.parseDateTimeIn("2023-11-15"),
                true
            ),
            new EventTask(
                "Task o",
                Woof.parseDateTimeIn("2023-12-10"),
                Woof.parseDateTimeIn("2023-12-11"),
                true
            ),
            new TodoTask(
                "Task p"
            ),
            new EventTask(
                "Task q",
                Woof.parseDateTimeIn("2024-01-05"),
                Woof.parseDateTimeIn("2024-01-06")
            ),
            new DeadlineTask(
                "Task r",
                Woof.parseDateTimeIn("2024-02-20")
            ),
            new EventTask(
                "Task s",
                Woof.parseDateTimeIn("2024-03-15"),
                Woof.parseDateTimeIn("2024-03-16"),
                true
            ),
            new TodoTask(
                "Task t"
            ),
            new TodoTask(
                "Task u",
                true
            ),
            new EventTask(
                "Task v",
                Woof.parseDateTimeIn("2024-04-20"),
                Woof.parseDateTimeIn("2024-04-21")
            ),
            new DeadlineTask(
                "Task w",
                Woof.parseDateTimeIn("2024-05-10")
            ),
            new EventTask(
                "Task x",
                Woof.parseDateTimeIn("2024-06-05"),
                Woof.parseDateTimeIn("2024-06-06")
            ),
            new TodoTask(
                "Task y"
            ),
            new TodoTask(
                "Task z",
                true
            )
        };
        TaskList taskList = new TaskList(tasks);

        SortCommand sortCommand = new SortCommand("sort");
        String expectedOutput = "Your tasks have been sorted:" + System.lineSeparator()
            + "  1. [D][ ] b" + System.lineSeparator()
            + "            ~By: 01 Jan 2023" + System.lineSeparator()
            + "  2. [D][ ] g" + System.lineSeparator()
            + "            ~By: 01 Jan 2023" + System.lineSeparator()
            + "  3. [D][ ] Task 8" + System.lineSeparator()
            + "            ~By: 03 Feb 2023" + System.lineSeparator()
            + "  4. [D][ ] k" + System.lineSeparator()
            + "            ~By: 20 Apr 2023" + System.lineSeparator()
            + "  5. [D][ ] Task 13" + System.lineSeparator()
            + "            ~By: 01 Jun 2023" + System.lineSeparator()
            + "  6. [D][ ] Task 15" + System.lineSeparator()
            + "            ~By: 30 Aug 2023" + System.lineSeparator()
            + "  7. [D][ ] Task 20" + System.lineSeparator()
            + "            ~By: 05 Nov 2023" + System.lineSeparator()
            + "  8. [D][ ] Task r" + System.lineSeparator()
            + "            ~By: 20 Feb 2024" + System.lineSeparator()
            + "  9. [D][ ] Task w" + System.lineSeparator()
            + "            ~By: 10 May 2024" + System.lineSeparator()
            + " 10. [E][ ] j" + System.lineSeparator()
            + "            ~From: 10 Mar 2023" + System.lineSeparator()
            + "            ~To  : 10 Mar 2023" + System.lineSeparator()
            + " 11. [E][ ] 4" + System.lineSeparator()
            + "            ~From: 05 May 2023" + System.lineSeparator()
            + "            ~To  : 06 May 2023" + System.lineSeparator()
            + " 12. [E][ ] l" + System.lineSeparator()
            + "            ~From: 05 May 2023" + System.lineSeparator()
            + "            ~To  : 06 May 2023" + System.lineSeparator()
            + " 13. [E][ ] Task 16" + System.lineSeparator()
            + "            ~From: 10 Sep 2023" + System.lineSeparator()
            + "            ~To  : 11 Sep 2023" + System.lineSeparator()
            + " 14. [E][ ] Task 19" + System.lineSeparator()
            + "            ~From: 20 Oct 2023" + System.lineSeparator()
            + "            ~To  : 21 Oct 2023" + System.lineSeparator()
            + " 15. [E][ ] Task q" + System.lineSeparator()
            + "            ~From: 05 Jan 2024" + System.lineSeparator()
            + "            ~To  : 06 Jan 2024" + System.lineSeparator()
            + " 16. [E][ ] Task v" + System.lineSeparator()
            + "            ~From: 20 Apr 2024" + System.lineSeparator()
            + "            ~To  : 21 Apr 2024" + System.lineSeparator()
            + " 17. [E][ ] Task x" + System.lineSeparator()
            + "            ~From: 05 Jun 2024" + System.lineSeparator()
            + "            ~To  : 06 Jun 2024" + System.lineSeparator()
            + " 18. [T][ ] Task 1" + System.lineSeparator()
            + " 19. [T][ ] Task 10" + System.lineSeparator()
            + " 20. [T][ ] Task 17" + System.lineSeparator()
            + " 21. [T][ ] Task 19" + System.lineSeparator()
            + " 22. [T][ ] Task 5" + System.lineSeparator()
            + " 23. [T][ ] Task 7" + System.lineSeparator()
            + " 24. [T][ ] Task 9" + System.lineSeparator()
            + " 25. [T][ ] Task p" + System.lineSeparator()
            + " 26. [T][ ] Task t" + System.lineSeparator()
            + " 27. [T][ ] Task y" + System.lineSeparator()
            + " 28. [T][ ] a" + System.lineSeparator()
            + " 29. [T][ ] d" + System.lineSeparator()
            + " 30. [T][ ] f" + System.lineSeparator()
            + " 31. [T][ ] i" + System.lineSeparator()
            + " 32. [D][X] Task n" + System.lineSeparator()
            + "            ~By: 15 Nov 2023" + System.lineSeparator()
            + " 33. [E][X] e" + System.lineSeparator()
            + "            ~From: 01 Jan 2023" + System.lineSeparator()
            + "            ~To  : 01 Jan 2023" + System.lineSeparator()
            + " 34. [E][X] h" + System.lineSeparator()
            + "            ~From: 15 Feb 2023" + System.lineSeparator()
            + "            ~To  : 15 Feb 2023" + System.lineSeparator()
            + " 35. [E][X] Task 12" + System.lineSeparator()
            + "            ~From: 15 Jul 2023" + System.lineSeparator()
            + "            ~To  : 16 Jul 2023" + System.lineSeparator()
            + " 36. [E][X] Task o" + System.lineSeparator()
            + "            ~From: 10 Dec 2023" + System.lineSeparator()
            + "            ~To  : 11 Dec 2023" + System.lineSeparator()
            + " 37. [E][X] Task s" + System.lineSeparator()
            + "            ~From: 15 Mar 2024" + System.lineSeparator()
            + "            ~To  : 16 Mar 2024" + System.lineSeparator()
            + " 38. [T][X] Task 11" + System.lineSeparator()
            + " 39. [T][X] Task 18" + System.lineSeparator()
            + " 40. [T][X] Task 2" + System.lineSeparator()
            + " 41. [T][X] Task 3" + System.lineSeparator()
            + " 42. [T][X] Task 6" + System.lineSeparator()
            + " 43. [T][X] Task m" + System.lineSeparator()
            + " 44. [T][X] Task u" + System.lineSeparator()
            + " 45. [T][X] Task z" + System.lineSeparator()
            + " 46. [T][X] c" + System.lineSeparator()
            + "You have 46 tasks in the task list.";

        // Act
        String actualOutput = sortCommand.execute(taskList);

        // Assert
        assertEquals(expectedOutput, actualOutput);
    }

``` 

**Suggestion:** Consider applying [SLAP (and other abstraction mechanisms)](https://nus-cs2103-ay2324s1.github.io/website//se-book-adapted/chapters/codeQuality.html#guideline-maximise-readability) to shorten methods e.g., extract some code blocks into separate methods. You may ignore this suggestion if you think a longer method is justified in a particular case.

### Aspect: Class size

No easy-to-detect issues :+1: 


### Aspect: Header Comments

Example from [`src/main/java/woof/Woof.java` lines `24-28`](https://github.com/tjingsheng/ip/blob/ee942611849084ca34f426092a6ffcb8500f3728/src/main/java/woof/Woof.java#L24..L28):

```java

    /**
     * The main entry point for the application.
     *
     * @param args Command-line arguments (not used in this application).
     */

```

Example from [`src/main/java/woof/Woof.java` lines `166-168`](https://github.com/tjingsheng/ip/blob/ee942611849084ca34f426092a6ffcb8500f3728/src/main/java/woof/Woof.java#L166..L168):

```java

    /**
     * Get the chat width for chat formatting.
     */

```

Example from [`src/main/java/woofwoof/DialogBox.java` lines `47-51`](https://github.com/tjingsheng/ip/blob/ee942611849084ca34f426092a6ffcb8500f3728/src/main/java/woofwoof/DialogBox.java#L47..L51):

```java

    /**
     * Create and configure the drop shadow effect for elements.
     *
     * @return The configured DropShadow effect.
     */

``` 

**Suggestion:** Ensure method/class header comments follow the format specified in the coding standard, in particular, the phrasing of the overview statement.

### Aspect: Recent Git Commit Message

No easy-to-detect issues :+1: 


### Aspect: Binary files in repo

No easy-to-detect issues :+1: 


----

:exclamation: You are not _required_ to (but you are welcome to) fix the above problems in your iP, unless you have been separately asked to resubmit the iP due to code quality issues.

:information_source: The bot account used to post this issue is un-manned. **Do not reply to this post** (as those replies will not be read). Instead, contact `cs2103@comp.nus.edu.sg` if you want to follow up on this post.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Sharing iP code quality feedback [for @tjingsheng] - Round 2 #28

Aspect: Tab Usage

Aspect: Naming boolean variables/methods

Aspect: Brace Style

Aspect: Package Name Style

Aspect: Class Name Style

Aspect: Dead Code

Aspect: Method Length

Aspect: Class size

Aspect: Header Comments

Aspect: Recent Git Commit Message

Aspect: Binary files in repo

Metadata

Assignees

Labels

Projects

Milestone

Relationships

Development

Sharing iP code quality feedback [for @tjingsheng] - Round 2 #28

Description

Aspect: Tab Usage

Aspect: Naming boolean variables/methods

Aspect: Brace Style

Aspect: Package Name Style

Aspect: Class Name Style

Aspect: Dead Code

Aspect: Method Length

Aspect: Class size

Aspect: Header Comments

Aspect: Recent Git Commit Message

Aspect: Binary files in repo

Metadata

Metadata

Assignees

Labels

Projects

Milestone

Relationships

Development

Issue actions