documentation/lib/github.js

a documentation generator

'use strict';

const path = require('path');
const findGit = require('./git/find_git');
const getGithubURLPrefix = require('./git/url_prefix');

/**
 * Attempts to link code to its place on GitHub.
 *
 * @name linkGitHub
 * @param {Object} comment parsed comment
 * @returns {Object} comment with github inferred
 */
module.exports = function (comment) {
  const repoPath = findGit(comment.context.file);
  const root = repoPath ? path.dirname(repoPath) : '.';
  const urlPrefix = getGithubURLPrefix(root);
  const fileRelativePath = comment.context.file.replace(root + path.sep, '').split(path.sep).join('/');

  if (urlPrefix) {
    let startLine;
    let endLine;

    if (comment.kind == 'typedef') {
      startLine = comment.loc.start.line;
      endLine = comment.loc.end.line;
    } else {
      startLine = comment.context.loc.start.line;
      endLine = comment.context.loc.end.line;
    }

    comment.context.github = {
      url: urlPrefix + fileRelativePath + '#L' + startLine + '-' + 'L' + endLine,
      path: fileRelativePath
    };
  }
  return comment;
};