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

[soc-se-script]

@J4Joshua 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

Example from src/main/java/command/FindCommand.java lines 21-21:

        boolean found = false;

Suggestion: Follow the given naming convention for boolean variables/methods (e.g., use a boolean-sounding prefix).You may ignore the above if you think the name already follows the convention (the script can report false positives in some cases)

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 Messages

possible problems in commit 962a4dc:

feat: Transition from text-based UI to GUI interface

Refactored the chatbot's UI from a text-based console interface to a
graphical user interface (GUI) using JavaFX.

- Replaced `Ui` class with `MainWindow` and `DialogBox` for GUI interactions.
- Updated `Ekko` to return responses instead of printing to console.
- Modified command execution to return strings for GUI display.
- Adjusted `AddCommand`, `FindCommand`, `MarkCommand`, and `UnmarkCommand`
  to interact with the GUI.
- Removed obsolete text-based UI methods such as `showMessage()`,
  `showLine()`, and `showError()`.

This transition improves user experience by providing a more intuitive and
interactive interface.

• body not wrapped at 72 characters: e.g., - Replaced Uiclass withMainWindowandDialogBox for GUI interactions.

possible problems in commit f4bda9e:

Merge pull request #2 from J4Joshua/branch-A-CodeQuality

Remove Arrowhead Anti-Pattern in parseDateTime()

- Refactored `parseDateTime()` to eliminate deeply nested try-catch blocks.
- Improved readability by handling parsing attempts separately.
- Added an assertion to ensure `dateTimeString` is never null.
- Enhanced maintainability by making the error-handling flow clearer.

This refactor makes the code more readable and easier to debug while maintaining functionality.

• body not wrapped at 72 characters: e.g., - Refactored parseDateTime()to eliminate deeply nested try-catch blocks.

possible problems in commit d29a4cf:

Merge pull request #1 from J4Joshua/branch-A-Assertions

Add Assertions

- Standardized assertion checks to document important assumptions across the codebase.
- Ensured input validation with assertions for key methods in `Parser`, `TaskList`.
- Enabled better debugging and early error detection with `assert` statements.

This refactor improves code readability, reduces redundancy, and prepares for further unification of similar methods.

• body not wrapped at 72 characters: e.g., - Standardized assertion checks to document important assumptions across the codebase.

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