todo-viewer

Scan files for commented todos and print them to the console

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
todo-viewer
1.0.94 years ago5 years agoMinified + gzip package size for todo-viewer in KB

Readme

Build Status
todo-viewer
An npm package that prints out todos to the console. When running the command, the glob must be in quotes.

Install

To install the package globally, run:
npm i -g todo-viewer
Or to install the package locally, run:
npm i -D todo-viewer

Usage

When writing todos in your project, write them in the form:
// TODO: Lorem ipsum

If the package has been installed globally, run:
todo-viewer <file>
or add a script to your package.json like:
"scripts": {
	"todo": "todo-viewer \"*.js\""
}
The <file> argument is a glob. This will log the todos to the console from all the files that the glob matches. <file> must be in quotes otherwise bash will match the glob before the package.