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
Please upgrade carefully to version
7.0.0, there were breaking changes in the
Install with npm
$ npm install --save-dev gulp-todo
Injecting the todo generated file into another template
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 %>
- Use the following code to inject into that markdown, creating a markdown file with the generated todo:
const fs = ;const path = ;const gulp = ;const todo = ;const template = ;const through = ;gulp;
options is an optional configuration object, see https://github.com/pgilad/gulp-todo/blob/master/index.js#L22-L32
options is an optional configuration object, see https://github.com/pgilad/gulp-todo/blob/master/lib/reporter.js#L10-L16
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
MIT © Gilad Peleg