NPM Library tick-stack

An npm package for codebases that check for todos in comments recursively in folders and let's user know the pending tasks in project

I have a habit of leaving comments in my codebase during the development process for the tasks that I have to do next, however if I am working on multiple pieces of code which spans across files,I have to keep track of it menatally.

My usual workflow would include me writing down same tasks in notes app and keep striking them off one after the another. So why not automate this, why not get a set of tasks already defined for me as a file right next to my codebase, this was the idea behind this project.

For this, I made a tiny npm library CLI tool called tick-stack, the usage is just like any other npm library, npm install tick-stack and then add a script in package.json. This program consists of 3 main functions:

  1. To scan the directory and search for the files with extensions js,ts,tsx and jsx and get those paths.
  2. To scan the file and check for keywords, "TODO,REMEMBER,FIXME" , make an object of path file,line number and pass it down to generateReport.
  3. generateReport as the name suggests takes in the list of todos, groups them by the file type and then generates a report.md To prevent creation of multiple files, we write back in the same output file.

Here is a snapshot of what it looks like in action:

capture2

This repo used to be something called "remdo" and had over 160 downloads, but I felt it had major just a prototype vibe and it could not be used in frontend codebases because it wasn't a CLI, so this project overcomes those short comings,currently it has 75 downloads. If anyone feel like there are issues with this or would like to add any new features, this project is open sourced at link to project