taskninja 1.1.1 → 1.1.3

package/README.md

@@ -20,6 +20,7 @@
   * [Sort Tasks](#sort-tasks)
 * [Task Fields & Allowed Values](#task-fields--allowed-values)
 * [Examples](#examples)
+* [Demo](#demo)
 
 ---
 
@@ -345,38 +346,62 @@ tn so
 
 ---
 
-## Screenshots / Demo
+## Demo
+
+**All Features:**
+
+![All Features](images/allFeatures.png "all commands")
 
 **Adding a Task:**
 
-![Add Task](images/add.png "Adding a Task in TaskNinja CLI")
+![Add Task](images/addNew.png "Adding a Task in TaskNinja CLI")
 
 **Listing Tasks:**
 
-![List Tasks](images/list.png "Listing Tasks in TaskNinja CLI")
+![List Tasks](images/listAll.png "Listing Tasks in TaskNinja CLI")
 
 **Updating a Task:**
 
-![Update Task](images/update.png "Updating a Task")
+![Update Task](images/updateWith.png "Updating a Task")
 
 **Deleting a Task:**
 
-![Delete Task](images/delete.png "Deleting a Task")
-![Delete Task](images/delete2.png "Deleting a Task")
+![Delete Task](images/deleteMethod.png "Deleting a Task")
 
 **Restore Last-Deleted Task:**
 
-![Undo](images/undo.png "Restore Last-deleted task")
+![Undo](images/undoMethod.png "Restore Last-deleted task")
 
 **Search / Sort Tasks:**
 
-![Search Tasks](images/search.png "Searching Tasks")
-![Sort Tasks](images/sort.png "Sorting Tasks")
-![Sort Tasks-2](images/sort2.png "Sorting Tasks")
+![Search Tasks](images/searchWith.png "Searching Tasks")
+![Sort Tasks](images/sort_.png "Sorting Tasks")
+![Sort Tasks-2](images/sortBy.png "Sorting Tasks")
 
 **Mark as Done:**
 
-![Mark Task As Done](images/done.png "Mark as Done In one step")
-![Mark Task As Done](images/done2.png "Mark as Done In one step")
+![Mark Task As Done](images/doneTask.png "Mark as Done In one step")
+![Mark Task As Done](images/doneTask2.png "Mark as Done In one step")
+
+**Tasks in `todos.json`:**
+
+![todos.json](images/todo.json.png "shape of tasks")
+
+
+---
+
+## New Additions for Version `1.1.3`
+
+**ESC Button End Operation:**
+
+* If the user presses the `Esc` button, this will end the ongoing process
+* This may benefit the user by terminating the process without having to complete the process until the end
+
+### SOON
+**Auto Deleted Task:**
+
+* When you delete the task, it will remain saved in `deleted_todos.json` for one minute, after which it will be deleted automatically
+* This somewhat conserves the user's storage space while calculating that the user may undo deleting a task
+
+
 
----

package/app.js

@@ -9,71 +9,34 @@
  * - inquirer: For interactive prompts
  * - fs: For file system operations
  * Author: Mohamed Bakr
- * Date: January 2024
- * Version: 1.1.1
+ * Date: January 2026
+ * Version: 1.1.3
  */
 
 // for using commands in terminal
 import { Command } from "commander";
 // for interactive command line prompts
 import inquirer from "inquirer";
-// supporting colors in table forms
-import Table from 'cli-table3';
 // for colored text 
 import chalk from 'chalk';
 
+// helpers
+import {displayTasks, enableEscExit, cleanupAndExit} from './helpers/helpers.js';
+
 // assigning Commander to a variable
 const program = new Command();
 
 // importing validators and allowed values
 import { validateDueDate, ALLOWED_PRIORITIES, ALLOWED_STATUSES } from "./utils/validators.js";
 // importing task service functions
-import { loadTasks, saveTasks, getNextId, saveDeletedTask, loadDeletedTask, clearDeletedTask  } from "./utils/taskService.js";
-
-
-// helper function to display tasks in colored table
-const displayTasks = (tasks) => {
-    if (!tasks.length) {
-        console.log(chalk.yellow("No tasks to display."));
-        return;
-    }
+import { loadTasks, saveTasks, getNextId, saveDeletedTask, loadDeletedTask, clearDeletedTask, cleanupExpiredDeletedTasks } from "./utils/taskService.js";
 
-    const table = new Table({
-        head:  [
-        chalk.cyanBright('#'),
-        chalk.cyanBright('ID'),
-        chalk.cyanBright('Title'),
-        chalk.cyanBright('Status'),
-        chalk.cyanBright('Priority'),
-        chalk.cyanBright('DueDate'),
-        chalk.cyanBright('Description')
-    ],
-        colWidths: [4, 4, 30, 12, 10, 12, 60]
-    });
-
-    tasks.forEach((task, index) => {
-        table.push([
-            index + 1,
-            task.id,
-            task.title,
-            task.status === "done" ? chalk.green(task.status)
-            : task.status === "in-progress" ? chalk.yellow(task.status)
-            : chalk.blue(task.status),
-            task.priority === "high" ? chalk.red(task.priority)
-            : task.priority === "medium" ? chalk.yellow(task.priority)
-            : chalk.green(task.priority),
-            task.dueDate,
-            task.description || ''
-        ]);
-    });
 
-    console.log(table.toString());
-};
 // setting up
 program
     .name("taskninja")
     .description("A simple CLI application to manage your tasks")
-    .version("1.1.0");
+    .version("1.1.3");
 
 // use command 'add' with title + status + priority + dueDate + description and action
 program
@@ -81,6 +44,7 @@ program
     .alias('a')
     .description('Add a new task')
     .action(async () => {
+        enableEscExit();
         const answers = await inquirer.prompt([
             {
                 type: 'input',
@@ -153,12 +117,13 @@ program
         if (options.status) {
             if (!ALLOWED_STATUSES.includes(options.status)){
                 console.log(chalk.red(`Invalid status filter. Allowed statuses are: ${ALLOWED_STATUSES.join(", ")}`));
-                return;
+                cleanupAndExit(0);
             }
             tasks = tasks.filter(task => task.status === options.status);
         }
         // display all tasks in table format
         displayTasks(tasks);
+        cleanupAndExit(0);
     });
 
 
@@ -174,6 +139,7 @@ program
         let searchTerm = keyword || options.find;
 
         if (!searchTerm) {
+            enableEscExit();
             const answers = await inquirer.prompt([
                 {
                     type: 'input',
@@ -196,16 +162,16 @@ program
                 if (field === 'title') return task.title.toLowerCase().includes(searchTerm.toLowerCase());
                 if (field === 'description') return task.description.toLowerCase().includes(searchTerm.toLowerCase());
                 return task.title.toLowerCase().includes(searchTerm.toLowerCase()) || 
-                       task.description.toLowerCase().includes(searchTerm.toLowerCase());
+                    task.description.toLowerCase().includes(searchTerm.toLowerCase());
             });
 
-            if (founded.length === 0) {
+            if (!founded.length) {
                 console.log(chalk.red('No task matched your search!'));
-                return;
+                cleanupAndExit(0);
             }
 
             displayTasks(founded);
-            return;
+            cleanupAndExit(0);
         }
 
         const founded = tasks.filter(task =>
@@ -213,12 +179,13 @@ program
             task.description.toLowerCase().includes(searchTerm.toLowerCase())
         );
 
-        if (founded.length === 0) {
+        if (!founded.length) {
             console.log(chalk.red('No task matched your search!'));
-            return;
+            cleanupAndExit(0);
         }
 
         displayTasks(founded);
+        cleanupAndExit(0);
     });
 
 
@@ -236,6 +203,7 @@ program
         let criteria = options.by;
 
         if (!criteria) {
+            enableEscExit();
             const answer = await inquirer.prompt([
                 {
                     type: 'rawlist',
@@ -246,33 +214,35 @@ program
             ]);
             criteria = answer.criteria;
         }
-
+        // normailze input `case-insensitive + separators`
+        criteria = criteria.toLowerCase().replace(/[-_]/g, '');
         
-        if (!['dueDate', 'priority', 'status'].includes(criteria)) {
+        if (!['duedate', 'priority', 'status'].includes(criteria)) {
             console.log(chalk.red('Invalid sort criteria. Use --by with dueDate, priority, or status.'));
-            return;
+            cleanupAndExit(0);
         }
         // sorting logic
         const sortedTasks = [...tasks];
 
         switch (criteria) {
-            case 'dueDate' || 'duedate' || 'DueDate' || 'Duedate' || 'due date' || 'Due date' || 'due-date':
+            case 'duedate':
                 sortedTasks.sort((a, b) => new Date(a.dueDate) - new Date(b.dueDate));
                 break;
-            case 'priority' || 'Priority':
+            case 'priority':
                 const priorityOrder = { 'high': 1, 'medium': 2, 'low': 3 };
                 sortedTasks.sort((a, b) => priorityOrder[a.priority] - priorityOrder[b.priority]);
                 break;
-            case 'status' || 'Status':
+            case 'status':
                 const statusOrder = { 'todo': 1, 'in-progress': 2, 'done': 3 };
-                sortedTasks.sort((a, b) => statusOrder[a.priority] - statusOrder[b.priority]);
+                sortedTasks.sort((a, b) => statusOrder[a.status] - statusOrder[b.status]);
                 break;
             default:
                 console.log(chalk.red('Invalid sort criteria. Use dueDate, priority, or status.'));
-                return;
+                cleanupAndExit(0);
         }
 
         displayTasks(sortedTasks);
+        cleanupAndExit(0);
     });
 
 
@@ -283,11 +253,11 @@ program
     .description('Update a task by ==> ID <==')
     .action(async () =>{
         const tasks = await loadTasks();
-        if (tasks.length === 0) {
+        if (!tasks.length) {
             console.log(chalk.red('No tasks found to update.'));
-            return;
+            cleanupAndExit(0);
         }
-
+        enableEscExit();
         const { id } = await inquirer.prompt([
             {
                 type: 'rawlist',
@@ -301,9 +271,10 @@ program
         const task = tasks.find(t => t.id === Number(id));
         if (!task) {
             console.log(chalk.red('Task not found!'));
-            return;
+            cleanupAndExit(0);
         }
 
+        enableEscExit();
         const answers = await inquirer.prompt([
       // for title
         {
@@ -380,10 +351,11 @@ program
             default: false
         },
         {
-            type: "rawlist",
+            type: "input",
             name: 'description',
             message: 'Enter the new description:',
-            when: answers => answers.changeDescription
+            when: answers => answers.changeDescription,
+            validate: input => input.trim() ? true : 'Description cannot be empty!'
         }
     ]);
 
@@ -413,6 +385,7 @@ program
         }
     
         displayTasks(tasks);
+        cleanupAndExit(0);
     });
 
 
@@ -422,17 +395,17 @@ program
     .description('Mark a task as done by ==> ID <==')
     .action(async () => {
         const tasks = await loadTasks();
-        if (tasks.length === 0) {
+        if (!tasks.length) {
             console.log(chalk.magenta('Congratulations! All tasks are already done.'));
-            return;
+            cleanupAndExit(0);
         }
 
         const activeTasks = tasks.filter(t => t.status !== 'done');
-        if (activeTasks.length === 0) {
+        if (!activeTasks.length) {
             console.log(chalk.magenta('Congratulations! All tasks are already done.'));
-            return;
+            cleanupAndExit(0);
         }
-
+        enableEscExit();
         const { id } = await inquirer.prompt([
             {
                 type: 'rawlist',
@@ -453,6 +426,7 @@ program
         console.log(chalk.green('Task marked as done successfully!'));
 
         displayTasks(tasks);
+        cleanupAndExit(0);
     });
 
 
@@ -464,11 +438,11 @@ program
     .description('delete a task by ==> ID <==')
     .action(async () => {
         const tasks = await loadTasks();
-        if (tasks.length === 0) {
+        if (!tasks.length) {
             console.log(chalk.yellow('No tasks found to delete.'));
-            return;
+            cleanupAndExit(0);
         }
-
+        enableEscExit();
         const { id } = await inquirer.prompt([
             {
                 type: 'rawlist',
@@ -477,7 +451,7 @@ program
                 choices: tasks.map(task => ({ name: `${task.id}: ${task.title}`, value: task.id }))
             }
         ]);
-
+        enableEscExit();
         const { confirm } = await inquirer.prompt([
             {
                 type: 'confirm',
@@ -488,7 +462,7 @@ program
         ]);
         if (!confirm) {
             console.log(chalk.yellow('Task deletion cancelled.'));
-            return;
+            cleanupAndExit(0);
         }
         const taskToDelete = tasks.find(t => t.id === Number(id));
         // save deleted task for undo functionality
@@ -501,6 +475,7 @@ program
         console.log(chalk.cyan('You can undo this action by using the `undo` command.'));
 
         displayTasks(newTasks);
+        cleanupAndExit(0);
     });
 
 // use command 'undo' to restore last deleted task
@@ -509,17 +484,21 @@ program
 .alias('un')
 .description('Undo the last deleted task')
 .action( async () => {
-    const lastDeletedTask =  await loadDeletedTask();
-    if (!lastDeletedTask) {
+    await cleanupExpiredDeletedTasks();
+
+    const deletedTasks = await loadDeletedTask();
+    if (!deletedTasks || !deletedTasks.length) {
         console.log(chalk.yellow('No deleted task to restore.'));
-        return;
+        cleanupAndExit(0);
     }
 
+    const lastDeletedTask =  deletedTasks.pop();
+
     const tasks = await loadTasks();
     tasks.push(lastDeletedTask);
     tasks.sort((a, b) => a.id - b.id); // keep tasks sorted by ID
     await saveTasks(tasks);
-    await clearDeletedTask();
+    // await clearDeletedTask();
 
     console.log(chalk.green(`Last deleted task restored successfully!, (Task name: ${lastDeletedTask.title})`));
 });

package/helpers/helpers.js

@@ -0,0 +1,70 @@
+
+// supporting colors in table forms
+import Table from 'cli-table3';
+// for colored text 
+import chalk from 'chalk';
+// for reading keyboard buttons
+import readline from 'readline';
+
+// helper function to display tasks in colored table
+const displayTasks = (tasks) => {
+    if (!tasks.length) {
+        console.log(chalk.yellow("No tasks to display."));
+        cleanupAndExit(0);
+    }
+
+    const table = new Table({
+        head:  [
+        chalk.cyanBright('#'),
+        chalk.cyanBright('ID'),
+        chalk.cyanBright('Title'),
+        chalk.cyanBright('Status'),
+        chalk.cyanBright('Priority'),
+        chalk.cyanBright('DueDate'),
+        chalk.cyanBright('Description')
+    ],
+        colWidths: [4, 4, 20, 15, 10, 12, 45]
+    });
+
+    tasks.forEach((task, index) => {
+        table.push([
+            index + 1,
+            task.id,
+            task.title,
+            task.status === "done" ? chalk.green(task.status)
+            : task.status === "in-progress" ? chalk.yellow(task.status)
+            : chalk.blue(task.status),
+            task.priority === "high" ? chalk.red(task.priority)
+            : task.priority === "medium" ? chalk.yellow(task.priority)
+            : chalk.green(task.priority),
+            task.dueDate,
+            task.description || ''
+        ]);
+    });
+
+    console.log(table.toString());
+};
+
+const cleanupAndExit = (code = 0) => {
+    if (process.stdin.isTTY) {
+        process.stdin.setRawMode(false);
+    }
+    process.exit(code);
+};
+
+const enableEscExit = () => {
+    readline.emitKeypressEvents(process.stdin);
+
+    if (process.stdin.isTTY) {
+        process.stdin.setRawMode(true);
+    }
+
+    process.stdin.on('keypress', (_, key) => {
+        if (key?.name === 'escape'){
+            console.log(chalk.yellow('\nOperation Cancelled!'));
+            cleanupAndExit(0);
+        }
+    });
+};
+
+export {displayTasks, enableEscExit, cleanupAndExit};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "taskninja",
-  "version": "1.1.1",
+  "version": "1.1.3",
   "description": "a simple CLI application with JS as a (To-Do Application)",
   "main": "app.js",
   "type": "module",

package/utils/taskService.js

@@ -35,10 +35,6 @@ export const getNextId = (tasks) => {
  * @description this section responsible to store deleted tasks in deleted_todos.json
  * for undo functionality
  */
-// to save deleted last-deleted task
-export const saveDeletedTask = async (task) => {
-    await fs.writeFile(DELETED_TASKS_FILE, JSON.stringify(task, null, 2));
-}
 
 // to load deleted last-deleted task
 export const loadDeletedTask = async () => {
@@ -50,6 +46,30 @@ export const loadDeletedTask = async () => {
         throw error;
     }
 };
+// to save deleted last-deleted task
+export const saveDeletedTask = async (task, expiredAfter = 60000) => {
+    const deletedTask = await loadDeletedTask(task) || [];
+    const now = Date.now();
+
+    deletedTask.push({
+        ...task,
+        deletedAt: now, 
+        expiredAfter
+    });
+
+    await fs.writeFile(DELETED_TASKS_FILE, JSON.stringify(deletedTask, null, 2));
+}
+
+// function to delete all deleted-tasks after a while
+export const cleanupExpiredDeletedTasks = async () => {
+    const deletedTasks = await loadDeletedTask() || [];
+    const now = Date.now();
+
+    const remaining = deletedTasks.filter(task => now - task.deletedAt < task.expiredAfter);
+    if (remaining.length !== deletedTasks.length){
+        await fs.writeFile(DELETED_TASKS_FILE, JSON.stringify(remaining, null, 2));
+    }
+}
 
 // to clear deleted tasks file after undo
 export const clearDeletedTask = async () => {