mirror of
https://github.com/documentationjs/documentation.git
synced 2026-01-25 14:26:29 +00:00
631c6925d4
* feat(core): Switch to Promises everywhere. Adopt Node v4 ES6 Big changes: * Uses template strings where appropriate * Config and argument parsing is unified and there is no such thing as formatterOptions anymore. All user-passed options go through mergeConfig. * The node API surface changed (again): `buildSync` is removed, building operations return Promises. * Now using Flow for internal type annotations. More changes: * Remove buildSync command * feat(inference): Partially implement object shorthand support * Refs #649 * Use Flow annotations to enforce types * Keep flow but switch to comment syntax * Clarify types * More flow improvements * Turn server into class * LinkerStack becomes class too * Fix comment description type * Run flow on lint * Many more flow fixes * More intense flow refactoring * Simplify inference steps * Update inference tests, flow errors down to 1 * Continue refining types * Fix more flow issues * Use 'use strict' everywhere * Make 'ast' property configurable * Fix many tests * Fix more tests * Fix more tests * Fix augments * Test Markdown meta support * Improve test coverage * Switch back from for of to for for speed
67 lines
2.3 KiB
JavaScript
67 lines
2.3 KiB
JavaScript
/* @flow */
|
|
'use strict';
|
|
var fs = require('fs');
|
|
var path = require('path');
|
|
var gitUrlParse = require('git-url-parse');
|
|
var 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/*: string*/) {
|
|
var sha;
|
|
try {
|
|
var head = fs.readFileSync(path.join(root, '.git', 'HEAD'), 'utf8');
|
|
var branch = head.match(/ref\: (.*)/);
|
|
if (branch) {
|
|
var branchName = branch[1];
|
|
var branchFileName = path.join(root, '.git', branchName);
|
|
var 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) {
|
|
return gitUrlParse(getRemoteOrigin.sync(root)).toString('https') + '/blob/' + sha.trim() + '/';
|
|
}
|
|
} catch (e) {
|
|
return null;
|
|
}
|
|
}
|
|
|
|
module.exports = getGithubURLPrefix;
|
|
module.exports.parsePackedRefs = parsePackedRefs;
|