Blame view

node_modules/eslint/lib/rules/global-require.js 2.13 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
  /**
   * @fileoverview Rule for disallowing require() outside of the top-level module context
   * @author Jamund Ferguson
   */
  
  "use strict";
  
  const ACCEPTABLE_PARENTS = [
      "AssignmentExpression",
      "VariableDeclarator",
      "MemberExpression",
      "ExpressionStatement",
      "CallExpression",
      "ConditionalExpression",
      "Program",
      "VariableDeclaration"
  ];
  
  /**
   * Finds the escope reference in the given scope.
   * @param {Object} scope The scope to search.
   * @param {ASTNode} node The identifier node.
   * @returns {Reference|null} Returns the found reference or null if none were found.
   */
  function findReference(scope, node) {
      const references = scope.references.filter(reference => reference.identifier.range[0] === node.range[0] &&
              reference.identifier.range[1] === node.range[1]);
  
      /* istanbul ignore else: correctly returns null */
      if (references.length === 1) {
          return references[0];
      }
      return null;
  
  }
  
  /**
   * Checks if the given identifier node is shadowed in the given scope.
   * @param {Object} scope The current scope.
   * @param {ASTNode} node The identifier node to check.
   * @returns {boolean} Whether or not the name is shadowed.
   */
  function isShadowed(scope, node) {
      const reference = findReference(scope, node);
  
      return reference && reference.resolved && reference.resolved.defs.length > 0;
  }
  
  module.exports = {
      meta: {
          docs: {
              description: "require `require()` calls to be placed at top-level module scope",
              category: "Node.js and CommonJS",
              recommended: false
          },
  
          schema: []
      },
  
      create(context) {
          return {
              CallExpression(node) {
                  const currentScope = context.getScope();
  
                  if (node.callee.name === "require" && !isShadowed(currentScope, node.callee)) {
                      const isGoodRequire = context.getAncestors().every(parent => ACCEPTABLE_PARENTS.indexOf(parent.type) > -1);
  
                      if (!isGoodRequire) {
                          context.report({ node, message: "Unexpected require()." });
                      }
                  }
              }
          };
      }
  };