taskninja 1.0.2 → 1.0.4

package/README.md

@@ -1,30 +1,23 @@
-# TaskNinja
-
-![TaskNinja Logo](https://via.placeholder.com/150?text=TaskNinja) <!-- Optional: Replace with actual logo if available -->
-
-A simple Command-Line Interface (CLI) application built with JavaScript for managing your to-do tasks. It allows users to add, list, update, and delete tasks interactively, with features like status tracking, priority levels, due dates, and descriptions. Tasks are stored in a local JSON file for persistence.
 
-This project is designed for developers and users who prefer a lightweight, terminal-based task manager without the need for complex setups or databases.
-
-## Features
+# TaskNinja
 
-- **Add Tasks**: Create new tasks with title, status (todo, in-progress, done), priority (low, medium, high), due date, and optional description.
-- **List Tasks**: View all tasks or filter by status in a tabular format.
-- **Update Tasks**: Change the status of existing tasks via interactive selection.
-- **Delete Tasks**: Remove tasks with confirmation to prevent accidental deletion.
-- **Persistent Storage**: Tasks are saved to a local `todos.json` file.
-- **Interactive Prompts**: Uses Inquirer for user-friendly input.
-- **Validation**: Ensures valid statuses, priorities, and date formats.
+**Version:** 1.0.4  
+**Description:** A simple CLI To-Do Application to manage your tasks directly from the terminal.  
 
-## Technologies Used
+---
 
-- **Node.js**: Runtime environment.
-- **Commander**: For parsing command-line arguments and defining commands.
-- **Inquirer**: For interactive CLI prompts.
-- **fs/promises**: For asynchronous file system operations to handle task storage.
-- **ECMAScript Modules (ESM)**: Modern JavaScript module system.
+## Table of Contents
+- [Installation](#installation)
+- [Running the CLI](#running-the-cli)
+- [Commands](#commands)
+  - [Add Task](#add-task)
+  - [List Tasks](#list-tasks)
+  - [Update Task](#update-task)
+  - [Delete Task](#delete-task)
+- [Task Fields & Allowed Values](#task-fields--allowed-values)
+- [Examples](#examples)
 
-The application is written in pure JavaScript (ES6+), with no additional frameworks or databases required.
+---
 
 ## Installation
 
@@ -36,198 +29,221 @@ TaskNinja is published on npm as `taskninja`. Install it globally to use the CLI
 npm install -g taskninja
 ```
 
-After installation, you can run the CLI using the `dotask` command (as defined in `package.json`).
-
-### From Source
-
-1. Clone the repository:
-   ```bash
-   git clone https://github.com/yourusername/taskninja.git
-   cd taskninja
-   ```
-
-2. Install dependencies:
-   ```bash
-   npm install
-   ```
-
-3. Link the CLI globally (optional, for testing):
-   ```bash
-   npm link
-   ```
-
-4. Run the application:
-   ```bash
-   npm start
-   ```
-   Or directly:
-   ```bash
-   node app.js
-   ```
-
-## Usage
-
-Run the CLI with the `dotask` command (after global installation) or `node app.js` from the source.
-
-### Commands
-
-- **Add a Task**:
-  ```bash
-  dotask add
-  ```
-  - This will prompt you interactively for title, status, priority, due date, and description.
-  - Example output: "Task added successfully!"
-
-- **List Tasks**:
-  ```bash
-  dotask list
-  ```
-  - Lists all tasks in a table format.
-  - Optional filter by status: `dotask list --status todo` (or `-s todo`).
-  - Aliases: `dotask ls`.
-
-- **Update a Task**:
-  ```bash
-  dotask update
-  ```
-  - Prompts to select a task by ID and update its status.
-  - Displays the updated task in a table.
-  - Aliases: `dotask up`.
-
-- **Delete a Task**:
-  ```bash
-  dotask delete
-  ```
-  - Prompts to select a task by ID and confirm deletion.
-  - Aliases: `dotask del`.
-
-- **Help**:
-  ```bash
-  dotask --help
-  ```
-  - Shows all available commands and options.
-
-- **Version**:
-  ```bash
-  dotask --version
-  ```
-  - Displays the current version (1.0.0).
-
-### Examples
-
-1. Adding a task:
-   ```
-   dotask add
-   ```
-   - Follow prompts: Enter "Buy groceries" as title, select "todo" status, "medium" priority, "2024-12-31" due date, and "Milk, eggs, bread" as description.
-
-2. Listing tasks filtered by status:
-   ```
-   dotask list -s in-progress
-   ```
-
-3. Updating a task:
-   ```
-   dotask update
-   ```
-   - Select task ID from the list and choose new status (e.g., "done").
-
-4. Deleting a task:
-   ```
-   dotask delete
-   ```
-   - Select task ID and confirm.
-
-Tasks are stored in `./todos.json` relative to where the command is run. Ensure write permissions in the directory.
-
-## Configuration
-
-- **Task File**: Defaults to `./todos.json`. You can modify `TASKS_FILE` in `app.js` if needed.
-- **Statuses**: Limited to "todo", "in-progress", "done".
-- **Priorities**: Limited to "low", "medium", "high".
-- **Due Date Format**: YYYY-MM-DD (validated during input).
-
-No external configuration files are required.
-
-## Development
-
-To run in development mode:
+or use it instantly with:
+```bash
+npx taskninja
+```
+
+and then use it:
+```bash
+npx taskninja <command>
+```
+
+After installation, you can run the CLI using the `dotask` or `taskninja` or `tn` command (as defined in `package.json`).
+
+Clone the repository and install dependencies:
+
+```bash
+git clone <your-repo-url>
+cd taskninja
+npm install
+````
+
+---
+
+## Running the CLI
+
+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>
+```
+
+Replace `<command>` with any of the available commands: `add`, `list`, `update`, `delete`.
+
+---
+
+## Commands
+
+### 1. Add Task
+
+**Alias:** `a`
+**Description:** Add a new task interactively.
+
+```bash
+node app.js add
+# or
+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 using arrows:
+
+   * low
+   * medium
+   * high
+4. **Due Date:** Enter in `YYYY-MM-DD` format. Invalid dates will show a validation error.
+5. **Description:** Optional text.
+
+**Expected Behavior:**
+
+* Task is saved in `todos.json`.
+* Confirmation message: `Task added successfully!`
+
+---
+
+### 2. List Tasks
+
+**Alias:** `ls`
+**Description:** List all tasks, optionally filtered by status.
+
+```bash
+node app.js list
+# or
+tn ls
+```
+
+**Optional Status Filter:**
+
 ```bash
-npm run dev
+node app.js list --status todo
 ```
 
-This executes `node app.js` for quick testing.
+**Behavior:**
 
-### Scripts
+* Displays tasks in a table with columns:
 
-- `npm start`: Runs the app.
-- `npm test`: Placeholder for tests (currently errors out; add tests as needed).
+| # | ID | Title | Status | Priority | DueDate | Description |
+| - | -- | ----- | ------ | -------- | ------- | ----------- |
 
-## Contribution Guidelines
+* Numbered index (`#`) starts from 1.
 
-We welcome contributions to improve TaskNinja! Whether it's bug fixes, new features, or documentation enhancements, follow these steps:
+---
 
-### How to Contribute
+### 3. Update Task
 
-1. **Fork the Repository**:
-   - Go to the [GitHub repo](https://github.com/yourusername/taskninja) and click "Fork".
+**Alias:** `up`
+**Description:** Update an existing task by selecting its ID.
 
-2. **Clone Your Fork**:
-   ```bash
-   git clone https://github.com/yourusername/taskninja.git
-   cd taskninja
-   ```
+```bash
+node app.js update
+# or
+tn up
+```
 
-3. **Create a Branch**:
-   - Use a descriptive name: `git checkout -b feature/new-feature` or `git checkout -b fix/bug-fix`.
+**Steps:**
 
-4. **Make Changes**:
-   - Follow the existing code style (ESLint can be added later for consistency).
-   - Add or update tests if applicable.
-   - Ensure your code handles errors gracefully and maintains validation logic.
+1. Select task by ID from a list (use arrows).
+2. Confirm which fields to change (title, status, priority, due date, description).
+3. Enter new values where applicable (status/priority selections use arrows).
 
-5. **Commit Changes**:
-   - Use clear commit messages: e.g., "feat: add search functionality" or "fix: resolve date validation issue".
-   - Reference issues if relevant: e.g., "Closes #123".
+**Behavior:**
 
-6. **Push to Your Fork**:
-   ```bash
-   git push origin feature/new-feature
-   ```
+* Only fields selected for change are updated.
+* Confirmation message: `Task updated successfully!`
+* Shows updated task table.
 
-7. **Open a Pull Request (PR)**:
-   - Go to the original repo and click "New Pull Request".
-   - Provide a detailed description of your changes, including why they're needed and any relevant screenshots.
-   - Link to any related issues.
+---
 
-### Guidelines
+### 4. Delete Task
 
-- **Code Style**: Use consistent indentation (2 spaces), semicolons, and follow ES6+ best practices.
-- **Testing**: Add unit tests using a framework like Jest if expanding features. Currently, no tests are implemented—contributions here are encouraged!
-- **Dependencies**: Keep them minimal. Justify any new additions.
-- **Features**: New commands or options should align with the simple CLI philosophy. Discuss major changes in an issue first.
-- **Documentation**: Update README.md with any new features or changes.
-- **Issues**: Check for existing issues before creating a new one. Use labels like "bug", "enhancement", or "question".
+**Alias:** `del`
+**Description:** Delete a task by selecting its ID.
 
-### Code of Conduct
+```bash
+node app.js delete
+# or
+tn del
+```
 
-- Be respectful and inclusive.
-- No harassment or discrimination.
-- Report issues to the maintainer (Mohamed Bakr).
+**Steps:**
 
-By contributing, you agree that your contributions will be licensed under the ISC License.
+1. Select task by ID from a list (use arrows).
+2. Confirm deletion.
 
-## License
+**Behavior:**
 
-This project is licensed under the ISC License.
+* Task is removed from `todos.json`.
+* Confirmation message: `Task deleted successfully!`
+* Shows updated task table.
+
+---
+
+## 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                |
+
+---
+
+## Examples
+
+**Adding a Task:**
+
+```bash
+tn a
+```
 
-## Author
+```
+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:**
+
+```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:**
+
+```bash
+tn up
+```
+
+* Select task ID → confirm fields → update values
+* Shows updated table.
+
+**Deleting a Task:**
+
+```bash
+tn del
+```
 
-- **Mohamed Bakr** - Just a Developer - [GitHub Profile](https://github.com/MoBMoCaffeine)
+* Select task ID → confirm deletion → updated table shown
 
-## Acknowledgments
+---
 
-- Inspired by simple CLI tools like Todoist CLI.
-- Thanks to the open-source community for libraries like Commander and Inquirer.
+## Notes
 
-If you encounter issues or have suggestions, open an issue on GitHub!
+* All selection prompts (`status`, `priority`, task selection) use arrow keys in terminal.
+* Task table always shows numbered index (`#`) starting from 1 for easy reference.

package/app.js

@@ -1,5 +1,4 @@
 #! /usr/bin/env node
-
 /**
  * Task Manager CLI Application
  * This application allows users to manage their tasks via command line interface.
@@ -17,70 +16,28 @@
 import { Command } from "commander";
 // for interactive command line prompts
 import inquirer from "inquirer";
-// for file system operations
-import fs from "fs/promises";
 
 // assigning Commander to a variable
 const program = new Command();
 
-// file to store tasks
-const TASKS_FILE = "./todos.json";
-// allowed task statuses
-const ALLOWED_STATUSES = ["todo", "in-progress", "done"];
-// allowed task priorities
-const ALLOWED_PRIORITIES = ["low", "medium", "high"];
-
-
-// function to load tasks from file
-const loadTasks = async () => {
-    try{
-        const data = await fs.readFile(TASKS_FILE, 'utf8');
-        return JSON.parse(data);
-    } catch (error) {
-        if (error.code === 'ENOENT') return [];
-        throw error;
-    }
-};
-// function to save tasks to file
-const saveTasks = async (tasks) => {
-    await fs.writeFile(TASKS_FILE, JSON.stringify(tasks, null, 2));
-};
-// get next task ID
-const getNextId = (tasks) => {
-    return tasks.length > 0 ? Math.max(...tasks.map(task => task.id)) + 1 : 1;
-};
-// validate task status
-const validateStatus = (status) => {
-    if (!ALLOWED_STATUSES.includes(status)) {
-        throw new Error(`Invalid status. Allowed statuses are: ${ALLOWED_STATUSES.join(", ")}`);
-    }
-};
-// validate task priority
-const validatePriority = (priority) => {
-    if (!ALLOWED_PRIORITIES.includes(priority)) {
-        throw new Error(`Invalid priority. Allowed priorities are: ${ALLOWED_PRIORITIES.join(", ")}`);
-    }  
-};
-// verify due date format
-const validateDueDate = (dueDate) => {
-    if (isNaN(Date.parse(dueDate))) {
-        throw new Error("Invalid due date. Please use a valid date format (YYYY-MM-DD).");
-    }
-};
+// importing validators and allowed values
+import { validateDueDate, ALLOWED_PRIORITIES, ALLOWED_STATUSES } from "./validators.js";
+// importing task service functions
+import { loadTasks, saveTasks, getNextId } from "./taskService.js";
 
 
 // setting up
 program
     .name("todo-cli")
     .description("A simple CLI application to manage your tasks")
-    .version("1.0.0");
+    .version("1.0.4");
 
 // use command 'add' with title + status + priority + dueDate + description and action
 program
     .command('add')
     .alias('a')
     .description('Add a new task')
-    .action(async (title, status, priority, dueDate, description = "") => {
+    .action(async () => {
         const answers = await inquirer.prompt([
             {
                 type: 'input',
@@ -89,14 +46,14 @@ program
                 validate : input => input ? true : 'Title cannot be empty!'
             },
             {
-                type: 'list',
+                type: 'rawlist',
                 name: 'status',
                 message : 'Task Status:',
                 choices : ALLOWED_STATUSES,
                 default : 'todo'
             },
             {
-                type: 'list',
+                type: 'rawlist',
                 name: 'priority',
                 message : 'Task Priority:',
                 choices : ALLOWED_PRIORITIES,
@@ -146,7 +103,7 @@ program
     .command('list')
     .alias('ls')
     .description('List all tasks')
-    .option('-s, --status <status>', 'Filter tasks by status')
+    .option('-s, --status <status>', 'Filter tasks by status (todo, in-progress, done)')
     .action(async (options) => {
         let tasks = await loadTasks();
 
@@ -162,7 +119,8 @@ program
             return;
         }
        // map all tasks to displayable objects
-        const tableData = tasks.map(task => ({
+        const tableData = tasks.map((task, index) => ({
+            '#': index + 1,
             ID: task.id,
             Title: task.title,
             Status: task.status,
@@ -179,7 +137,7 @@ program
 program 
     .command('update')
     .alias('up')
-    .description('Update a task by ID')
+    .description('Update a task by ==> ID <==')
     .action(async () =>{
         const tasks = await loadTasks();
         if (tasks.length === 0) {
@@ -189,46 +147,148 @@ program
 
         const { id } = await inquirer.prompt([
             {
-                type: 'list',
+                type: 'rawlist',
                 name: 'id',
-                message: 'Select the task to update:',
+                message: 'Select the task to update (By ID):',
                 choices: tasks.map(task => ({ name: `${task.id}: ${task.title}`, value: task.id }))
             }
         ]);
-        const { status } = await inquirer.prompt([
-            {
-                type: 'list',
-                name: 'status',
-                message: 'Select the new status:',
-                choices: ALLOWED_STATUSES
-            }
-        ]);
 
+        // find the task to update
         const task = tasks.find(t => t.id === Number(id));
         if (!task) {
             console.error('Task not found!');
             return;
         }
-        task.status = status;
 
-        await saveTasks(tasks);
-        console.log('Task updated successfully!');
+        const answers = await inquirer.prompt([
+      // for title
+        {
+            type: 'confirm',
+            name: 'changeTitle',
+            message: 'Do you want to change the title?',
+            default: false
+        },
+        {
+            type: 'input',
+            name: 'title',
+            message: 'Enter the new title:',
+            when: answers => answers.changeTitle,
+            validate: input => input ? true : 'Title cannot be empty!'
+        },
+
+      // for status
+        {
+            type: 'confirm',
+            name: 'changeStatus',
+            message: 'Do you want to change the status?',
+            default: false
+        },
+        {
+            type: 'rawlist',
+            name: 'status',
+            message: 'Select the new status:',
+            choices: ALLOWED_STATUSES,
+            when: answers => answers.changeStatus
+        },
+
+      // for priority
+        {
+            type: 'confirm',
+            name: 'changePriority',
+            message: 'Do you want to change the priority?',
+            default: false
+        },
+        {
+            type: 'rawlist',
+            name: 'priority',
+            message: 'Select the new priority:',
+            choices: ALLOWED_PRIORITIES,
+            when: answers => answers.changePriority
+        },
+
+      // for due date
+        {
+            type: 'confirm',
+            name: 'changeDueDate',
+            message: 'Do you want to change the due date?',
+            default: false
+        },
+        {
+            type: 'input',
+            name: 'dueDate',
+            message: 'Enter the new due date (YYYY-MM-DD):',
+            when: answers => answers.changeDueDate,
+            validate: input => {
+                try {
+                    validateDueDate(input);
+                    return true;
+                } catch (error) {
+                    return error.message;
+                }
+            }
+        },
+
+      // for description
+        {
+            type: 'confirm',
+            name: 'changeDescription',
+            message: 'Do you want to change the description?',
+            default: false
+        },
+        {
+            type: "rawlist",
+            name: 'description',
+            message: 'Enter the new description:',
+            when: answers => answers.changeDescription
+        }
+    ]);
+
+    // apply updates only if user chose to change them
+    if (answers.changeTitle) task.title = answers.title;
+    if (answers.changeStatus) task.status = answers.status;
+    if (answers.changePriority) task.priority = answers.priority;
+    if (answers.changeDueDate) task.dueDate = answers.dueDate;
+    if (answers.changeDescription)
+        task.description = answers.description || '';
+
+    // is there any change?
+    const hasChanges = [
+            answers.changeTitle,
+            answers.changeStatus,
+            answers.changePriority,
+            answers.changeDueDate,
+            answers.changeDescription
+        ].some(Boolean);
 
-        console.table([{
+        if (!hasChanges) {
+            console.log('No changes were made.');
+        }else {
+            // save updated tasks to file
+            await saveTasks(tasks);
+            console.log('Task updated successfully!');
+        }
+    
+        const tableData = tasks.map((task, index) => ({
+            '#': index + 1,
             ID: task.id,
             Title: task.title,
             Status: task.status,
             Priority: task.priority,
             DueDate: task.dueDate,
             Description: task.description || ''
-        }]);
+        }));
+
+        // display all tasks in table format
+        console.table(tableData);
     });
 
+
 // use command 'delete' with task ID and action
 program
     .command('delete')
     .alias('del')
-    .description('delete a task by ID')
+    .description('delete a task by ==> ID <==')
     .action(async () => {
         const tasks = await loadTasks();
         if (tasks.length === 0) {
@@ -238,7 +298,7 @@ program
 
         const { id } = await inquirer.prompt([
             {
-                type: 'list',
+                type: 'rawlist',
                 name: 'id',
                 message: 'Select the task to delete:',
                 choices: tasks.map(task => ({ name: `${task.id}: ${task.title}`, value: task.id }))
@@ -258,18 +318,22 @@ program
             return;
         }
 
-        const newTasks = tasks.filter(t => t.id !== id);
+        const newTasks = tasks.filter(t => t.id !== Number(id));
         await saveTasks(newTasks);
         console.log('Task deleted successfully!');
 
-        console.table([{
+        const tableData = newTasks.map((task, index) => ({
+            '#': index + 1,
             ID: task.id,
             Title: task.title,
             Status: task.status,
             Priority: task.priority,
             DueDate: task.dueDate,
             Description: task.description || ''
-        }]);
+        }));
+
+        // display all tasks in table format
+        console.table(tableData);
     });
 
 // parse command line arguments

package/package.json

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

package/taskService.js

@@ -0,0 +1,25 @@
+// for file system operations
+import fs from "fs/promises";
+
+
+// file to store tasks
+const TASKS_FILE = "./todos.json";
+
+// function to load tasks from file
+export const loadTasks = async () => {
+    try{
+        const data = await fs.readFile(TASKS_FILE, 'utf8');
+        return JSON.parse(data);
+    } catch (error) {
+        if (error.code === 'ENOENT') return [];
+        throw error;
+    }
+};
+// function to save tasks to file
+export const saveTasks = async (tasks) => {
+    await fs.writeFile(TASKS_FILE, JSON.stringify(tasks, null, 2));
+};
+// get next task ID
+export const getNextId = (tasks) => {
+    return tasks.length > 0 ? Math.max(...tasks.map(task => task.id)) + 1 : 1;
+};

package/todos.json

@@ -0,0 +1 @@
+[]

package/validators.js

@@ -0,0 +1,26 @@
+
+// allowed task statuses
+const ALLOWED_STATUSES = ["todo", "in-progress", "done"];
+// allowed task priorities
+const ALLOWED_PRIORITIES = ["low", "medium", "high"];
+
+// validate task status
+export const validateStatus = (status) => {
+    if (!ALLOWED_STATUSES.includes(status)) {
+        throw new Error(`Invalid status. Allowed statuses are: ${ALLOWED_STATUSES.join(", ")}`);
+    }
+};
+// validate task priority
+export const validatePriority = (priority) => {
+    if (!ALLOWED_PRIORITIES.includes(priority)) {
+        throw new Error(`Invalid priority. Allowed priorities are: ${ALLOWED_PRIORITIES.join(", ")}`);
+    }  
+};
+// verify due date format
+export const validateDueDate = (dueDate) => {
+    if (isNaN(Date.parse(dueDate))) {
+        throw new Error("Invalid due date. Please use a valid date format (YYYY-MM-DD).");
+    }
+};
+
+export { ALLOWED_PRIORITIES, ALLOWED_STATUSES };