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

[soc-se-bot]

@synh 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 👍

Aspect: Naming boolean variables/methods

No easy-to-detect issues 👍

Aspect: Brace Style

No easy-to-detect issues 👍

Aspect: Package Name Style

No easy-to-detect issues 👍

Aspect: Class Name Style

No easy-to-detect issues 👍

Aspect: Dead Code

No easy-to-detect issues 👍

Aspect: Method Length

No easy-to-detect issues 👍

Aspect: Class size

No easy-to-detect issues 👍

Aspect: Header Comments

Example from src/main/java/sage/utils/Parser.java lines 217-222:

    /**
     * Validate that task is in tasklist.
     *
     * @param index 1-based indexing.
     * @throws SageException
     */

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 Messages

possible problems in commit c6dd1b5:

Add support for automatic sorting of tasklist.

List is sorted based on when it was added to the list.

It makes it difficult to view the tasks as they are not grouped by task
type, state of completion, and deadline/start date/end date.

By sorting in the following order:
* Todo -> Deadline -> Event
* Unmarked -> Marked
* Deadline: earliest deadline first. Event: earliest start date first.
it makes it easier for the user to view their tasks at a glance.
By sorting the tasklist immediately after a command that mutates the
tasklist, it allows the user to always be able to view a sorted list
after every command.

Let's,
* Add a Sorter class to implement the above sorting algorithm
* Call the Sorter on all methods that will require automatic
  sorting immediately after.

The Sorter class was generated with the help of Deepseek.

• Subject line should not end with a period

Suggestion: Follow the given conventions for Git commit messages for future commits (do not modify past commit messages as doing so will change the commit timestamp that we used to detect your commit timings).

Aspect: Binary files in repo

No easy-to-detect issues 👍

---

❗ 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.

ℹ️ 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@nus.edu.sg if you want to follow up on this post.