tfs/lib/tfs/history.js

NodeJS wrapper for Team Foundation Source Control CLI.

var format = require('../utils/format'),
    tf     = require('../utils/tf');

/**
 * Displays the revision history for one or more files, folders or both.
 *
 * <h5>Required Permissions</h5>
 * To use the history command, you must have Read permission
 * set to Allow for all files or folders for which history is requested.
 *
 * @todo Is there a way to launch history (TF.exe window) via API ?
 *
 * @summary  Displays the revision history for one or more files, folders or both.
 * @see      https://msdn.microsoft.com/en-us/library/yxtbh4yh.aspx
 * @module   TFS History
 * @version  1.4.0
 *
 * @param  {Array}    itemspec File(s) and folder(s) to get latest version of.
 *                             If empty, equals CWD.
 * @param  {Object}   options  History command options
 * @param  {Function} callback Function to call back once executed
 */
var _history = function(itemspec, options, callback) {
  var params = itemspec.length ? itemspec : [process.cwd()];
  params = params.concat(format.options(options));

  return tf('history', params, callback, !!options.verbose);
};

module.exports = _history;