Blame view

node_modules/eslint/lib/rules/no-restricted-modules.js 2.52 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
  /**
   * @fileoverview Restrict usage of specified node modules.
   * @author Christian Schulz
   */
  "use strict";
  
  //------------------------------------------------------------------------------
  // Rule Definition
  //------------------------------------------------------------------------------
  
  module.exports = function(context) {
      // trim restricted module names
      var restrictedModules = context.options;
  
      // if no modules are restricted we don't need to check the CallExpressions
      if (restrictedModules.length === 0) {
          return {};
      }
  
      /**
       * Function to check if a node is a string literal.
       * @param {ASTNode} node The node to check.
       * @returns {boolean} If the node is a string literal.
       */
      function isString(node) {
          return node && node.type === "Literal" && typeof node.value === "string";
      }
  
      /**
       * Function to check if a node is a require call.
       * @param {ASTNode} node The node to check.
       * @returns {boolean} If the node is a require call.
       */
      function isRequireCall(node) {
          return node.callee.type === "Identifier" && node.callee.name === "require";
      }
  
      /**
       * Function to check if a node has an argument that is an restricted module and return its name.
       * @param {ASTNode} node The node to check
       * @returns {undefined|String} restricted module name or undefined if node argument isn't restricted.
       */
      function getRestrictedModuleName(node) {
          var moduleName;
  
          // node has arguments and first argument is string
          if (node.arguments.length && isString(node.arguments[0])) {
              var argumentValue = node.arguments[0].value.trim();
  
              // check if argument value is in restricted modules array
              if (restrictedModules.indexOf(argumentValue) !== -1) {
                  moduleName = argumentValue;
              }
          }
  
          return moduleName;
      }
  
      return {
          "CallExpression": function(node) {
              if (isRequireCall(node)) {
                  var restrictedModuleName = getRestrictedModuleName(node);
  
                  if (restrictedModuleName) {
                      context.report(node, "'{{moduleName}}' module is restricted from being used.", {
                          moduleName: restrictedModuleName
                      });
                  }
              }
          }
      };
  };
  
  module.exports.schema = {
      "type": "array",
      "items": [
          {
              "enum": [0, 1, 2]
          }
      ],
      "additionalItems": {
          "type": "string"
      },
      "uniqueItems": true
  };