git-command-line
Version:
A wrapper for command line git with promises
403 lines (360 loc) • 10.3 kB
JavaScript
/**
* Created by Mario Castro (mariocaster@gmail.com) on 4/18/15.
*/
var Q = require('q');
/**
* @module GitCommandLine
* @param {string} The working path to set git to work in
*/
module.exports = function(workingPath){
var workingDirectory = '.';
var logging = false;
/**
* Checks if the working path has been added in the constructor to set it
*/
if(workingPath){
workingDirectory = workingPath;
} else {
//Do nothing
}
/**
* Sets the current working directory of git
* @param {string} newPath New path to execute git commands on
*/
this.setWorkingDirectory = function(newPath){
workingDirectory = newPath;
};
/**
* Returns the current working directory where git is executing the commands
* @method getWorkingDirectory
* @returns {string} The current working directory
*/
this.getWorkingDirectory = function(){
return workingDirectory;
};
/**
* Activates/Deactivates logging
* @method setLog
* @param {boolean} isLogging
*/
this.setLog = function(isLogging){
logging = isLogging;
};
/**
* Returns current state of logging
* @method getLog
* @returns {boolean}
*/
this.getLog = function(){
return logging;
};
/**
* Executes 'git add '
* @method add
* @param command
* @param options
* @returns {promise|*|Q.promise}
*/
this.add = function (command, options) {
return execPromise('add ' + prepareCommand(command), options);
};
/**
* Executes 'git bisect '
* @method bisect
* @param command
* @param options
* @returns {promise|*|Q.promise}
*/
this.bisect = function (command, options) {
return execPromise('bisect ' + prepareCommand(command), options);
};
/**
* Executes 'git branch '
* @method
* @param command
* @param options
* @returns {promise|*|Q.promise}
*/
this.branch = function (command, options) {
return execPromise('branch ' + prepareCommand(command), options);
};
/**
* Executes 'git checkout '
* @method checkout
* @param command
* @param options
* @returns {promise|*|Q.promise}
*/
this.checkout = function (command, options) {
return execPromise('checkout ' + prepareCommand(command), options);
};
/**
* Executes 'git clone '
* @method clone
* @param command
* @param options
* @returns {promise|*|Q.promise}
*/
this.clone = function (command, options) {
return execPromise('clone ' + prepareCommand(command), options);
};
/**
* Executes 'git commit '
* @method commit
* @param command
* @param options
* @returns {promise|*|Q.promise}
*/
this.commit = function (command, options) {
return execPromise('commit ' + prepareCommand(command), options);
};
/**
* Executes 'git config '
* @method config
* @param command
* @param options
* @returns {promise|*|Q.promise}
*/
this.config = function (command, options) {
return execPromise('config ' + prepareCommand(command), options);
};
/**
* Executes 'git diff '
* @method diff
* @param command
* @param options
* @returns {promise|*|Q.promise}
*/
this.diff = function (command, options) {
return execPromise('diff ' + prepareCommand(command), options);
};
/**
* Executes 'git fetch '
* @method fetch
* @param command
* @param options
* @returns {promise|*|Q.promise}
*/
this.fetch = function (command, options) {
return execPromise('fetch ' + prepareCommand(command), options);
};
/**
* Executes 'git grep '
* @method grep
* @param command
* @param options
* @returns {promise|*|Q.promise}
*/
this.grep = function (command, options) {
return execPromise('grep ' + prepareCommand(command), options);
};
/**
* Executes 'git init '
* @method init
* @param command
* @param options
* @returns {promise|*|Q.promise}
*/
this.init = function (command, options) {
return execPromise('init ' + prepareCommand(command), options);
};
/**
* Executes 'git log '
* @param command
* @param options
* @returns {promise|*|Q.promise}
*/
this.log = function (command, options) {
return execPromise('log ' + prepareCommand(command), options);
};
/**
* Executes 'git merge '
* @method merge
* @param command
* @param options
* @returns {promise|*|Q.promise}
*/
this.merge = function (command, options) {
return execPromise('merge ' + prepareCommand(command), options);
};
/**
* Executes 'git mv '
* @method mv
* @param command
* @param options
* @returns {promise|*|Q.promise}
*/
this.mv = function (command, options) {
return execPromise('mv ' + prepareCommand(command), options);
};
/**
* Executes 'git pull'
* @method pull
* @param command
* @param options
* @returns {promise|*|Q.promise}
*/
this.pull = function (command, options) {
return execPromise('pull ' + prepareCommand(command), options);
};
/**
* Executes 'git push '
* @method push
* @param command
* @param options
* @returns {promise|*|Q.promise}
*/
this.push = function (command, options) {
return execPromise('push ' + prepareCommand(command), options);
};
/**
* Executes 'git rebase '
* @method rebase
* @param command
* @param options
* @returns {promise|*|Q.promise}
*/
this.rebase = function (command, options) {
return execPromise('rebase ' + prepareCommand(command), options);
};
/**
* Executes 'git remote '
* @method remote
* @param command
* @param options
* @returns {promise|*|Q.promise}
*/
this.remote = function (command, options) {
return execPromise('remote ' + prepareCommand(command), options);
};
/**
* Executes 'git reset '
* @method reset
* @param command
* @param options
* @returns {promise|*|Q.promise}
*/
this.reset = function (command, options) {
return execPromise('reset ' + prepareCommand(command), options);
};
/**
* Executes 'git rm '
* @method rm
* @param command
* @param options
* @returns {promise|*|Q.promise}
*/
this.rm = function (command, options) {
return execPromise('rm ' + prepareCommand(command), options);
};
/**
* Executes 'git show '
* @method show
* @param command
* @param options
* @returns {promise|*|Q.promise}
*/
this.show = function (command, options) {
return execPromise('show ' + prepareCommand(command), options);
};
/**
* Executes 'git status '
* @method status
* @param command
* @param options
* @returns {promise|*|Q.promise}
*/
this.status = function (command, options) {
return execPromise('status ' + prepareCommand(command), options);
};
/**
* Executes 'git tag '
* @method tag
* @param command
* @param options
* @returns {promise|*|Q.promise}
*/
this.tag = function (command, options) {
return execPromise('tag ' + prepareCommand(command), options);
};
/**
* Executes a method over git directly. Like 'git [command]'
* @method direct
* @param command
* @param options
* @returns {promise|*|Q.promise}
*/
this.direct = function(command, options){
return execPromise(prepareCommand(command), options);
};
/**
* Prepares the command string to be valid in case that is not included in the params
* @param command
* @returns {*}
*/
var prepareCommand = function(command){
if(command === undefined){
return '';
} else {
return command;
}
};
/**
* Prepare options to use the set working directory in the following commands
* @param options
* @returns {*}
*/
var prepareOptions = function(options){
if (!options) {
options = {
cwd: workingDirectory
};
return options;
} else {
workingDirectory = options.cwd;
return options;
}
};
/**
* Prints logs of command excution if activated
* @param command The command that will be executed
*/
var printCommandExecution = function(command, options){
if(logging || false){
console.log('Executing: ' + 'git ' + command + ' with options ', options);
}
};
/**
* Prints the response of an exec execution
* @param res
*/
var printCommandResponse = function(res){
if(logging || false){
console.log('Logging ---> ', res);
}
};
/**
* Main function to use the command line tools to execute git commands
* @param command Command to execute. Do not include 'git ' prefix
* @param options Options available in exec command https://nodejs.org/api/child_process.html#child_process_child_process_exec_command_options_callback
* @returns {promise|*|Q.promise}
*/
var execPromise = function (command, options) {
var exec = require('child_process').exec;
var defer = Q.defer();
//Prepare the options object to be valid
options = prepareOptions(options);
//Activate-Deactivate command logging execution
printCommandExecution(command, options);
exec('git ' + prepareCommand(command), options, function (err, stdout, stderr) {
//Activate-deactivate err and out logging
printCommandResponse({err:err, stdout:stdout, stderr:stderr});
if (err) {
defer.reject({err: err, stderr: stderr});
} else {
defer.resolve({res:stdout, out:stderr});
}
});
return defer.promise;
};
};