/**
 * @author Suhas Karanth
 * @copyright 2018 Toru Nagashima. All rights reserved.
 * See LICENSE file in root directory for full license.
 */
"use strict"

//------------------------------------------------------------------------------
// Requirements
//------------------------------------------------------------------------------

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

//------------------------------------------------------------------------------
// Helpers
//------------------------------------------------------------------------------

const REPO_URL = "https://github.com/mysticatea/eslint-plugin-node"

//------------------------------------------------------------------------------
// Public Interface
//------------------------------------------------------------------------------

/**
 * 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
 */
module.exports = function getDocsUrl(ruleName) {
    return `${REPO_URL}/blob/v${pkg.version}/docs/rules/${ruleName}.md`
}