fritx / gulp-edit

Edit files with gulp

Information

Package	gulp-edit
Description	Edit files with gulp

Usage

edit(modifier)

• modifier(src, cb): [function]

var edit = require('gulp-edit')

gulp.task('edit', function() {
  return gulp.src('./*.txt')
    .pipe(edit(function(src, cb){
      // this === file
      var err = null
      src += '- modified!'
      cb(err, src)
    }))
    .pipe(gulp.dest('./'))
})

gulp-edit's Issues

Proposal for simpler API

Your API passes both the src and cb arguments to the modifier function. I think, this can be simplified. Here’s my suggestion:

• only pass src to the modifier function (the file contents)
• the modifier function returns the modified file contents or explicitly throws an error

So, instead of this:

gulp.src('./*.txt')
    .pipe(edit(function (src, cb) {
        var err = null;

        src += '- modified!';

        if (/* something went wrong */) {
            err = new Error(/* explain what went wrong */);
        } 

        cb(err, src);
    }))
    .pipe(gulp.dest('./'))

I propose this:

gulp.src('./*.txt')
    .pipe(edit(function (src) {
        src += '- modified!';

        if (/* something went wrong */) {
            throw new Error(/* explain what went wrong */);
        } 

        return src;
    }))
    .pipe(gulp.dest('./'))

I think, this API is more straight-forward, since the modifier function both receives and returns a string value, and the users of your Gulp plugin don’t have to understand that cb pattern, but instead just throw errors when needed.

I can make a PR with this change. Tell me what you think.

Please note that if you don’t like this API change, I intend to fork your repo and implement the change in my fork instead ^_^