index.js

'use strict';

const url = require('url');
const path = require('path');
const dotgitconfig = require('dotgitconfig');
const { execSync } = require('child_process');

/**
 * Prevents obnoxious cmd window popping up on Windows when process runs via pm2
 * instead of via an already visible terminal.
 */
const baseExecOptions = { windowsHide: true };

module.exports = class LCL {
  constructor(dir = process.cwd()) {
    this.gitDirStr = '';
    const { GIT_DIR } = process.env;
    if (GIT_DIR) {
      if (GIT_DIR.endsWith('/.git')) {
        this.gitDirStr = `--git-dir=${GIT_DIR}`;
      } else {
        this.gitDirStr = `--git-dir=${path.resolve(GIT_DIR, './.git')}`;
      }
    }
    this.cwd = dir;
  }

  async getLastCommit() {
    return this.getLastCommitSync();
  }

  getLastCommitSync() {
    const prettyFormat = [
      '%h', '%H', '%s', '%f', '%b',
      '%ct', '%cr', '%cn', '%ce',
      '%at', '%ar', '%an', '%ae',
    ];
    const splitCharacter = '<#__last-commit-log__#>';
    const command = `git ${this.gitDirStr} log -1 --pretty=format:"` + prettyFormat.join(splitCharacter) + '"';

    let c;
    let gitRemote;
    let gitBranch;
    let gitTag;
    try {
      const opts = {
        ...baseExecOptions,
        cwd: this.cwd,
        maxBuffer: 1024 * 1024 * 1024,
        // <https://stackoverflow.com/a/45578119
        // <https://github.com/cabinjs/axe/issues/15>
        stdio: 'pipe',
      };
      const stdout = execSync(command, opts).toString();
      c = stdout.split(splitCharacter);
      gitBranch = getGitBranch({
        gitDirStr: this.gitDirStr,
        ...opts,
      }, {
        shortHash: c[0],
      });
      const tag = execSync(`git ${this.gitDirStr} tag --contains HEAD`, opts).toString();
      gitTag = tag.trim();
      const config = dotgitconfig(this.cwd);
      gitRemote = config.remote && config.remote.origin && config.remote.origin.url;
    } catch (e) {
      throw new Error(`Can't get last commit, ${e}`);
    }

    return {
      gitTag,
      gitBranch,
      gitRemote,
      gitUrl: this._formatGitHttpUrl(gitRemote),
      shortHash: c[0],
      hash: c[1],
      subject: c[2],
      sanitizedSubject: c[3],
      body: c[4],
      committer: {
        date: c[5],
        relativeDate: c[6],
        name: c[7],
        email: c[8],
      },
      author: {
        date: c[9],
        relativeDate: c[10],
        name: c[11],
        email: c[12],
      },
    };
  }

  /**
   * git@github.com:group/repo.git     => http://github.com/group/repo
   * https://user@token@github.com/group/repo.git => https://github.com/group/repo
   */
  _formatGitHttpUrl(remote = '') {
    if (remote.startsWith('git@')) {
      return 'http://' + remote
        .replace(/^git@/, '')
        .replace(/\.git$/, '')
        .replace(/:/, '/');
    }
    if (remote.startsWith('http') && remote.endsWith('.git')) {
      const parsed = url.parse(remote.replace(/\.git$/, ''));
      return `${parsed.protocol}//${parsed.host}${parsed.path}`;
    }
    return remote;
  }

  get config() {
    return {
      user: {
        name: this.getUserNameSync(),
      },
    };
  }

  getUserNameSync() {
    return execSync(`git ${this.gitDirStr} config user.name`, baseExecOptions)
      .toString()
      .trim();
  }
};

function getGitBranch(opts = {}, { shortHash }) {
  let _branch = '';

  const revParseBranch = execSync(`git ${opts.gitDirStr} rev-parse --abbrev-ref HEAD`, opts).toString();
  const nameRevBranch = execSync(`git ${opts.gitDirStr} name-rev --name-only HEAD`, opts).toString();
  const gitLogBranch = execSync(`git ${opts.gitDirStr} log -n 1 --pretty=%d HEAD`, opts).toString();

  const branchRP = revParseBranch.trim();
  const branchNR = nameRevBranch.trim()
    .replace('remotes/origin/', '')
    .replace(/~\d+$/, ''); // in case 'develop~1'
  const branchGL = gitLogBranch.split(',')
    .filter(i => i.includes('origin/'))
    .map(i => i.trim())
    .map(i => i.split('/')[1])
    .map(i => i.replace(/[()]/, ''))
    .filter(i => i !== 'HEAD');
  _branch = branchRP !== 'HEAD'
    ? branchRP
    : !branchNR.startsWith('tags/')
      ? branchNR : branchGL.length > 1
        ? branchGL.filter(i => i !== 'master')[0] : branchGL[0];
  // in case branch is deleted
  if (!_branch) {
    _branch = `branch_is_deleted_${shortHash}`;
  }
  return _branch;
}

module.exports.diff = require('./line-diff');