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
35 lines
902 B
JavaScript
35 lines
902 B
JavaScript
'use strict';
|
|
/* @flow */
|
|
|
|
|
|
var path = require('path');
|
|
var findGit = require('../lib/git/find_git');
|
|
var getGithubURLPrefix = require('../lib/git/url_prefix');
|
|
|
|
/**
|
|
* Attempts to link code to its place on GitHub.
|
|
*
|
|
* @name linkGitHub
|
|
* @param {Object} comment parsed comment
|
|
* @return {Object} comment with github inferred
|
|
*/
|
|
module.exports = function (comment/*: Comment*/) {
|
|
var repoPath = findGit(comment.context.file);
|
|
var root = repoPath ? path.dirname(repoPath) : '.';
|
|
var urlPrefix = getGithubURLPrefix(root);
|
|
var fileRelativePath = comment.context.file.replace(root + path.sep, '')
|
|
.split(path.sep)
|
|
.join('/');
|
|
|
|
if (urlPrefix) {
|
|
comment.context.github = {
|
|
url: urlPrefix +
|
|
fileRelativePath +
|
|
'#L' + comment.context.loc.start.line + '-' +
|
|
'L' + comment.context.loc.end.line,
|
|
path: fileRelativePath
|
|
};
|
|
}
|
|
return comment;
|
|
};
|