Blame view

node_modules/eslint/lib/rules/no-restricted-modules.js 3.57 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
  /**
   * @fileoverview Restrict usage of specified node modules.
   * @author Christian Schulz
   */
  "use strict";
  
  //------------------------------------------------------------------------------
  // Rule Definition
  //------------------------------------------------------------------------------
  
  const ignore = require("ignore");
  
  const arrayOfStrings = {
      type: "array",
      items: {
          type: "string"
      },
      uniqueItems: true
  };
  
  module.exports = {
      meta: {
          docs: {
              description: "disallow specified modules when loaded by `require`",
              category: "Node.js and CommonJS",
              recommended: false
          },
  
          schema: {
              anyOf: [
                  arrayOfStrings,
                  {
                      type: "array",
                      items: [{
                          type: "object",
                          properties: {
                              paths: arrayOfStrings,
                              patterns: arrayOfStrings
                          },
                          additionalProperties: false
                      }],
                      additionalItems: false
                  }
              ]
          }
      },
  
      create(context) {
          const options = Array.isArray(context.options) ? context.options : [];
          const isStringArray = typeof options[0] !== "object";
          const restrictedPaths = new Set(isStringArray ? context.options : options[0].paths || []);
          const restrictedPatterns = isStringArray ? [] : options[0].patterns || [];
  
          // if no imports are restricted we don"t need to check
          if (restrictedPaths.size === 0 && restrictedPatterns.length === 0) {
              return {};
          }
  
          const ig = ignore().add(restrictedPatterns);
  
          /**
           * 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";
          }
  
          return {
              CallExpression(node) {
                  if (isRequireCall(node)) {
  
                      // node has arguments and first argument is string
                      if (node.arguments.length && isString(node.arguments[0])) {
                          const moduleName = node.arguments[0].value.trim();
  
                          // check if argument value is in restricted modules array
                          if (restrictedPaths.has(moduleName)) {
                              context.report({
                                  node,
                                  message: "'{{moduleName}}' module is restricted from being used.",
                                  data: { moduleName }
                              });
                          }
  
                          if (restrictedPatterns.length > 0 && ig.ignores(moduleName)) {
                              context.report({
                                  node,
                                  message: "'{{moduleName}}' module is restricted from being used by a pattern.",
                                  data: { moduleName }
                              });
                          }
                      }
                  }
              }
          };
      }
  };