updater-example/updatefile.js

This is an example updater for the `update` library, to provide a basic demonstration of how updaters work.

'use strict';

var through = require('through2');

/**
 * Export the "updater" function
 */

module.exports = function(app) {
  app.task('foo', function() {
    return updateExample(app, 'foo');
  });

  app.task('bar', function() {
    return updateExample(app, 'bar');
  });

  app.task('baz', function() {
    return updateExample(app, 'baz');
  });

  app.task('undo', function() {
  var cwd = app.options.dest || app.cwd;
  return app.src('example.txt', {cwd: cwd})
    .pipe(erase(app.options.n))
    .pipe(app.dest(cwd));
  });

  /**
   * "Sub-updater"
   */

  app.register('abc', function(abc) {
    this.task('default', function() {
      return updateExample(app, 'abc:default');
    });

    this.task('xyz', function() {
      return updateExample(app, 'abc:xyz');
    });
  });

  app.task('default', ['foo']);
};

/**
 * Append the given string to `example.txt` and re-write the file to the current
 * working directory.
 *
 * The `.src` and `.dest` methods work exactly like gulp's (we use the same libs from the
 * gulp team under the hood)
 *
 * @param {Object} `app` Instance of update, to get the cwd. Pass `--dest` on the command line to set `app.options.dest`
 * @return {Stream} vinyl stream
 * @api public
 */

function updateExample(app, str) {
  var cwd = app.options.dest || app.cwd;
  return app.src('example.txt', {cwd: cwd})
    .pipe(append(str))
    .pipe(app.dest(cwd));
}

/**
 * Append the given `str` to `file.contents`
 *
 * @param {String} `str`
 * @return {Stream} vinyl stream
 * @api public
 */

function append(str) {
  return through.obj(function(file, enc, next) {
    file.contents = new Buffer(file.contents.toString() + str + '\n');
    next(null, file);
  });
}

/**
 * Erase the given number of lines from the end of a string
 *
 * @param {String} `str`
 * @return {Stream} vinyl stream
 * @api public
 */

function erase(num) {
  var n = typeof num === 'number' ? num : 1;
  return through.obj(function(file, enc, next) {
    var lines = file.contents.toString().trim().split('\n');
    file.contents = new Buffer(lines.slice(0, -n).join('\n') + '\n');
    next(null, file);
  });
}