Blame view

node_modules/eslint/lib/rules/block-scoped-var.js 4.38 KB
c39994410   Ryan Glover   wip converting to...
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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
  /**
   * @fileoverview Rule to check for "block scoped" variables by binding context
   * @author Matt DuVall <http://www.mattduvall.com>
   * @copyright 2015 Toru Nagashima. All rights reserved.
   * @copyright 2015 Mathieu M-Gosselin. All rights reserved.
   */
  "use strict";
  
  //------------------------------------------------------------------------------
  // Helpers
  //------------------------------------------------------------------------------
  
  /**
   * Collects unresolved references from the global scope, then creates a map to references from its name.
   * @param {RuleContext} context - The current context.
   * @returns {object} A map object. Its key is the variable names. Its value is the references of each variable.
   */
  function collectUnresolvedReferences(context) {
      var unresolved = Object.create(null);
      var references = context.getScope().through;
  
      for (var i = 0; i < references.length; ++i) {
          var reference = references[i];
          var name = reference.identifier.name;
  
          if (name in unresolved === false) {
              unresolved[name] = [];
          }
          unresolved[name].push(reference);
      }
  
      return unresolved;
  }
  
  //------------------------------------------------------------------------------
  // Rule Definition
  //------------------------------------------------------------------------------
  
  module.exports = function(context) {
      var unresolvedReferences = Object.create(null);
      var stack = [];
  
      /**
       * Makes a block scope.
       * @param {ASTNode} node - A node of a scope.
       * @returns {void}
       */
      function enterScope(node) {
          stack.push(node.range);
      }
  
      /**
       * Pops the last block scope.
       * @returns {void}
       */
      function exitScope() {
          stack.pop();
      }
  
      /**
       * Reports a given reference.
       * @param {escope.Reference} reference - A reference to report.
       * @returns {void}
       */
      function report(reference) {
          var identifier = reference.identifier;
          context.report(
              identifier,
              "\"{{name}}\" used outside of binding context.",
              {name: identifier.name});
      }
  
      /**
       * Finds and reports references which are outside of valid scopes.
       * @param {ASTNode} node - A node to get variables.
       * @returns {void}
       */
      function checkForVariables(node) {
          if (node.kind !== "var") {
              return;
          }
  
          var isGlobal = context.getScope().type === "global";
  
          // Defines a predicate to check whether or not a given reference is outside of valid scope.
          var scopeRange = stack[stack.length - 1];
  
          /**
           * Check if a reference is out of scope
           * @param {ASTNode} reference node to examine
           * @returns {boolean} True is its outside the scope
           * @private
           */
          function isOutsideOfScope(reference) {
              var idRange = reference.identifier.range;
              return idRange[0] < scopeRange[0] || idRange[1] > scopeRange[1];
          }
  
          // Gets declared variables, and checks its references.
          var variables = context.getDeclaredVariables(node);
          for (var i = 0; i < variables.length; ++i) {
              var variable = variables[i];
              var references = variable.references;
  
              // Global variables are not resolved.
              // In this case, use unresolved references.
              if (isGlobal && variable.name in unresolvedReferences) {
                  references = unresolvedReferences[variable.name];
              }
  
              // Reports.
              references.filter(isOutsideOfScope).forEach(report);
          }
      }
  
      return {
          "Program": function(node) {
              unresolvedReferences = collectUnresolvedReferences(context);
              stack = [node.range];
          },
  
          // Manages scopes.
          "BlockStatement": enterScope,
          "BlockStatement:exit": exitScope,
          "ForStatement": enterScope,
          "ForStatement:exit": exitScope,
          "ForInStatement": enterScope,
          "ForInStatement:exit": exitScope,
          "ForOfStatement": enterScope,
          "ForOfStatement:exit": exitScope,
          "SwitchStatement": enterScope,
          "SwitchStatement:exit": exitScope,
          "CatchClause": enterScope,
          "CatchClause:exit": exitScope,
  
          // Finds and reports references which are outside of valid scope.
          "VariableDeclaration": checkForVariables
      };
  
  };
  
  module.exports.schema = [];