Todo List CLI application using Node.js
Last Updated :
01 Aug, 2024
CLI is a very powerful tool for developers. We will be learning how to create a simple Todo List application for command line. We have seen TodoList as a beginner project in web development and android development but a CLI app is something we don't often hear about.
Pre-requisites:
- A recent version of Node.js downloaded and installed.
- A text editor, for example, VSCode, atom, etc.
- NPM should be installed.
- Basic understanding of JavaScript, es6 features, etc.
Create a new directory by mkdir <dir-name> and initiate an empty node project by cd into the directory and type the command npm init.
Note: We won't be using any third-party module in this project.
Project Directory: Now the project directory should consist of two files, package.json, and index.js as shown below:
Some basic functionalities in our Todo List App will be the following:
Implementation:
Create an index.js file and write down the following code into it
JavaScript
// Requiring module
const fs = require('fs');
// Accessing arguments
const args = process.argv;
// The "index.js" is 8 characters long
// so -8 removes last 8 characters
const currentWorkingDirectory = args[1].slice(0, -8);
Explanation: We will be writing todo Tasks in a file called todo.txt and when they will be completed they will be erased from todo.txt and will be written in done.txt. The report will show how many todo has been completed and how many are left. To start with, we will import the fs module which will give us access to the file system.
Then, we will get the arguments passed using process.argv and store them in a variable named args. The process.argv returns an array in which there is the location of node modules, current working directory, and further arguments passed. We will retrieve the cwd by removing the name of the file.
Next, we will check if todo.txt and done.txt already exist in cwd, if not we will create them as shown below:
JavaScript
if (fs.existsSync(currentWorkingDirectory + 'todo.txt') === false) {
let createStream = fs.createWriteStream('todo.txt');
createStream.end();
}
if (fs.existsSync(currentWorkingDirectory + 'done.txt') === false) {
let createStream = fs.createWriteStream('done.txt');
createStream.end();
}
Now we will create different functions for displaying usage, adding todo, deleting todo, etc. They will be called based on the arguments passed.
Info Function:
It will display the usage format. It will be called when help is passed as an argument or when no argument is passed.
JavaScript
const InfoFunction = () => {
const UsageText = `
Usage :-
$ node index.js add "todo item" # Add a new todo
$ node index.js ls # Show remaining todos
$ node index.js del NUMBER # Delete a todo
$ node index.js done NUMBER # Complete a todo
$ node index.js help # Show usage
$ node index.js report # Statistics`;
console.log(UsageText);
};
List Function:
It will read the data from todo.txt and display them with a corresponding number. Most Recent is displayed on the top with the largest number.
JavaScript
const listFunction = () => {
// Create a empty array
let data = [];
// Read from todo.txt and convert it
// into a string
const fileData = fs.readFileSync(
currentWorkingDirectory + 'todo.txt')
.toString();
// Split the string and store into array
data = fileData.split('\n');
// Filter the string for any empty lines in the file
let filterData = data.filter(function (value) {
return value !== '';
});
if (filterData.length === 0) {
console.log('There are no pending todos!');
}
for (let i = 0; i < filterData.length; i++) {
console.log((filterData.length - i) + '. '
+ filterData[i]);
}
};
Add Function:
It will read the content from todo.txt, add the new todo, and then rewrite it in todo.txt.
Note: Since we don't have the functionality to set the pointer position in the file while writing and reading files in JavaScript, so every time we add new data we will have to read the data, make the modifications, and then re-write it back.
JavaScript
const addFunction = () => {
// New todo string argument is stored
const newTask = args[3];
// If argument is passed
if (newTask) {
// Create a empty array
let data = [];
// Read the data from file todo.txt and
// convert it in string
const fileData = fs
.readFileSync(currentWorkingDirectory + 'todo.txt')
.toString();
// New task is added to previous data
fs.writeFile(
currentWorkingDirectory + 'todo.txt',
newTask + '\n' + fileData,
function (err) {
// Handle if there is any error
if (err) throw err;
// Logs the new task added
console.log('Added todo: "' + newTask + '"');
},
);
} else {
// If argument was no passed
console.log('Error: Missing todo string. Nothing added!');
}
};
Delete Function:
It will read the data from todo.txt, remove the corresponding task, and re-write the data back in a file.
JavaScript
const deleteFunction = () => {
// Store which index is passed
const deleteIndex = args[3];
// If index is passed
if (deleteIndex) {
// Create a empty array
let data = [];
// Read the data from file and convert
// it into string
const fileData = fs
.readFileSync(currentWorkingDirectory + 'todo.txt')
.toString();
data = fileData.split('\n');
// Filter the data for any empty lines
let filterData = data.filter(function (value) {
return value !== '';
});
// If delete index is greater than no. of task
// or less than zero
if (deleteIndex > filterData.length || deleteIndex <= 0) {
console.log(
'Error: todo #' + deleteIndex
+ ' does not exist. Nothing deleted.',
);
} else {
// Remove the task
filterData.splice(filterData.length - deleteIndex, 1);
// Join the array to form a string
const newData = filterData.join('\n');
// Write the new data back in file
fs.writeFile(
currentWorkingDirectory + 'todo.txt',
newData,
function (err) {
if (err) throw err;
// Logs the deleted index
console.log('Deleted todo #' + deleteIndex);
},
);
}
} else {
// Index argument was no passed
console.log(
'Error: Missing NUMBER for deleting todo.');
}
};
Done Function:
This function will read data from todo.txt, split it into an array, store the task to be marked as done, delete it from todo.txt, re-write the data back to todo.txt. Now we will write the deleted task we stored along with the current date in done.txt.
JavaScript
const doneFunction = () => {
// Store the index passed as argument
const doneIndex = args[3];
// If argument is passed
if (doneIndex) {
// Empty array
let data = [];
// Create a new date object
let dateobj = new Date();
// Convert it to string and slice only the
// date part, removing the time part
let dateString = dateobj.toISOString().substring(0, 10);
// Read the data from todo.txt
const fileData = fs
.readFileSync(currentWorkingDirectory + 'todo.txt')
.toString();
// Read the data from done.txt
const doneData = fs
.readFileSync(currentWorkingDirectory + 'done.txt')
.toString();
// Split the todo.txt data
data = fileData.split('\n');
// Filter for any empty lines
let filterData = data.filter(function (value) {
return value !== '';
});
// If done index is greater than no. of task or <=0
if (doneIndex > filterData.length || doneIndex <= 0) {
console.log('Error: todo #'
+ doneIndex + ' does not exist.');
} else {
// Delete the task from todo.txt
// data and store it
const deleted = filterData.splice(
filterData.length - doneIndex, 1);
// Join the array to create a string
const newData = filterData.join('\n');
// Write back the data in todo.txt
fs.writeFile(
currentWorkingDirectory + 'todo.txt',
newData,
function (err) {
if (err) throw err;
},
);
// Write the stored task in done.txt
// along with date string
fs.writeFile(
currentWorkingDirectory + 'done.txt',
'x ' + dateString + ' ' + deleted
+ '\n' + doneData,
function (err) {
if (err) throw err;
console.log('Marked todo #'
+ doneIndex + ' as done.');
},
);
}
} else {
// If argument was not passed
console.log('Error: Missing NUMBER for'
+ ' marking todo as done.');
}
};
Report Function:
It will read data from todo.txt and done.txt, calculate the number of tasks in each and display how many tasks are completed and how many are pending.
JavaScript
const reportFunction = () => {
// Create empty array for data of todo.txt
let todoData = [];
// Create empty array for data of done.txt
let doneData = [];
// Create a new date object
let dateobj = new Date();
// Slice the date part
let dateString = dateobj.toISOString().substring(0, 10);
// Read data from both the files
const todo = fs.readFileSync(currentWorkingDirectory
+ 'todo.txt').toString();
const done = fs.readFileSync(currentWorkingDirectory
+ 'done.txt').toString();
// Split the data from both files
todoData = todo.split('\n');
doneData = done.split('\n');
let filterTodoData = todoData.filter(function(value) {
return value !== '';
});
let filterDoneData = doneData.filter(function(value) {
// Filter both the data for empty lines
return value !== '';
});
console.log(
dateString +
' ' +
'Pending : ' +
filterTodoData.length +
' Completed : ' +
filterDoneData.length,
// Log the stats calculated
);
};
Now Since we have created all the functions, Now we will just put a switch statement and call functions based on arguments passed.
JavaScript
switch (args[2]) {
case 'add': {
addFunction();
break;
}
case 'ls': {
listFunction();
break;
}
case 'del': {
deleteFunction();
break;
}
case 'done': {
doneFunction();
break;
}
case 'help': {
InfoFunction();
break;
}
case 'report': {
reportFunction();
break;
}
default: {
InfoFunction();
// We will display help when no
// argument is passed or invalid
// argument is passed
}
}
Filename: index.js Our final index.js file will look like the following:
JavaScript
const fs = require('fs');
const args = process.argv;
// The "index.js" is 8 characters long so -8
// removes last 8 characters
const currentWorkingDirectory = args[1].slice(0, -8);
if (fs.existsSync(currentWorkingDirectory +
'todo.txt') === false) {
let createStream = fs.createWriteStream('todo.txt');
createStream.end();
}
if (fs.existsSync(currentWorkingDirectory +
'done.txt') === false) {
let createStream = fs.createWriteStream('done.txt');
createStream.end();
}
const InfoFunction = () => {
const UsageText = `
Usage :-
$ node index.js add "todo item" # Add a new todo
$ node index.js ls # Show remaining todos
$ node index.js del NUMBER # Delete a todo
$ node index.js done NUMBER # Complete a todo
$ node index.js help # Show usage
$ node index.js report # Statistics`;
console.log(UsageText);
};
const listFunction = () => {
// Create a empty array
let data = [];
// Read from todo.txt and convert it into a string
const fileData = fs
.readFileSync(currentWorkingDirectory +
'todo.txt').toString();
// Split the string and store into array
data = fileData.split('\n');
// Filter the string for any empty lines in the file
let filterData = data.filter(function(value) {
return value !== '';
});
if (filterData.length === 0) {
console.log('There are no pending todos!');
}
for (let i = 0; i < filterData.length; i++) {
console.log((filterData.length - i) + '. ' +
filterData[i]);
}
};
const addFunction = () => {
// New todo string argument is stored
const newTask = args[3];
// If argument is passed
if (newTask) {
// create a empty array
let data = [];
// Read the data from file todo.txt and
// convert it in string
const fileData = fs
.readFileSync(currentWorkingDirectory +
'todo.txt').toString();
// New task is added to previous data
fs.writeFile(
currentWorkingDirectory + 'todo.txt',
newTask + '\n' + fileData,
function(err) {
// Handle if there is any error
if (err) throw err;
// Logs the new task added
console.log('Added todo: "' + newTask + '"');
},
);
} else {
// If argument was no passed
console.log('Error: Missing todo string.' +
' Nothing added!');
}
};
const deleteFunction = () => {
// Store which index is passed
const deleteIndex = args[3];
// If index is passed
if (deleteIndex) {
// Create a empty array
let data = [];
// Read the data from file and convert
// it into string
const fileData = fs
.readFileSync(currentWorkingDirectory +
'todo.txt').toString();
data = fileData.split('\n');
let filterData = data.filter(function(value) {
// Filter the data for any empty lines
return value !== '';
});
// If delete index is greater than no. of task
// or less than zero
if (deleteIndex > filterData.length || deleteIndex <= 0) {
console.log(
'Error: todo #' + deleteIndex +
' does not exist. Nothing deleted.',
);
} else {
// Remove the task
filterData.splice(filterData.length - deleteIndex, 1);
// Join the array to form a string
const newData = filterData.join('\n');
// Write the new data back in file
fs.writeFile(
currentWorkingDirectory + 'todo.txt',
newData,
function(err) {
if (err) throw err;
// Logs the deleted index
console.log('Deleted todo #' + deleteIndex);
},
);
}
} else {
// Index argument was no passed
console.log('Error: Missing NUMBER for deleting todo.');
}
};
const doneFunction = () => {
// Store the index passed as argument
const doneIndex = args[3];
// If argument is passed
if (doneIndex) {
// Empty array
let data = [];
// Create a new date object
let dateobj = new Date();
// Convert it to string and slice only the
// date part, removing the time part
let dateString = dateobj.toISOString()
.substring(0, 10);
// Read the data from todo.txt
const fileData = fs
.readFileSync(currentWorkingDirectory
+ 'todo.txt').toString();
// Read the data from done.txt
const doneData = fs
.readFileSync(currentWorkingDirectory
+ 'done.txt').toString();
// Split the todo.txt data
data = fileData.split('\n');
// Filter for any empty lines
let filterData = data.filter(function(value) {
return value !== '';
});
// If done index is greater than
// no. of task or <=0
if (doneIndex > filterData.length || doneIndex <= 0) {
console.log('Error: todo #' + doneIndex
+ ' does not exist.');
} else {
// Delete the task from todo.txt data
// and store it
const deleted = filterData.splice(
filterData.length - doneIndex, 1);
// Join the array to create a string
const newData = filterData.join('\n');
// Write back the data in todo.txt
fs.writeFile(
currentWorkingDirectory + 'todo.txt',
newData,
function(err) {
if (err) throw err;
},
);
fs.writeFile(
// Write the stored task in done.txt
// along with date string
currentWorkingDirectory + 'done.txt',
'x ' + dateString + ' ' + deleted
+ '\n' + doneData,
function(err) {
if (err) throw err;
console.log('Marked todo #'
+ doneIndex + ' as done.');
},
);
}
} else {
// If argument was not passed
console.log('Error: Missing NUMBER for '
+ 'marking todo as done.');
}
};
const reportFunction = () => {
// Create empty array for data of todo.txt
let todoData = [];
// Create empty array for data of done.txt
let doneData = [];
// Create a new date object
let dateobj = new Date();
// Slice the date part
let dateString = dateobj.toISOString()
.substring(0, 10);
// Read data from both the files
const todo = fs.readFileSync(
currentWorkingDirectory
+ 'todo.txt').toString();
const done = fs.readFileSync(
currentWorkingDirectory
+ 'done.txt').toString();
// Split the data from both files
todoData = todo.split('\n');
doneData = done.split('\n');
let filterTodoData = todoData.filter(function(value) {
return value !== '';
});
let filterDoneData = doneData.filter(function(value) {
return value !== '';
// Filter both the data for empty lines
});
console.log(
dateString +
' ' +
'Pending : ' +
filterTodoData.length +
' Completed : ' +
filterDoneData.length,
// Log the stats calculated
);
};
switch (args[2]) {
case 'add':
{
addFunction();
break;
}
case 'ls':
{
listFunction();
break;
}
case 'del':
{
deleteFunction();
break;
}
case 'done':
{
doneFunction();
break;
}
case 'help':
{
InfoFunction();
break;
}
case 'report':
{
reportFunction();
break;
}
default:
{
InfoFunction();
// We will display help when no
// argument is passed or invalid
// argument is passed
}
}
Step to run the application:
Run the index.js file using the following command:
node index.js
Output:
Similar Reads
Node.js Tutorial Node.js is a powerful, open-source, and cross-platform JavaScript runtime environment built on Chrome's V8 engine. It allows you to run JavaScript code outside the browser, making it ideal for building scalable server-side and networking applications.JavaScript was mainly used for frontend developme
4 min read
Introduction & Installation
NodeJS IntroductionNodeJS is a runtime environment for executing JavaScript outside the browser, built on the V8 JavaScript engine. It enables server-side development, supports asynchronous, event-driven programming, and efficiently handles scalable network applications. NodeJS is single-threaded, utilizing an event l
5 min read
Node.js Roadmap: A Complete GuideNode.js has become one of the most popular technologies for building modern web applications. It allows developers to use JavaScript on the server side, making it easy to create fast, scalable, and efficient applications. Whether you want to build APIs, real-time applications, or full-stack web apps
6 min read
How to Install Node.js on LinuxInstalling Node.js on a Linux-based operating system can vary slightly depending on your distribution. This guide will walk you through various methods to install Node.js and npm (Node Package Manager) on Linux, whether using Ubuntu, Debian, or other distributions.PrerequisitesA Linux System: such a
6 min read
How to Install Node.js on WindowsInstalling Node.js on Windows is a straightforward process, but it's essential to follow the right steps to ensure smooth setup and proper functioning of Node Package Manager (NPM), which is crucial for managing dependencies and packages. This guide will walk you through the official site, NVM, Wind
6 min read
How to Install NodeJS on MacOSNode.js is a popular JavaScript runtime used for building server-side applications. It’s cross-platform and works seamlessly on macOS, Windows, and Linux systems. In this article, we'll guide you through the process of installing Node.js on your macOS system.What is Node.jsNode.js is an open-source,
6 min read
Node.js vs Browser - Top Differences That Every Developer Should KnowNode.js and Web browsers are two different but interrelated technologies in web development. JavaScript is executed in both the environment, node.js, and browser but for different use cases. Since JavaScript is the common Programming language in both, it is a huge advantage for developers to code bo
6 min read
NodeJS REPL (READ, EVAL, PRINT, LOOP)NodeJS REPL (Read-Eval-Print Loop) is an interactive shell that allows you to execute JavaScript code line-by-line and see immediate results. This tool is extremely useful for quick testing, debugging, and learning, providing a sandbox where you can experiment with JavaScript code in a NodeJS enviro
5 min read
Explain V8 engine in Node.jsThe V8 engine is one of the core components of Node.js, and understanding its role and how it works can significantly improve your understanding of how Node.js executes JavaScript code. In this article, we will discuss the V8 engine’s importance and its working in the context of Node.js.What is a V8
7 min read
Node.js Web Application ArchitectureNode.js is a JavaScript-based platform mainly used to create I/O-intensive web applications such as chat apps, multimedia streaming sites, etc. It is built on Google Chrome’s V8 JavaScript engine. Web ApplicationsA web application is software that runs on a server and is rendered by a client browser
3 min read
NodeJS Event LoopThe event loop in Node.js is a mechanism that allows asynchronous tasks to be handled efficiently without blocking the execution of other operations. It:Executes JavaScript synchronously first and then processes asynchronous operations.Delegates heavy tasks like I/O operations, timers, and network r
5 min read
Node.js Modules , Buffer & Streams
NodeJS ModulesIn NodeJS, modules play an important role in organizing, structuring, and reusing code efficiently. A module is a self-contained block of code that can be exported and imported into different parts of an application. This modular approach helps developers manage large projects, making them more scal
6 min read
What are Buffers in Node.js ?Buffers are an essential concept in Node.js, especially when working with binary data streams such as files, network protocols, or image processing. Unlike JavaScript, which is typically used to handle text-based data, Node.js provides buffers to manage raw binary data. This article delves into what
4 min read
Node.js StreamsNode.js streams are a key part of handling I/O operations efficiently. They provide a way to read or write data continuously, allowing for efficient data processing, manipulation, and transfer.\Node.js StreamsThe stream module in Node.js provides an abstraction for working with streaming data. Strea
4 min read
Node.js Asynchronous Programming
Node.js NPM
NodeJS NPMNPM (Node Package Manager) is a package manager for NodeJS modules. It helps developers manage project dependencies, scripts, and third-party libraries. By installing NodeJS on your system, NPM is automatically installed, and ready to use.It is primarily used to manage packages or modules—these are
6 min read
Steps to Create and Publish NPM packagesIn this article, we will learn how to develop and publish your own npm package (also called an NPM module). There are many benefits of NPM packages, some of them are listed below: Reusable codeManaging code (using versioning)Sharing code The life-cycle of an npm package takes place like below: Modu
7 min read
Introduction to NPM scriptsNPM is a Node Package Manager. It is the world's largest Software Registry. This registry contains over 800,000 code packages. Many Open-source developers use npm to share software. Many organizations also use npm to manage private development. "npm scripts" are the entries in the scripts field of t
2 min read
Node.js package.jsonThe package.json file is the heart of Node.js system. It is the manifest file of any Node.js project and contains the metadata of the project. The package.json file is the essential part to understand, learn and work with the Node.js. It is the first step to learn about development in Node.js.What d
4 min read
What is package-lock.json ?package-lock.json is a file that is generated when we try to install the node. It is generated by the Node Package Manager(npm). package-lock.json will ensure that the same versions of packages are installed. It contains the name, dependencies, and locked version of the project. It will check that s
3 min read
Node.js Deployments & Communication
Node DebuggingDebugging is an essential part of software development that helps developers identify and fix errors. This ensures that the application runs smoothly without causing errors. NodeJS is the JavaScript runtime environment that provides various debugging tools for troubleshooting the application.What is
3 min read
How to Perform Testing in Node.js ?Testing is a method to check whether the functionality of an application is the same as expected or not. It helps to ensure that the output is the same as the required output. How Testing can be done in Node.js? There are various methods by which tasting can be done in Node.js, but one of the simple
2 min read
Unit Testing of Node.js ApplicationNode.js is a widely used javascript library based on Chrome's V8 JavaScript engine for developing server-side applications in web development. Unit Testing is a software testing method where individual units/components are tested in isolation. A unit can be described as the smallest testable part of
5 min read
NODE_ENV Variables and How to Use Them ?Introduction: NODE_ENV variables are environment variables that are made popularized by the express framework. The value of this type of variable can be set dynamically depending on the environment(i.e., development/production) the program is running on. The NODE_ENV works like a flag which indicate
2 min read
Difference Between Development and Production in Node.jsIn this article, we will explore the key differences between development and production environments in Node.js. Understanding these differences is crucial for deploying and managing Node.js applications effectively. IntroductionNode.js applications can behave differently depending on whether they a
3 min read
Best Security Practices in Node.jsThe security of an application is extremely important when we build a highly scalable and big project. So in this article, we are going to discuss some of the best practices that we need to follow in Node.js projects so that there are no security issues at a later point of time. In this article, we
4 min read
Deploying Node.js ApplicationsDeploying a NodeJS application can be a smooth process with the right tools and strategies. This article will guide you through the basics of deploying NodeJS applications.To show how to deploy a NodeJS app, we are first going to create a sample application for a better understanding of the process.
5 min read
How to Build a Microservices Architecture with NodeJSMicroservices architecture allows us to break down complex applications into smaller, independently deployable services. Node.js, with its non-blocking I/O and event-driven nature, is an excellent choice for building microservices. How to Build a Microservices Architecture with NodeJS?Microservices
3 min read
Node.js with WebAssemblyWebAssembly, often abbreviated as Wasm, is a cutting-edge technology that offers a high-performance assembly-like language capable of being compiled from various programming languages such as C/C++, Rust, and AssemblyScript. This technology is widely supported by major browsers including Chrome, Fir
3 min read
Resources & Tools
Node.js Web ServerA NodeJS web server is a server built using NodeJS to handle HTTP requests and responses. Unlike traditional web servers like Apache or Nginx, which are primarily designed to give static content, NodeJS web servers can handle both static and dynamic content while supporting real-time communication.
6 min read
Node Exercises, Practice Questions and SolutionsNode Exercise: Explore interactive quizzes, track progress, and enhance coding skills with our engaging portal. Ideal for beginners and experienced developers, Level up your Node proficiency at your own pace. Start coding now! #content-iframe { width: 100%; height: 500px;} @media (max-width: 768px)
4 min read
Node.js ProjectsNode.js is one of the most popular JavaScript runtime environments widely used in the software industry for projects in different domains like web applications, real-time chat applications, RESTful APIs, microservices, and more due to its high performance, scalability, non-blocking I/O, and many oth
9 min read
NodeJS Interview Questions and AnswersNodeJS is one of the most popular runtime environments, known for its efficiency, scalability, and ability to handle asynchronous operations. It is built on Chrome’s V8 JavaScript engine for executing JavaScript code outside of a browser. It is extensively used by top companies such as LinkedIn, Net
15+ min read