8000 GitHub - pgilad/gulp-todo at v0.2.1
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

pgilad/gulp-todo

Repository files navigation

gulp-todo

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

NPM Version NPM Downloads Dependencies Build Status

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

Type: String

Default: todo.md

Specify the output filename.

newLine

Type: String

Default: \n

How to separate lines in the output file. Defaults to your OS's default line separator.

verbose

Type: Boolean

Default: false

Output comments to console as well.

Example Options using defaults:

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

License

MIT ©2014 Gilad Peleg

About

Generate a TODO.md from todos & fixmes in your code using Gulp stream

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 12

0