Remdo

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

CURRENTLY SUPPORTED ONLY FOR VANILLA JS AND SERVER SIDE JS

Table of Contents

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

Installation

You can install the remdo package via npm. Run the following command in your terminal:

npm install -g remdo

Usage

const { scanAndGenerateReport } = require('remdo');
scanAndGenerateReport(__filename); // Call the function to scan the current file and generate the report

Features

If you are working on multiple codebases at once it is difficult to keep a track of the fixmes and remembers, using remdo you can directly import the library before writing code and upon running, it keeps a track of the "TODO","REMEMBER" and "FIXME" as of now and it saves a todo.md file in the current directory for easy reference.

API Reference

scanAndGenerateReport('path/to/your/file.js'); or simply
scanAndGenerateReport('__filename');

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. Special thanks to Node.js for the runtime environment