gulp-tag-version/index.js

Tag git repository with current package version

var map = require('map-stream'),
  log = require('fancy-log'),
  colors = require('ansi-colors'),
  git = require('gulp-git');

/**
 * @param opts {object} Module options, passed _also_ to underlying `git.tag`
 * @param opts.key {string?} The key in package.json from which version is read, defaults to 'version'
 * @param opts.prefix {string?} Prefix prepended to version when creating tag name, defaults to 'v'
 * @param opts.push {boolean?} Push tags tagging? Default: true
 * @param opts.label {string?} Label to use for tagging, defaults to 'Tagging as %t'. %t will be replaced by the tag name.
 * @param opts.version {string?} Alternatively, just pass the version string here. Default: undefined.
 */
module.exports = function (opts) {
  if (!opts) opts = {};
  if (!opts.key) opts.key = 'version';
  if (typeof opts.prefix === 'undefined') opts.prefix = 'v';
  if (typeof opts.push === 'undefined') opts.push = true;
  if (typeof opts.label === 'undefined') opts.label = 'Tagging as %t';

  function modifyContents(file, cb) {
    var version = opts.version; // OK if undefined at this time
    if (!opts.version) {
      if (file.isNull()) {
        return cb(null, file);
      }
      if (file.isStream()) {
        return cb(new Error('gulp-tag-version: streams not supported'));
      }

      var json = JSON.parse(file.contents.toString());
      version = json[opts.key]
    }
    var tag = opts.prefix + version;
    var label = opts.label.replace('%t', tag);
    log('Tagging as: ' + colors.cyan(tag));
    git.tag(tag, label, opts, cb)
  }

  return map(modifyContents)
};