Blame view

node_modules/eslint-plugin-node/lib/util/get-docs-url.js 1.19 KB
ce4c83ff   wxy   初始提交
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
  /**
   * @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`
  }