jakschu / gulp-todo

Generate a TODO.md file from your javascript todos and fixmes

gulp-todo

Generate a TODO.md file from your javascript todos and fixmes

Parse all your javascript files through Esprima, and generate a todo.md

Install

Install with npm

npm install --save-dev gulp-todo

Example

var gulp = require('gulp');
var todo = require('gulp-todo');

gulp.task('default', function() {
    gulp.src('js/**/*.js')
        .pipe(todo())
        .pipe(gulp.dest('./'));
});

Options

Options can be passed along as an object containing the following fields:

filename

{String} - specify the output filename. Defaults to todo.md.

newLine

{String} - how to separate lines in the output file. Defaults to your OS's default line separator (usually \n)

verbose

{Boolean} - output comments to console as well. Defaults to false.

Example Options using defaults:

//...
.pipe(todo({
    fileName: 'todo.md',
    newLine: '\n',
    verbose: false
}))
//...

License

MIT ©2014 Gilad Peleg