TICK STACK

An auto TODO list generator that recursively checks in the codebase directory for code comments: TODO, FIXME, and REMEMBER comments and makes a list of tasks for you. Use this library to keep a track of all the pending tasks from various code bases you are working on.

CURRENTLY SUPPORTS FOR ALL JS/TS/TSX and JSX extensions

Table of Contents

• Installation
• Usage
• Features
• API Reference
  • scanAndGenerateReport
• Contributing
• License
• Acknowledgements

Installation

You can install the tick-stack package via npm. Run the following command in your terminal:

npm install tick-stack --save-dev

Usage

Please add this line in the package.json file,

"scripts": {
  "tick": "tick-stack"
}

if you do not want to do the above you can simply run

npx tick-stack

To run please use this command:

npm run tick

Features

If you are working on multiple codebases at once it is difficult to keep a track of the fixmes and TODOS, using tick-stack you can install the library and upon running, it keeps a track of the "TODO","REMEMBER" and "FIXME" it saves a file name TICK_STACK.md in the current directory for easy reference.

Contribution

Contributions are welcome! If you would like to contribute to this project, please follow these steps:

Fork the repository. Create a new branch (git checkout -b feature-branch). Make your changes and commit them (git commit -m 'Add some feature'). Push to the branch (git push origin feature-branch). Open a pull request.

License

This project is licensed under the MIT License.

Ackmowledgement

Thank you to the open-source community for the inspiration and resources.