[Goh Jin Yuan] iP by farbutnear · Pull Request #673 · nus-cs2103-AY2526S1/ip

farbutnear · 2025-09-04T21:52:13Z

Farquaad 🤖

“Some of you may die, but it's a sacrifice I am willing to make.” – Lord Farquaad (Shrek)

Farquaad is your loyal text-based chatbot that helps you keep track of tasks, deadlines, and events —
so you don’t have to!

It is:

📝 Text-based
🎯 Easy to learn
⚡ Fast. Super Fast

All you need to do is:

Download it from releases.
Double-click it.
Add your tasks.
Let Farquaad handle the rest 😉

And best of all — it’s FREE!

✨ Features

✅ Manage tasks (to-dos, deadlines, events)
🔍 Find tasks by keyword (Level-9)
💾 Save & load tasks automatically (Level-7)
📅 Support for dates & times (Level-8)
⏰ Reminders (coming soon!)

🛠️ For Java Programmers

If you’re a Java programmer, Farquaad is also a great way to practice OOP principles, JavaFX (if you extend it), and working with file I/O.

Here’s the main method to launch it:

public class Main {
    public static void main(String[] args) {
        new Farquaad("data/farquaad.txt").run();
    }
}

In build.gradle, the dependencies on distZip and/or distTar causes the shadowJar task to generate a second JAR file for which the mainClass.set("seedu.duke.Duke") does not take effect. Hence, this additional JAR file cannot be run. For this product, there is no need to generate a second JAR file to begin with. Let's remove this dependency from the build.gradle to prevent the shadowJar task from generating the extra JAR file.

SanguineChameleon

Looks great overall! Just a few small adjustments needed to align with the coding standard. Don't forget to include Javadoc as well :)

SanguineChameleon · 2025-09-05T01:43:26Z

Looks like this class declaration is empty. Was this intentional, or is this still in progress?

SanguineChameleon · 2025-09-05T01:48:18Z

+class farquaadException extends Exception {
+    farquaadException(String msg) { super(msg); }
+}
+
+class unknownCommandException extends farquaadException {
+    unknownCommandException() {
+        super("I apologise, but I don't know what that means LOL");
+    }
+}
+
+class emptyDescriptionException extends farquaadException {
+    emptyDescriptionException(String task) {
+        super("lmao the description of a " + task + " cannot be empty.");
+    }
+}
+
+class invalidIndexException extends farquaadException {
+    invalidIndexException() {
+        super("the task number is invalid.");
+    }
+}


Class names should follow PascalCase, so you may want to update these.

I second the point @SanguineChameleon made about following naming conventions

makis4n

LGTM 👍 . But there are definitely some points for improvement (e.g. including Javadocs and adding access modifiers to your classes).

makis4n · 2025-09-05T04:54:29Z

+        System.out.println("Nice! I've marked this task as done:");
+    }
+
+    public void unmarkAsNotDone() {


Perhaps consider changing the method name to something a bit less confusing (e.g. markAsNotDone)?

makis4n · 2025-09-05T04:57:57Z

+class farquaadException extends Exception {
+    farquaadException(String msg) { super(msg); }
+}
+
+class unknownCommandException extends farquaadException {
+    unknownCommandException() {
+        super("I apologise, but I don't know what that means LOL");
+    }
+}
+
+class emptyDescriptionException extends farquaadException {
+    emptyDescriptionException(String task) {
+        super("lmao the description of a " + task + " cannot be empty.");
+    }
+}
+
+class invalidIndexException extends farquaadException {
+    invalidIndexException() {
+        super("the task number is invalid.");
+    }
+}


I second the point @SanguineChameleon made about following naming conventions

Butanol · 2025-09-05T05:40:48Z

    }
 }

