Sharing iP code quality feedback [for @ryenl]

[nus-se-bot]

@ryenl We did an automated analysis of your code to detect potential areas to improve the code quality. We are sharing the results below, to help you improve the iP code further.

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

No easy-to-detect issues 👍

Aspect: Recent Git Commit Message

possible problems in commit 8628572:

Use streams for find command.

• Subject line should not end with a period

possible problems in commit 422483d:

Add assertions to validate indexes and non-null file path

- Current Situation: Previously, there were no checks to ensure that indexes used in delete and mark commands were valid. Additionally, there was no validation to ensure that the file path for task storage was not null.
- Why It Needs to Change: Without proper validation, invalid indexes could cause runtime errors or unintended behavior, and a null file path could lead to errors in file operations.
- What Is Being Done:
  - Added assertions in the `remove` method to ensure the index is within the valid range before attempting to delete a task.
  - Added assertions in the `markTaskAsDone` and `markTaskAsUndone` methods to ensure the task number is within the valid range before marking tasks.
  - Included an assertion to check that the file path is not null before proceeding with file operations.
- Why: These changes improve the robustness of the code by ensuring that invalid states are caught early, thus preventing potential errors and enhancing overall code reliability.

• body not wrapped at 72 characters: e.g., - Current Situation: Previously, there were no checks to ensure that indexes used in delete and mark commands were valid. Additionally, there was no validation to ensure that the file path for task storage was not null.

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 👍

---

ℹ️ 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.