diolive-bump/index.js

Fixed and improved version of stevelacy/gulp-bump

'use strict';

var path = require('path');
var gutil = require('gulp-util');
var through = require('through2');
var semver = require('semver');
var Dot = require('dot-object');

module.exports = function (options) {
  if (!Array.isArray(options)) {
    options = [options];
  }

  return through.obj(function (file, enc, cb) {
    var dot = new Dot(),
      opts, content, json, ver;

    if (file.isNull()) {
      return cb(null, file);
    }
    if (file.isStream()) {
      return cb(new gutil.PluginError('diolive-bump', 'Streaming not supported'));
    }

    json = file.contents.toString();
    try {
      content = JSON.parse(json);
    } catch (e) {
      return cb(new gutil.PluginError('diolive-bump', 'Problem parsing JSON file', { fileName: file.path, showStack: true }));
    }

    for (var i = 0; i < options.length; i++) {
      opts = setDefaultOptions(options[i]);

      ver = dot.pick(opts.key, content);

      if (opts.version) {
        if (!ver) {
          // log to user that key didn't exist before
          gutil.log('Creating key', gutil.colors.green(opts.key), 'with version:', gutil.colors.cyan(opts.version));
        }
        ver = opts.version;
        dot.str(opts.key, ver, content);
      }
      else if (semver.valid(ver)) {
        // increment the key with type
        ver = semver.inc(ver, opts.type, opts.preid);
        dot.str(opts.key, ver, content);
      }
      else {
        return cb(new gutil.PluginError('diolive-bump', 'Detected invalid semver ' + opts.key, { fileName: file.path, showStack: false }));
      }

      gutil.log('Bumped \'' + gutil.colors.cyan(path.basename(file.path)) + '\' ' + gutil.colors.magenta(opts.key) + ' to: ' + gutil.colors.cyan(ver));
    }
    file.contents = new Buffer(JSON.stringify(content, null, opts.indent || space(json)) + possibleNewline(json));
    cb(null, file);
  });
};

function setDefaultOptions(opts) {
  opts = opts || {};
  opts.key = opts.key || 'version';
  opts.indent = opts.indent || void 0;

  // default type bump is patch
  if (!opts.version && (!opts.type || !semver.inc('0.0.1', opts.type))) {
    opts.type = 'patch';
  }

  // if passed specific version - validate it
  if (opts.version && !semver.valid(opts.version, opts.type)) {
    gutil.log('Potentially wrong version:', gutil.colors.yellow(opts.version));
  }
  return opts;
}

// Preserver new line at the end of a file
function possibleNewline(json) {
  var lastChar = (json.slice(-1) === '\n') ? '\n' : '';
  return lastChar;
}

// Figured out which "space" params to be used for JSON.stringfiy.
function space(json) {
  var match = json.match(/^(?:(\t+)|( +))"/m);
  return match ? (match[1] ? '\t' : match[2].length) : '';
}