+class invalidIndexException extends farquaadException {


PascalCase class name is preferred.

Butanol · 2025-09-05T05:41:01Z


-class EmptyDescriptionException extends farquaadException {
-    EmptyDescriptionException(String task) {
+class emptyDescriptionException extends farquaadException {


PascalCase class name is preferred.

Butanol · 2025-09-05T05:41:10Z

+    }
+}
+
 public class farquaad {


PascalCase class name is preferred.

Butanol

Overall readable code other than a few coding standard violations. Maybe split the classes into different files.

aliensarefake

Code Review - Coding Standards and Quality

Coding Standard Violations:

Variable Naming Convention
- static final SaveFunction savefunction should use camelCase
- Should be: static final SaveFunction saveFunction
Method Naming Issues
- unmarkAsNotDone() contains a confusing double negative
- Consider markAsNotDone() or simply unmark() for clarity
- getIsDone() should follow boolean getter convention: isDone()
Static Members in Main Class
- Using static ArrayList<Task> tasks in the main class reduces testability
- Consider encapsulating in an instance-based TaskManager class for better design

Code Quality Observations:

Good exception hierarchy with custom FarquaadException extending base Exception
Nested static classes (ToDo, Deadline, Event) work but may benefit from separate files as complexity grows
Consider using primitive boolean return type instead of Boolean wrapper in getIsDone()

FZFZFZZ · 2025-09-17T12:06:02Z

Good in-code comment written

…es and storage Currently, invalid inputs or broken invariants can pass silently, making defects harder to diagnose (e.g., null/empty user input, out-of-bounds indices, or malformed storage loads). This reduces debuggability and can allow incorrect program states to propagate before failing elsewhere. Let's add Java assertions at critical points to guard assumptions about inputs and state transitions. Specifically: * Parser: assert non-null input, non-empty command word, and valid non-negative indices after parsing where applicable. * TaskList: - add(): assert size increases by exactly one. - remove(): assert index is within bounds and size decreases by one. - get(): assert index is within bounds. * Storage.load(): assert the loaded task collection is non-null. * Command classes (e.g., Deadline, Event, Delete): assert required arguments are non-null/non-empty and constructed Task objects are non-null before mutation and save. These assertions improve fault localization during development and test runs when assertions are enabled, without changing runtime behavior in production (assertions are disabled by default). How to run with assertions: `java -ea -jar build/libs/<app>.jar` No functional changes when assertions are disabled.

The Ui class currently contains duplicated logic for repeated task list formatting in displayTaskList and displayMatchingTasks. This makes the code harder to read and more error-prone when extending or updating output formatting. Let's refactor Ui to improve code quality by: * Extracting a private helper formatTaskList() to eliminate duplication between displayTaskList and displayMatchingTasks. * Declaring the scanner field as final to enforce immutability. These changes improve code readability, reduce duplication, and make Ui easier to maintain and extend in the future without changing program behavior.

Add assertions to ensure program correctness

Merge branch 'master' into branch-A-CodeQuality

Improve code quality for readability and maintainability

Users may forget deadlines as the app does not proactively surface tasks due soon. Let's implement a `remind` command and also display reminders at app startup for tasks with deadlines within the next 3 days. Specifically: * Add RemindCommand to list deadlines due within N days (default 3). * Wire Parser to recognize the `remind` keyword. * Add Ui.displayMessage to standardize print-and-return outputs. * Update Farquaad to compute and display startup reminders in CLI and GUI (via MainWindow.setFarquaad). This improves usability by surfacing upcoming deadlines without the user having to remember to query them. be ignored, and an empty message aborts the commit.

damithc and others added 10 commits July 11, 2024 16:52

Add Gradle support

68c58c1

Bump gradle and lib version

03523ec

Level-0: Greet

83c8d32

Level-1: Echo

3c5f7ef

Level-2: Add, List

0e8386e

Level-3: Mark as Done

3792175

Level-4: ToDos, Events, Deadlines

b5ef208

Level-5: Handle Errors

f2f80ba

Level-6: Delete

e68524a

SanguineChameleon reviewed Sep 5, 2025

View reviewed changes

makis4n reviewed Sep 5, 2025

View reviewed changes

Butanol reviewed Sep 5, 2025

View reviewed changes

farbutnear added 2 commits September 5, 2025 15:41

Level-7: Save

dba1a81

Merge Level-7 (Save)

eb6801e

aliensarefake reviewed Sep 5, 2025

View reviewed changes

farbutnear added 11 commits September 8, 2025 07:41

Level-8: Date and Times

0b38fd9

Merge Level-8 (Dates and Times)

a476c8b

A-MoreOOP

98eddfa

Merge A-MoreOOP

fa5725d

A-Packages

224ee82

Merge A-Packages

58ce19b

Merge add-gradle-support

3f3e93b

A-Gradle

80513a1

A-JUnit

c299ff1

A-JUnit

1c84ac3

Merge A-JUnit

108b69d

A-JavaDoc

5327c67

farbutnear and others added 14 commits September 22, 2025 16:09

Level-10 - GUI

191f767

Merge branch 'branch-Level-10' into master

0ae387d

Merge pull request #2 from farbutnear/branch-A-Assertions

9bc9974

Add assertions to ensure program correctness

Merge CodeQuality into master

c49291f

Merge branch 'master' into branch-A-CodeQuality

Merge pull request #3 from farbutnear/branch-A-CodeQuality

93734f5

Improve code quality for readability and maintainability

Merge branch-B-Reminders into master

195985e

BetterGUI

0346018

Merge branch 'branch-BetterGui' into master

e0e15be

A-UserGuide

c1c8a80

Merge branch 'branch-A-UserGuide' into master

34b225e

Remove useless submodule

c6a856e

farbutnear force-pushed the master branch from f09a9ec to c6a856e Compare September 25, 2025 04:42

farbutnear added 2 commits September 25, 2025 12:44

Update README.md

2b6606b

Update README.md

72818b9

Conversation

farbutnear commented Sep 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Farquaad 🤖

✨ Features

🛠️ For Java Programmers

Uh oh!

SanguineChameleon left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

SanguineChameleon Sep 5, 2025

Choose a reason for hiding this comment

Uh oh!

SanguineChameleon Sep 5, 2025

Choose a reason for hiding this comment

Uh oh!

makis4n Sep 5, 2025

Choose a reason for hiding this comment

Uh oh!

makis4n left a comment

Choose a reason for hiding this comment

Uh oh!

makis4n Sep 5, 2025

Choose a reason for hiding this comment

Uh oh!

makis4n Sep 5, 2025

Choose a reason for hiding this comment

Uh oh!

Butanol Sep 5, 2025

Choose a reason for hiding this comment

Uh oh!

Butanol Sep 5, 2025

Choose a reason for hiding this comment

Uh oh!

Butanol Sep 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Butanol left a comment

Choose a reason for hiding this comment

Uh oh!

aliensarefake left a comment

Choose a reason for hiding this comment

Code Review - Coding Standards and Quality

Coding Standard Violations:

Code Quality Observations:

Uh oh!

FZFZFZZ commented Sep 17, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

farbutnear commented Sep 4, 2025 •

edited

Loading

SanguineChameleon left a comment •

edited

Loading

Butanol Sep 5, 2025 •

edited

Loading