Numbers Produce Meaning

    gulp-todos

    0.1.0 • Public • Published

    gulp-every-todo

    Generate a TODO.md file from ALL your project todos and fixmes

    NPM Version NPM Downloads Dependencies Build Status

    Parse all your files, and generate a todo.md

    Install

    Install with npm

    npm install --save-dev gulp-todos
    

    Example

    var gulp = require('gulp');
    var todo = require('gulp-todos');
     
    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:

    formatter

    {String} - specify the formatter type. defaults to human. Available options:

    • human ()
    • robot

    Example human output:

    {
        "test/file0.js": {
            "line 0": "TODO: test"
        },
        "test/file1.js": {
            "line 0": "TODO: test"
        }
    }

    Example robot output:

    {
        "test/file0.js": [
            {
                "line": 0,
                "type": "TODO",
                "value": "test"
            }
        ],
        "test/file1.js": [
            {
                "line": 0,
                "type": "TODO",
                "value": "test"
            }
        ]
    }

    License

    MIT ©2014 Vsevolod Rodionov

    Install

    npm i gulp-todos

    DownloadsWeekly Downloads

    4

    Version

    0.1.0

    License

    MIT

    Last publish

    Collaborators

    • jabher