get-docs-url.js

'use strict'

const pkg = require('../../package')

const REPO_URL = 'https://github.com/xjamundx/eslint-plugin-promise'

/**
 * Generates the URL to documentation for the given rule name. It uses the
 * package version to build the link to a tagged version of the
 * documentation file.
 *
 * @param {string} ruleName - Name of the eslint rule
 * @returns {string} URL to the documentation for the given rule
 */
function getDocsUrl(ruleName) {
  return `${REPO_URL}/tree/v${pkg.version}/docs/rules/${ruleName}.md`
}

module.exports = getDocsUrl