Sharing iP code quality feedback [for @jingxueguo]

[nus-se-bot]

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 code further.

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

Aspect: Tab Usage

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

Example from src/main/java/Duke.java lines 9-144:

    public static void main(String[] args) {
        int counter = 0;
        ArrayList<Task> list = new ArrayList<>();

        File tasks = new File("./data/duke.txt");
        try {
            if (tasks.exists()) {
                Scanner sc1 = new Scanner(tasks);
                String data;
                while (sc1.hasNextLine()) {
                    data = sc1.nextLine();
                    String[] dataSplit = data.split(" \\| ");
                    switch (dataSplit[0]) {
                        case "T":
                            list.add(new ToDos(Boolean.parseBoolean(dataSplit[1]), dataSplit[2]));
                            break;
                        case "D":
                            list.add(new Deadlines(Boolean.parseBoolean(dataSplit[1]), dataSplit[2], dataSplit[3]));
                            break;
                        case "E":
                            list.add(new Events(Boolean.parseBoolean(dataSplit[1]), dataSplit[2], dataSplit[3]));
                    }
                    counter++;
                }
                sc1.close();
            } else {
                File directory = new File("./data");
                if (!directory.exists()) {
                    directory.mkdir();
                }
                tasks.createNewFile();
            }
        } catch (IOException e) {
            System.out.println("An error has occurred while reading duke.txt");
        }

        Scanner sc = new Scanner (System.in);
        System.out.println("Hello! What can I do for you:>");
        String input = sc.nextLine();
        while (!input.equals("bye")) {
            if (input.equals("list")) {
                if (list.size() == 0) {
                    System.out.println("You have no tasks in the list!");
                }
                for (int i = 0; i < list.size(); i++) {
                    System.out.println((i + 1) + "." + list.get(i));
                }
            } else {
                String[] inputSplit = input.split(" ");
                switch (inputSplit[0]){
                    case "done":
                        if (inputSplit.length < 2){
                            System.out.println("You have entered too little arguments, please include the task number");
                            break;
                        }
                        int value = Integer.valueOf(inputSplit[1]);
                        list.get(value - 1).setDone();
                        System.out.println("Nice, I have set this task as done!");
                        System.out.println(list.get(value - 1).toString());
                        break;
                    case "delete":
                        if (inputSplit.length < 2){
                            System.out.println("You have entered too little arguments, please include the task number");
                            break;
                        }
                        counter--;
                        int valueToDelete = Integer.valueOf(inputSplit[1]);
                        Task task = list.get(valueToDelete - 1);
                        list.remove(valueToDelete - 1);
                        System.out.println("Noted. I have deleted this task:");
                        System.out.println(task.toString());
                        System.out.println("You now have " + counter + " task(s) in the list!");
                        break;
                    case "todo":
                        if (inputSplit.length < 2){
                            System.out.println("You have entered too little arguments, please include the task description");
                            break;
                        }
                        counter++;
                        String name = String.join(" ", Arrays.copyOfRange(inputSplit, 1, inputSplit.length));
                        list.add(new ToDos(false, name));
                        System.out.println("Got it. I have added this task:");
                        System.out.println(list.get(counter - 1));
                        System.out.println("You now have " + counter + " task(s) in the list!");
                        break;
                    case "deadline":
                        if (inputSplit.length < 2){
                            System.out.println("You have entered too little arguments, please include the task description");
                            break;
                        }
                        counter++;
                        String deadlineName = String.join(" ", Arrays.copyOfRange(inputSplit, 1, inputSplit.length));
                        String[] deadlineSplit = deadlineName.split(" /by ");
                        list.add(new Deadlines(false, deadlineSplit[0], deadlineSplit[1]));
                        System.out.println("Got it. I have added this task:");
                        System.out.println(list.get(counter - 1));
                        System.out.println("You now have " + counter + " task(s) in the list!");
                        break;
                    case "event":
                        if (inputSplit.length < 2){
                            System.out.println("You have entered too little arguments, please include the task description");
                            break;
                        }
                        counter++;
                        String event = String.join(" ",Arrays.copyOfRange(inputSplit, 1, inputSplit.length));
                        String[] eventSplit = event.split(" /at ");
                        list.add(new Events(false, eventSplit[0], eventSplit[1]));
                        System.out.println("Got it. I have added this task:");
                        System.out.println(list.get(counter - 1));
                        System.out.println("You now have " + counter + " task(s) in the list!");
                        break;
                    default:
                        System.out.println("You have entered invalid commands, please try again!");
                }
            }
            input = sc.nextLine();
        }

        try {
            FileWriter writer = new FileWriter("./data/duke.txt", false);
            for (Task task : list) {
                writer.write(task.eventType + " | " + task.isDone + " | " + task.eventName);
                if (task instanceof Deadlines) {
                    writer.write(" | " + ((Deadlines) task).deadLine);
                } else if (task instanceof Events) {
                    writer.write(" | " + ((Events) task).time);
                }
                writer.write(System.lineSeparator());
            }
            writer.close();
        } catch (IOException e) {
            System.out.println("Error occurred while writer to file.");
        }

        System.out.println("Bye. See you again!");
    }

Suggestion: Consider applying SLAP (and other abstraction mechanisms) to shorten methods. You may ignore this suggestion if you think a longer method is justified in a particular case.

ℹ️ The bot account @cs2103-bot 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.