Generate a TODO.md file from comments of files in stream
Parse and output TODOs and FIXMEs from comments in your file in a stream
Parse your files in a gulp-stream, extracting todos/fixmes from comments and reporting them in a reporter to your choosing using leasot.
Issues with the output should be reported on the leasot issue tracker
Install with npm
$ npm install --save-dev gulp-todo
If you want to inject the generated todo stream into another file (say a
you can do the following:
readme.md.templatefile that contains the following marker, marking where you want to inject the generated todo file:
### some previous content<%= marker %>
var fs = ;var path = ;var gulp = ;var todo = ;var template = ;var through = ;gulp;
options is an optional object, that may contain the following properties:
Specify the output filename.
Output comments to console as well.
Output absolute paths of files (as available via
Which reporter to use.
params are passed along to the selected reporter (except
For options and more information about using reporters, see: https://github.com/pgilad/leasot#reporter and https://github.com/pgilad/leasot#built-in-reporters
Use another reporter in stream, will replace the contents of the output file.
Must be used after
todo(), since it uses the
file.todos that are passed along.
See the example in the usage
Same options as the above settings for
Pass along options to the reporter, and also if you pass a
fileName - it will rename the filename in stream.
MIT @Gilad Peleg