Blame view

node_modules/eslint/lib/rules/prefer-arrow-callback.js 6.69 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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
  /**
   * @fileoverview A rule to suggest using arrow functions as callbacks.
   * @author Toru Nagashima
   * @copyright 2015 Toru Nagashima. All rights reserved.
   */
  
  "use strict";
  
  //------------------------------------------------------------------------------
  // Helpers
  //------------------------------------------------------------------------------
  
  /**
   * Checks whether or not a given variable is a function name.
   * @param {escope.Variable} variable - A variable to check.
   * @returns {boolean} `true` if the variable is a function name.
   */
  function isFunctionName(variable) {
      return variable && variable.defs[0].type === "FunctionName";
  }
  
  /**
   * Checks whether or not a given MetaProperty node equals to a given value.
   * @param {ASTNode} node - A MetaProperty node to check.
   * @param {string} metaName - The name of `MetaProperty.meta`.
   * @param {string} propertyName - The name of `MetaProperty.property`.
   * @returns {boolean} `true` if the node is the specific value.
   */
  function checkMetaProperty(node, metaName, propertyName) {
      // TODO: Remove this if block after https://github.com/eslint/espree/issues/206 was fixed.
      if (typeof node.meta === "string") {
          return node.meta === metaName && node.property === propertyName;
      }
      return node.meta.name === metaName && node.property.name === propertyName;
  }
  
  /**
   * Gets the variable object of `arguments` which is defined implicitly.
   * @param {escope.Scope} scope - A scope to get.
   * @returns {escope.Variable} The found variable object.
   */
  function getVariableOfArguments(scope) {
      var variables = scope.variables;
      for (var i = 0; i < variables.length; ++i) {
          var variable = variables[i];
          if (variable.name === "arguments") {
              // If there was a parameter which is named "arguments", the implicit "arguments" is not defined.
              // So does fast return with null.
              return (variable.identifiers.length === 0) ? variable : null;
          }
      }
  
      /* istanbul ignore next */
      return null;
  }
  
  /**
   * Checkes whether or not a given node is a callback.
   * @param {ASTNode} node - A node to check.
   * @returns {object}
   *   {boolean} retv.isCallback - `true` if the node is a callback.
   *   {boolean} retv.isLexicalThis - `true` if the node is with `.bind(this)`.
   */
  function getCallbackInfo(node) {
      var retv = {isCallback: false, isLexicalThis: false};
      var parent = node.parent;
      while (node) {
          switch (parent.type) {
              // Checks parents recursively.
              case "LogicalExpression":
              case "ConditionalExpression":
                  break;
  
              // Checks whether the parent node is `.bind(this)` call.
              case "MemberExpression":
                  if (parent.object === node &&
                      !parent.property.computed &&
                      parent.property.type === "Identifier" &&
                      parent.property.name === "bind" &&
                      parent.parent.type === "CallExpression" &&
                      parent.parent.callee === parent
                  ) {
                      retv.isLexicalThis = (
                          parent.parent.arguments.length === 1 &&
                          parent.parent.arguments[0].type === "ThisExpression"
                      );
                      node = parent;
                      parent = parent.parent;
                  } else {
                      return retv;
                  }
                  break;
  
              // Checks whether the node is a callback.
              case "CallExpression":
              case "NewExpression":
                  if (parent.callee !== node) {
                      retv.isCallback = true;
                  }
                  return retv;
  
              default:
                  return retv;
          }
  
          node = parent;
          parent = parent.parent;
      }
  
      /* istanbul ignore next */
      throw new Error("unreachable");
  }
  
  //------------------------------------------------------------------------------
  // Rule Definition
  //------------------------------------------------------------------------------
  
  module.exports = function(context) {
      // {Array<{this: boolean, super: boolean, meta: boolean}>}
      // - this - A flag which shows there are one or more ThisExpression.
      // - super - A flag which shows there are one or more Super.
      // - meta - A flag which shows there are one or more MethProperty.
      var stack = [];
  
      /**
       * Pushes new function scope with all `false` flags.
       * @returns {void}
       */
      function enterScope() {
          stack.push({this: false, super: false, meta: false});
      }
  
      /**
       * Pops a function scope from the stack.
       * @returns {{this: boolean, super: boolean, meta: boolean}} The information of the last scope.
       */
      function exitScope() {
          return stack.pop();
      }
  
      return {
          // Reset internal state.
          Program: function() {
              stack = [];
          },
  
          // If there are below, it cannot replace with arrow functions merely.
          ThisExpression: function() {
              var info = stack[stack.length - 1];
              if (info) {
                  info.this = true;
              }
          },
          Super: function() {
              var info = stack[stack.length - 1];
              if (info) {
                  info.super = true;
              }
          },
          MetaProperty: function(node) {
              var info = stack[stack.length - 1];
              if (info && checkMetaProperty(node, "new", "target")) {
                  info.meta = true;
              }
          },
  
          // To skip nested scopes.
          FunctionDeclaration: enterScope,
          "FunctionDeclaration:exit": exitScope,
  
          // Main.
          FunctionExpression: enterScope,
          "FunctionExpression:exit": function(node) {
              var scopeInfo = exitScope();
  
              // Skip generators.
              if (node.generator) {
                  return;
              }
  
              // Skip recursive functions.
              var nameVar = context.getDeclaredVariables(node)[0];
              if (isFunctionName(nameVar) && nameVar.references.length > 0) {
                  return;
              }
  
              // Skip if it's using arguments.
              var variable = getVariableOfArguments(context.getScope());
              if (variable && variable.references.length > 0) {
                  return;
              }
  
              // Reports if it's a callback which can replace with arrows.
              var callbackInfo = getCallbackInfo(node);
              if (callbackInfo.isCallback &&
                  (!scopeInfo.this || callbackInfo.isLexicalThis) &&
                  !scopeInfo.super &&
                  !scopeInfo.meta
              ) {
                  context.report(node, "Unexpected function expression.");
              }
          }
      };
  };
  
  module.exports.schema = [];