taskninja 1.1.6 → 1.1.7

package/README.md

@@ -1,7 +1,7 @@
 # TaskNinja
 
-**Version:** 1.1.0
-**Description:** A simple CLI To-Do Application to manage your tasks directly from the terminal. Includes colored tables, search, soft delete, undo, and interactive sort.
+**Version:** 1.1.7
+**Description:** A simple CLI To-Do Application to manage your tasks directly from the terminal. Includes colored tables, search, soft delete with auto-expiration, undo, and interactive sort.
 
 ---
 
@@ -10,17 +10,18 @@
 * [Installation](#installation)
 * [Running the CLI](#running-the-cli)
 * [Commands](#commands)
+* [Add Task](#1-add-task)
+* [List Tasks](#2-list-tasks)
+* [Update Task](#3-update-task)
+* [Mark as Done](#4-mark-as-done)
+* [Delete Task](#5-delete-task)
+* [Undo Delete Task](#6-undo-delete-task)
+* [Search Tasks](#7-search-tasks)
+* [Sort Tasks](#8-sort-tasks)
+
 
-  * [Add Task](#add-task)
-  * [List Tasks](#list-tasks)
-  * [Update Task](#update-task)
-  * [Delete Task](#delete-task)
-  * [Undo Delete Task](#undo-delete-task)
-  * [Search Tasks](#search-tasks)
-  * [Sort Tasks](#sort-tasks)
 * [Task Fields & Allowed Values](#task-fields--allowed-values)
-* [Examples](#examples)
-* [Demo](#demo)
+* [New Features in Version 1.1.7](#new-features-in-version-117)
 
 ---
 
@@ -32,21 +33,18 @@ TaskNinja is published on npm as `taskninja`. Install it globally to use the CLI
 
 ```bash
 npm install -g taskninja
-```
-
-or use it instantly with:
 
-```bash
-npx taskninja
-npx taskninja <command>
 ```
 
+### From Source
+
 Clone the repository and install dependencies:
 
 ```bash
 git clone <your-repo-url>
 cd taskninja
 npm install
+
 ```
 
 ---
@@ -56,16 +54,15 @@ npm install
 You can run the CLI using either `node` or the bin aliases:
 
 ```bash
-# Using node
-node app.js <command>
-
 # Using bin aliases
-dotask <command>
-taskninja <command>
 tn <command>
-```
+taskninja <command>
+dotask <command>
+
+# Using node
+node index.js <command>
 
-Replace `<command>` with any of the available commands: `add`, `list`, `update`, `delete`, `undo`, `search`, `sort`.
+```
 
 ---
 
@@ -78,32 +75,18 @@ Replace `<command>` with any of the available commands: `add`, `list`, `update`,
 
 ```bash
 tn a
+
 ```
 
 **Prompts:**
 
 1. **Task Title:** Enter any text (cannot be empty).
-
-2. **Task Status:** Select from allowed values using arrows:
-
-   * todo
-   * in-progress
-   * done
-
-3. **Task Priority:** Select from allowed values:
-
-   * low
-   * medium
-   * high
-
-4. **Due Date:** Enter in `YYYY-MM-DD` format. Invalid dates will show a validation error.
-
+2. **Task Status:** Select from (todo, in-progress, done).
+3. **Task Priority:** Select from (low, medium, high).
+4. **Due Date:** Enter in `YYYY-MM-DD` (Defaults to today).
 5. **Description:** Optional text.
 
-**Behavior:**
-
-* Task is saved in `todos.json`.
-* Confirmation message: `Task added successfully!`
+![Add Task](src/images/addNew.png "Adding a Task in TaskNinja CLI")
 
 ---
 
@@ -115,17 +98,16 @@ tn a
 ```bash
 tn ls
 tn ls --status todo
+
 ```
 
 **Behavior:**
 
-* Displays tasks in a **colored table** using chalk:
-
-| # | ID | Title | Status | Priority | DueDate | Description |
-| - | -- | ----- | ------ | -------- | ------- | ----------- |
+* Displays tasks in a colored table.
+* Status colors: `todo` (blue), `in-progress` (yellow), `done` (green).
+* Priority colors: `low` (green), `medium` (yellow), `high` (red).
 
-* Status colors: `todo` → blue, `in-progress` → yellow, `done` → green
-* Priority colors: `low` → green, `medium` → yellow, `high` → red
+![List Tasks](src/images/listAll.png "Listing Tasks in TaskNinja CLI")
 
 ---
 
@@ -136,273 +118,120 @@ tn ls --status todo
 
 ```bash
 tn up
-```
-
-**Steps:**
-
-1. Select task by ID from a list.
-2. Confirm which fields to change (title, status, priority, due date, description).
-3. Enter new values where applicable.
-
-**Behavior:**
-
-* Only fields selected for change are updated.
-* Confirmation message: `Task updated successfully!`
-* Shows updated **colored task table**.
-
----
-
-### 4. Delete Task
 
-**Alias:** `del`
-**Description:** Soft delete a task by selecting its ID.
-
-```bash
-tn del
 ```
 
 **Steps:**
 
-1. Select task by ID from a list.
-2. Confirm deletion.
+1. Select task by ID.
+2. Confirm which fields to change.
+3. Enter new values.
 
-**Behavior:**
-
-* Task is removed from `todos.json` **but saved in `deleted-todos.json`**.
-* Confirmation: `Task deleted successfully!`
-* You can restore it using the `undo` command.
+![Update Task](src/images/updateWith.png "Updating a Task")
 
 ---
 
-### 5. Undo Delete Task
+### 4. Mark as Done
 
-**Alias:** `un`
-**Description:** Restore the last deleted task.
+**Alias:** `done`
+**Description:** Quickly mark a specific task as done.
 
 ```bash
-tn un
-```
-
-**Behavior:**
+tn done
 
-* Restores the last deleted task from `deleted-todos.json`.
-* Confirmation: `Last deleted task restored successfully!, (Task name: taskName)`
+```
 
----
+[Mark Task As Done](src/images/doneTask.png "Mark as Done In one step")
 
-Here’s the **Search Tasks** section in the README updated in English after your CLI changes:
+![Mark Task As Done](src/images/doneTask2.png "Mark as Done In one step")
 
 ---
 
-### 6. Search Tasks
+### 5. Delete Task
 
-**Alias:** `sr`
-**Description:** Search tasks by keyword in title or description.
+**Alias:** `del`
+**Description:** Soft delete a task by selecting its ID.
 
 ```bash
-# Search interactively
-tn search
+tn del
 
-# Or search directly using --find
-tn search --find "meeting"
 ```
 
 **Behavior:**
 
-* If you run `tn search` without a keyword, the CLI will ask you:
-
-  1. Enter the keyword you want to search for.
-  2. Choose where to search: in the title, description, or both.
-
-* If you use `--find <keyword>` directly, the CLI will return all tasks containing that keyword in the title or description.
-
-**Example:**
+* Task is moved to `deleted-todos.json` and kept for 60 seconds.
 
-```bash
-tn search
-```
-
-```
-Enter the keyword you want to search for: meeting
-Where do you want to search? (Use arrow keys)
-1. title
-2. description
-3. both
-```
-
-```bash
-tn search --find "meeting"
-```
-
-┌─┬────┬────────────┬─────────────┬─────────┬────────────┬───────────────────┐
-│#│ ID │ Title      │ Status      │ Priority│ DueDate    │ Description       │
-├─┼────┼────────────┼─────────────┼─────────┼────────────┼───────────────────┤
-│1│ 3  │ Team meeting│ todo       │ medium  │ 2026-02-01 │ Discuss project   │
-└─┴────┴────────────┴─────────────┴─────────┴────────────┴───────────────────┘
+![Delete Task](src/images/deleteMethod.png "Deleting a Task")
 
 ---
 
-### 7. Sort Tasks
+### 6. Undo Delete Task
 
-**Alias:** `so`
-**Description:** Sort tasks interactively by due date, priority, or status.
+**Alias:** `un`
+**Description:** Restore the last deleted task (if within 60 seconds).
 
 ```bash
-tn so
-```
-
-**Behavior:**
-
-* Prompts: `Sort tasks by:` → select from `dueDate`, `priority`, `status`.
-* Displays **sorted colored table**.
-* Can also pass `--by` option: `tn so --by priority`
-
----
+tn un
 
-## Task Fields & Allowed Values
+```
 
-| Field       | Allowed Values / Description |
-| ----------- | ---------------------------- |
-| title       | Any non-empty string         |
-| status      | todo, in-progress, done      |
-| priority    | low, medium, high            |
-| dueDate     | YYYY-MM-DD                   |
-| description | Optional text                |
+![Undo](src/images/undoMethod.png "Restore Last-deleted task")
 
 ---
 
-## Examples
+### 7. Search Tasks
 
-**Adding a Task:**
-
-```bash
-tn a
-```
-
-```
-Task Title: Buy groceries
-Task Status: → todo
-Task Priority: → medium
-Due Date (YYYY-MM-DD): 2026-02-01
-Task Description (optional): Buy fruits and vegetables
-```
-
-**Listing Tasks:**
+**Alias:** `sr`
+**Description:** Search tasks by keyword in title or description.
 
 ```bash
-tn ls
-```
-
-```
-┌─┬────┬────────────────┬─────────────┬─────────┬────────────┬─────────────────────────────┐
-│#│ ID │ Title          │ Status      │ Priority│ DueDate    │ Description                 │
-├─┼────┼────────────────┼─────────────┼─────────┼────────────┼─────────────────────────────┤
-│1│ 1  │ Buy groceries  │ todo        │ medium  │ 2026-02-01 │ Buy fruits and vegetables  │
-└─┴────┴────────────────┴─────────────┴─────────┴────────────┴─────────────────────────────┘
-```
-
-**Updating a Task:**
+tn search --find "keyword"
 
-```bash
-tn up
 ```
 
-**Deleting a Task:**
-
-```bash
-tn del
-```
+![Search Tasks](src/images/searchWith.png "Searching Tasks")
 
-**Undo Last Deleted Task:**
+---
 
-```bash
-tn un
-```
+### 8. Sort Tasks
 
-**Search Tasks:**
+**Alias:** `so`
+**Description:** Sort tasks by due date, priority, or status.
 
 ```bash
-tn sr groceries
-```
-
-**Sort Tasks:**
+tn so --by priority
 
-```bash
-tn so
 ```
 
-* Select `dueDate`, `priority`, or `status` interactively
-* Or use `--by` option: `tn so --by priority`
-
----
-
-## Notes
-
-* All selection prompts use **arrow keys** in terminal.
-* Task table always shows **numbered index (`#`) starting from 1**.
-* Status and priority are displayed in **colors** for better readability.
-
----
-
----
-
-## Demo
-
-**All Features:**
-
-![All Features](src/images/allFeatures.png "all commands")
-
-**Adding a Task:**
-
-![Add Task](src/images/addNew.png "Adding a Task in TaskNinja CLI")
-
-**Listing Tasks:**
-
-![List Tasks](src/images/listAll.png "Listing Tasks in TaskNinja CLI")
-
-**Updating a Task:**
-
-![Update Task](src/images/updateWith.png "Updating a Task")
-
-**Deleting a Task:**
-
-![Delete Task](src/images/deleteMethod.png "Deleting a Task")
-
-**Restore Last-Deleted Task:**
-
-![Undo](src/images/undoMethod.png "Restore Last-deleted task")
-
-**Search / Sort Tasks:**
-
-![Search Tasks](src/images/searchWith.png "Searching Tasks")
 ![Sort Tasks](src/images/sort_.png "Sorting Tasks")
-![Sort Tasks-2](src/images/sortBy.png "Sorting Tasks")
-
-**Mark as Done:**
 
-![Mark Task As Done](src/images/doneTask.png "Mark as Done In one step")
-![Mark Task As Done](src/images/doneTask2.png "Mark as Done In one step")
+![Sort Tasks-2](src/images/sortBy.png "Sorting Tasks")
 
-**Tasks in `todos.json`:**
+---
 
-![todos.json](src/images/todo.json.png "shape of tasks")
+## Task Fields & Allowed Values
 
+| Field | Allowed Values / Description | Requirement |
+| --- | --- | --- |
+| **Title** | Any non-empty string | Required |
+| **Status** | `todo` | `in-progress` | `done` | Required |
+| **Priority** | `low` | `medium` | `high` | Required |
+| **Due Date** | Date in `YYYY-MM-DD` format | Required |
+| **Description** | Any text providing task details | Optional |
 
 ---
 
-## New Additions for Version `1.1.6`
-
-**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
-* default setter for date
+## New Features in Version 1.1.7
 
-### SOON
-**Auto Deleted Task:**
+### Smart Cancellation (Ctrl+C)
 
-* 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
+Operations can now be cancelled using the standard `Ctrl+C` shortcut. This provides a clean exit without overlapping text in the terminal, ensuring a professional user experience.
 
+### Auto-Delete & Expiration
 
+* **Auto-Cleanup:** The CLI automatically deletes `todos.json` or `deleted-todos.json` if they become empty to save space and keep the directory clean.
+* **Timed Expiration:** Deleted tasks are stored in `deleted-todos.json` for exactly **60 seconds**. After this period, they are automatically purged to manage storage efficiently.
 
+### Tasks in todos.json
+![todos.json](src/images/todo.json.png "shape of stored tasks")
+---

package/index.js

@@ -0,0 +1,108 @@
+#! /usr/bin/env node
+
+/**
+ * TASKNINJA -
+ * Task Manager CLI Application
+ * This application allows users to manage their tasks via command line interface.
+ * It supports adding, listing, and removing tasks.
+ * Dependencies:
+ * - commander: For command line argument parsing
+ * - inquirer: For interactive prompts
+ * - fs: For file system operations
+ * Author: Mohamed Bakr
+ * Date: January 2026
+ * Version: 1.1.5
+ * @license MIT
+ * Copyright (c) 2026 Mohamed Bakr
+ * @MoBMoCaffeine
+ */
+
+// for using commands in terminal
+import { Command } from "commander";
+
+import { addAction } from "./src/commands/addCommand.js";
+import { listAction } from "./src/commands/listCommand.js";
+import { updateAction } from "./src/commands/updateCommand.js";
+import { doneAction } from "./src/commands/doneCommand.js";
+import { deleteAction } from "./src/commands/deleteCommand.js";
+import { undoAction } from "./src/commands/undoCommand.js";
+import { searchAction } from "./src/commands/searchCommand.js";
+import { sortAction } from "./src/commands/sortCommand.js";
+// assigning Commander to a variable
+const program = new Command();
+
+// setting up
+program
+    .name("taskninja")
+    .description("A simple CLI application to manage your tasks")
+    .version("1.1.7");
+
+// use command 'add' with title + status + priority + dueDate + description and action
+program
+    .command('add')
+    .alias('a')
+    .description('Add a new task')
+    .action(addAction);
+
+
+// use command 'list' with optional status filter and action
+program
+    .command('list')
+    .alias('ls')
+    .description('List all tasks')
+    .option('-s, --status <status>', 'Filter tasks by status (todo, in-progress, done)')
+    .action( listAction );
+
+
+
+// use command 'search' to find tasks by keyword in title or description
+program
+    .command('search [keyword]')
+    .alias('sr')
+    .option('-f, --find <keyword>', 'Keyword to search in title or description')
+    .description('Search tasks by keyword in title or description')
+    .action( searchAction );
+
+// use command 'sort' to sort tasks by due date, priority, or status
+program
+    .command('sort')
+    .alias('so')
+    .option('--by <criteria>', 'Sort tasks by criteria (dueDate, priority, status)')
+    .description('Sort tasks by due date, priority, or status')
+    .action( sortAction );
+
+
+// use command 'update' with task ID and action
+program 
+    .command('update')
+    .alias('up')
+    .description('Update a task by ==> ID <==')
+    .action( updateAction );
+
+
+// use command 'done' with task ID instead of 'update' + confirm to mark task as done
+program
+    .command('done')
+    .description('Mark a task as done by ==> ID <==')
+    .action( doneAction );
+
+
+
+// use command 'delete' with task ID and action
+program
+    .command('delete')
+    .alias('del')
+    .description('delete a task by ==> ID <==')
+    .action( deleteAction );
+
+// use command 'undo' to restore last deleted task
+program
+.command('undo')
+.alias('un')
+.description('Undo the last deleted task')
+.action( undoAction );
+
+
+
+// parse command line arguments
+program.parse(process.argv);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "taskninja",
-  "version": "1.1.6",
+  "version": "1.1.7",
   "description": "a simple CLI application with JS as a (To-Do Application)",
   "main": "./src/index.js",
   "type": "module",
@@ -10,8 +10,8 @@
     "dev": "node src/index.js"
   },
   "bin": {
-    "dotask": "./src/index.js",
-    "taskninja": "./src/index.js",
+    "dotask": "./index.js",
+    "taskninja": "./index.js",
     "tn": "./src/index.js"
   },
   "repository": {

package/src/commands/addCommand.js

@@ -0,0 +1,79 @@
+import inquirer from "inquirer";
+import chalk from "chalk";
+import { loadTasks, saveTasks, getNextId } from "../utils/taskService.js";
+import { validateDueDate, ALLOWED_PRIORITIES, ALLOWED_STATUSES } from "../utils/validators.js";
+import { cleanupAndExit } from '../helpers/helpers.js';
+
+export const addAction = async () => {
+    try {
+        const answers = await inquirer.prompt([
+            {
+                type: 'input',
+                name: 'title',
+                message: 'Task Title:',
+                validate: input => input ? true : 'Title cannot be empty!'
+            },
+            {
+                type: 'rawlist',
+                name: 'status',
+                message: 'Task Status:',
+                choices: ALLOWED_STATUSES,
+                default: 'todo'
+            },
+            {
+                type: 'rawlist',
+                name: 'priority',
+                message: 'Task Priority:',
+                choices: ALLOWED_PRIORITIES,
+                default: 'medium'
+            },
+            {
+                type: 'input',
+                name: 'dueDate',
+                message: 'Due Date (YYYY-MM-DD):',
+                default: () => {
+                    const today = new Date();
+                    return today.toISOString().split('T')[0];
+                },
+                filter: (input) => {
+                    const trimmed = input.trim();
+                    if (!trimmed) {
+                        return new Date().toISOString().split('T')[0];
+                    }
+                    return trimmed;
+                },
+                validate: input => {
+                    try {
+                        validateDueDate(input);
+                        return true;
+                    } catch (error) {
+                        return error.message;
+                    }
+                }
+            },
+            {
+                type: 'input',
+                name: 'description',
+                message: 'Task Description (optional):'    
+            },
+        ]);
+
+        const tasks = await loadTasks();
+        const newTask = {
+            id: getNextId(tasks),
+            title: answers.title,
+            status: answers.status,
+            priority: answers.priority,
+            dueDate: answers.dueDate,
+            description: answers.description || ''
+        };
+
+        tasks.push(newTask);
+        await saveTasks(tasks);
+        console.log(chalk.green('Task added successfully!'));
+    } catch (error) {
+        console.log(chalk.yellow('\nOperation Cancelled!'));
+    } finally {
+        cleanupAndExit(0);
+    }
+};