slickgrid/scripts/git-utils.js

A lightning fast JavaScript grid/spreadsheet

const childProcess = require('./child-process.js');

/**
 * @param {Array<String>} [files] 
 * @param {{ cwd: String, dryRun: Boolean}} options 
 * @returns {Promise<any>}
 */
function gitAdd(files, { cwd, dryRun }) {
    const execArgs = files ? ['add', '--', ...files] : ['add', '.'];
    return childProcess.exec('git', execArgs, { cwd }, dryRun);
}

/**
 * @param {String} commitMsg 
 * @param {{ cwd: String, dryRun: Boolean}} options 
 * @returns {Promise<any>}
 */
function gitCommit(commitMsg, { cwd, dryRun }) {
    const execArgs = ['commit', '-m', commitMsg];
    return childProcess.exec('git', execArgs, { cwd }, dryRun);
}

/**
 * @param {String} commitMsg 
 * @param {{ cwd: String, dryRun: Boolean}} options 
 * @returns {Promise<any>}
 */
async function gitCurrentBranchName({ cwd }) {
    const execArgs = ['branch', '--show-current'];
    const procRtn = await childProcess.exec('git', execArgs, { cwd });
    return procRtn.stdout;
}

/**
 * @param {String} tag - tag name
 * @param {{ cwd: String, dryRun: Boolean}} options
 * @returns {Promise<any>}
 */
function gitTag(tag, { cwd, dryRun }) {
    const execArgs = ['tag', tag, '-m', tag];
    return childProcess.exec('git', execArgs, { cwd }, dryRun);
}

/**
 * @param {String} tag - tag name
 * @param {String} [remote=origin]
 * @param {{ cwd: String, dryRun: Boolean}} options
 * @returns {Promise<any>}
 */
function gitTagPushRemote(tag, remote = 'origin', { cwd, dryRun }) {
    const execArgs = ['push', remote, tag];
    return childProcess.exec('git', execArgs, { cwd }, dryRun);
}

/**
 * @param {String} tag - tag name
 * @param {String} [remote=origin]
 * @param {{ cwd: String, dryRun: Boolean}} options
 * @returns {Promise<any>}
 */
async function gitPushToCurrentBranch(remote = 'origin', { cwd, dryRun }) {
    const branchName = await gitCurrentBranchName({ cwd });
    const execArgs = ['push', remote, branchName];
    return childProcess.exec('git', execArgs, { cwd }, dryRun);
}

/**
 * Check if there's anything uncommited
 * @param {{ cwd: String, dryRun: Boolean; skipChecks: Boolean; }} options
 */
async function hasUncommittedChanges({ cwd, dryRun, skipChecks }) {
    const execArgs = ['status', '--porcelain', '-uno'];
    const { stdout } = await childProcess.exec('git', execArgs, { cwd });
    if (stdout.length && !skipChecks) {
        throw Error('Working tree has uncommitted changes, please commit or remove the following changes before continuing.');
    }
}

// exports
module.exports = {
    gitAdd,
    gitCommit,
    gitCurrentBranchName,
    gitPushToCurrentBranch,
    gitTag,
    gitTagPushRemote,
    hasUncommittedChanges,
}