task-extractor v1.0.9
Task Extractor
CLI tool to extract TODO comments and output them to a JSON and text file.
Usage:
tasks <directory> <outfile>Parameters:
| Parameter | Description |
|---|---|
directory | A directory to recursively scan for TODO comments. |
outfile | A file name to write the results to. The program will create both a .txt and a .json file with this file name (with the output in those respective formats) |
Adding search terms:
You can add your own search terms by editing the package.json file in your NPM global install directory. Navigate to where your global modules are stored (i.e. ~/.npm/lib/node_modules) and edit the searchTerms property of package.json to add your own custom terms to search the files for. By default, the task searcher will only look for lines with // TODO: on them. Regular expressions are not currently supported, but they are planned (ETA: eventually).
Contributing:
Feel free to contribute. Fork the repo and make a pull request if you want to contribute to this module. There are a couple features baked in which I haven't gotten around to implementing yet (like the ora spinner and async file reading / optimization).