@pragati1610/tasks
v1.0.1
Published
A CLI tool to create and manage your tasks.
Downloads
1
Readme
Getting started
Install Node.js: You need to have npm installed in your computer for this problem. It comes with Node.js and you can get it by installing Node from https://nodejs.org/en/
Install dependencies
npm install
- Create a symbolic link to the executable file
npm link
Once you are done with the changes you should be able to execute the task app by running the following command from the terminal.
./task
Try running tests.
- Now run
npm test
. - Expected behavior: all tests pass
Specifications
The app can be run in the console with
./task
.The app should reads from and writes to a task.txt text file. Each task occupies a single line in this file. Each line in the file is in this format :
p task
where
p
is the priority ( priority will be a number) andtask
is the task description.Priority denotes how important a task is, if it is a high priority task, it should be completed earlier. Priority is denoted using an integer, the lower the number, the higher the priority.
Here is an example file that has 2 items.
1 Buy milk 2 Complete the project
Completed task are writted to a completed.txt file. Each task occupies a single line in this file. Each line in the file is in this format :
task
where task is the task description.
Here is an example file that has 2 items.
Buy milk Complete the project
Priority can be any integer greater than or equal to 0. 0 being the highest priority
If two task have the same priority, the task that was added first is displayed first.
The files is always sorted in order of the priority, ie, the task with the highest priority should be first item in the file.
$ cd /path/to/plans $ /path/to/apps/task ls
Usage
1. Help
Executing the command without any arguments, or with a single argument help prints the CLI usage.
$ ./task help
Usage :-
$ ./task add 2 hello world # Add a new item with priority 2 and text "hello world" to the list
$ ./task ls # Show incomplete priority list items sorted by priority in ascending order
$ ./task del INDEX # Delete the incomplete item with the given index
$ ./task done INDEX # Mark the incomplete item with the given index as complete
$ ./task help # Show usage
$ ./task report # Statistics
2. List all pending items
Use the ls command to see all the items that are not yet complete, in ascending order of priority.
Every item should be printed on a new line. with the following format
[index] [task] [priority]
Example:
$ ./task ls
1. change light bulb [2]
2. water the plants [5]
index starts from 1, this is used to identify a particular task to complete or delete it.
3. Add a new item
Use the add command. The text of the task should be enclosed within double quotes (otherwise only the first word is considered as the item text, and the remaining words are treated as different arguments).
$ ./task add 5 "the thing i need to do"
Added task: "the thing i need to do" with priority 5
4. Delete an item
Use the del command to remove an item by its index.
$ ./task del 3
Deleted item with index 3
Attempting to delete a non-existent item should display an error message.
$ ./task del 5
Error: item with index 5 does not exist. Nothing deleted.
5. Mark a task as completed
Use the done command to mark an item as completed by its index.
$ ./task done 1
Marked item as done.
Attempting to mark a non-existed item as completed will display an error message.
$ ./task done 5
Error: no incomplete item with index 5 exists.
6. Generate a report
Show the number of complete and incomplete items in the list. and the complete and incomplete items grouped together.
$ ./task report
Pending : 2
1. this is a pending task [1]
2. this is a pending task with priority [4]
Completed : 3
1. completed task
2. another completed task
3. yet another completed task