Blame view

node_modules/eslint-plugin-node/lib/rules/no-hide-core-modules.js 4.46 KB
ce4c83ff   wxy   初始提交
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
  /**
   * @author Toru Nagashima
   * @copyright 2016 Toru Nagashima. All rights reserved.
   * See LICENSE file in root directory for full license.
   *
   * @deprecated since v4.2.0
   * This rule was based on an invalid assumption.
   * No meaning.
   */
  "use strict"
  
  //------------------------------------------------------------------------------
  // Requirements
  //------------------------------------------------------------------------------
  
  const path = require("path")
  const resolve = require("resolve")
  const getDocsUrl = require("../util/get-docs-url")
  const getPackageJson = require("../util/get-package-json")
  const getRequireTargets = require("../util/get-require-targets")
  const getImportExportTargets = require("../util/get-import-export-targets")
  
  //------------------------------------------------------------------------------
  // Helpers
  //------------------------------------------------------------------------------
  
  const CORE_MODULES = new Set([
      "assert", "buffer", "child_process", "cluster", "console", "constants",
      "crypto", "dgram", "dns", /* "domain", */ "events", "fs", "http", "https",
      "module", "net", "os", "path", /* "punycode", */ "querystring", "readline",
      "repl", "stream", "string_decoder", "timers", "tls", "tty", "url", "util",
      "vm", "zlib",
  ])
  const BACK_SLASH = /\\/g
  
  /**
   * Creates AST event handlers for no-hide-core-modules.
   *
   * @param {RuleContext} context - The rule context.
   * @returns {object} AST event handlers.
   */
  function create(context) {
      if (context.getFilename() === "<input>") {
          return {}
      }
      const filePath = path.resolve(context.getFilename())
      const dirPath = path.dirname(filePath)
      const packageJson = getPackageJson(filePath)
      const deps = new Set([].concat(
          Object.keys((packageJson && packageJson.dependencies) || {}),
          Object.keys((packageJson && packageJson.devDependencies) || {})
      ))
      const options = context.options[0] || {}
      const allow = options.allow || []
      const ignoreDirectDependencies = Boolean(options.ignoreDirectDependencies)
      const ignoreIndirectDependencies = Boolean(options.ignoreIndirectDependencies)
  
      return {
          "Program:exit"(node) {
              const targets =
                  [].concat(
                      getRequireTargets(context, true),
                      getImportExportTargets(context, node, true)
                  ).filter(t => CORE_MODULES.has(t.moduleName))
  
              for (const target of targets) {
                  const name = target.moduleName
                  const allowed =
                      allow.indexOf(name) !== -1 ||
                      (ignoreDirectDependencies && deps.has(name)) ||
                      (ignoreIndirectDependencies && !deps.has(name))
  
                  if (allowed) {
                      continue
                  }
  
                  const resolved = resolve.sync(name, { basedir: dirPath })
                  const isCore = resolved === name
  
                  if (isCore) {
                      continue
                  }
  
                  context.report({
                      node: target.node,
                      loc: target.node.loc,
                      message: "Unexpected import of third-party module '{{name}}'.",
                      data: {
                          name: path
                              .relative(dirPath, resolved)
                              .replace(BACK_SLASH, "/"),
                      },
                  })
              }
          },
      }
  }
  
  //------------------------------------------------------------------------------
  // Rule Definition
  //------------------------------------------------------------------------------
  
  module.exports = {
      create,
      meta: {
          docs: {
              description: "disallow third-party modules which are hiding core modules",
              category: "Possible Errors",
              recommended: false,
              url: getDocsUrl("no-hide-core-modules.md"),
          },
          deprecated: true,
          fixable: false,
          schema: [
              {
                  type: "object",
                  properties: {
                      allow: {
                          type: "array",
                          items: { enum: Array.from(CORE_MODULES) },
                          additionalItems: false,
                          uniqueItems: true,
                      },
                      ignoreDirectDependencies: { type: "boolean" },
                      ignoreIndirectDependencies: { type: "boolean" },
                  },
                  additionalProperties: false,
              },
          ],
      },
  }