Blame view

node_modules/eslint/lib/rules.js 3.03 KB
f7563de62   Palak Handa   first commit
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
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
  /**
   * @fileoverview Defines a storage for rules.
   * @author Nicholas C. Zakas
   */
  
  "use strict";
  
  //------------------------------------------------------------------------------
  // Requirements
  //------------------------------------------------------------------------------
  
  const loadRules = require("./load-rules");
  
  //------------------------------------------------------------------------------
  // Privates
  //------------------------------------------------------------------------------
  
  let rules = Object.create(null);
  
  //------------------------------------------------------------------------------
  // Public Interface
  //------------------------------------------------------------------------------
  
  /**
   * Registers a rule module for rule id in storage.
   * @param {string} ruleId Rule id (file name).
   * @param {Function} ruleModule Rule handler.
   * @returns {void}
   */
  function define(ruleId, ruleModule) {
      rules[ruleId] = ruleModule;
  }
  
  /**
   * Loads and registers all rules from passed rules directory.
   * @param {string} [rulesDir] Path to rules directory, may be relative. Defaults to `lib/rules`.
   * @param {string} cwd Current working directory
   * @returns {void}
   */
  function load(rulesDir, cwd) {
      const newRules = loadRules(rulesDir, cwd);
  
      Object.keys(newRules).forEach(ruleId => {
          define(ruleId, newRules[ruleId]);
      });
  }
  
  /**
   * Registers all given rules of a plugin.
   * @param {Object} plugin The plugin object to import.
   * @param {string} pluginName The name of the plugin without prefix (`eslint-plugin-`).
   * @returns {void}
   */
  function importPlugin(plugin, pluginName) {
      if (plugin.rules) {
          Object.keys(plugin.rules).forEach(ruleId => {
              const qualifiedRuleId = `${pluginName}/${ruleId}`,
                  rule = plugin.rules[ruleId];
  
              define(qualifiedRuleId, rule);
          });
      }
  }
  
  /**
   * Access rule handler by id (file name).
   * @param {string} ruleId Rule id (file name).
   * @returns {Function} Rule handler.
   */
  function getHandler(ruleId) {
      if (typeof rules[ruleId] === "string") {
          return require(rules[ruleId]);
      }
      return rules[ruleId];
  
  }
  
  /**
   * Get an object with all currently loaded rules
   * @returns {Map} All loaded rules
   */
  function getAllLoadedRules() {
      const allRules = new Map();
  
      Object.keys(rules).forEach(name => {
          const rule = getHandler(name);
  
          allRules.set(name, rule);
      });
      return allRules;
  }
  
  /**
   * Reset rules storage.
   * Should be used only in tests.
   * @returns {void}
   */
  function testClear() {
      rules = Object.create(null);
  }
  
  module.exports = {
      define,
      load,
      importPlugin,
      get: getHandler,
      getAllLoadedRules,
      testClear,
  
      /**
       * Resets rules to its starting state. Use for tests only.
       * @returns {void}
       */
      testReset() {
          testClear();
          load();
      }
  };
  
  //------------------------------------------------------------------------------
  // Initialization
  //------------------------------------------------------------------------------
  
  // loads built-in rules
  load();