documentation/lib/git/url_prefix.js

a documentation generator

'use strict';

const fs = require('fs');
const path = require('path');
const gitUrlParse = require('git-url-parse');
const getRemoteOrigin = require('remote-origin-url');

/**
 * Sometimes git will [pack refs](https://git-scm.com/docs/git-pack-refs)
 * in order to save space on disk and
 * duck under limits of numbers of files in folders. CircleCI in particular
 * does this by default. This method parses that `packed-refs` file
 *
 * @private
 * @param {string} packedRefs string contents of the packed refs file
 * @param {string} branchName the branch name to resolve to
 * @returns {string} sha hash referring to current tree
 */
function parsePackedRefs(packedRefs, branchName) {
  return packedRefs.split(/\n/).filter(line => line[0] !== '#' && line[0] !== '^').reduce((memo, line) => {
    memo[line.split(' ')[1]] = line.split(' ')[0];
    return memo;
  }, {})[branchName];
}

/**
 * Given a a root directory, find its git configuration and figure out
 * the HTTPS URL at the base of that GitHub repository.
 *
 * @param {string} root path at the base of this local repo
 * @returns {string} base HTTPS url of the GitHub repository
 * @throws {Error} if the root is not a git repo
 */
function getGithubURLPrefix(root) {
  let sha;
  try {
    const head = fs.readFileSync(path.join(root, '.git', 'HEAD'), 'utf8');
    const branch = head.match(/ref: (.*)/);
    if (branch) {
      const branchName = branch[1];
      const branchFileName = path.join(root, '.git', branchName);
      const packedRefsName = path.join(root, '.git', 'packed-refs');
      if (fs.existsSync(branchFileName)) {
        sha = fs.readFileSync(branchFileName, 'utf8');
      } else if (fs.existsSync(packedRefsName)) {
        // packed refs are a compacted version of the refs folder. usually
        // you have a folder filled with files that just contain sha
        // hashes. since this folder can be really big, packed refs
        // stores all the refs in one file instead.
        sha = parsePackedRefs(fs.readFileSync(packedRefsName, 'utf8'), branchName);
      }
    } else {
      sha = head;
    }
    if (sha) {
      const parsed = gitUrlParse(getRemoteOrigin.sync(root));
      parsed.git_suffix = false; // eslint-disable-line
      return parsed.toString('https') + '/blob/' + sha.trim() + '/';
    }
  } catch (e) {
    return null;
  }
}

module.exports = getGithubURLPrefix;
module.exports.parsePackedRefs = parsePackedRefs;