Blame view

node_modules/eslint-plugin-node/lib/rules/process-exit-as-throw.js 4.77 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
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
  /**
   * @author Toru Nagashima
   * @copyright 2016 Toru Nagashima. All rights reserved.
   * See LICENSE file in root directory for full license.
   */
  "use strict"
  
  //------------------------------------------------------------------------------
  // Requirements
  //------------------------------------------------------------------------------
  
  const CodePathAnalyzer = safeRequire("eslint/lib/code-path-analysis/code-path-analyzer")
  const CodePath = safeRequire("eslint/lib/code-path-analysis/code-path")
  const CodePathSegment = safeRequire("eslint/lib/code-path-analysis/code-path-segment")
  const getDocsUrl = require("../util/get-docs-url")
  
  //------------------------------------------------------------------------------
  // Helpers
  //------------------------------------------------------------------------------
  
  const originalLeaveNode = CodePathAnalyzer && CodePathAnalyzer.prototype.leaveNode
  
  /**
   * Imports a specific module.
   *
   * @param {string} moduleName - A module name to import.
   * @returns {object|null} The imported object, or null.
   */
  function safeRequire(moduleName) {
      try {
          return require(moduleName)
      }
      catch (_err) {
          return null
      }
  }
  
  /* istanbul ignore next */
  /**
   * Copied from https://github.com/eslint/eslint/blob/16fad5880bb70e9dddbeab8ed0f425ae51f5841f/lib/code-path-analysis/code-path-analyzer.js#L137
   *
   * @param {CodePathAnalyzer} analyzer - The instance.
   * @param {ASTNode} node - The current AST node.
   * @returns {void}
   */
  function forwardCurrentToHead(analyzer, node) {
      const codePath = analyzer.codePath
      const state = CodePath.getState(codePath)
      const currentSegments = state.currentSegments
      const headSegments = state.headSegments
      const end = Math.max(currentSegments.length, headSegments.length)
      let i = 0
      let currentSegment = null
      let headSegment = null
  
      // Fires leaving events.
      for (i = 0; i < end; ++i) {
          currentSegment = currentSegments[i]
          headSegment = headSegments[i]
  
          if (currentSegment !== headSegment && currentSegment) {
              if (currentSegment.reachable) {
                  analyzer.emitter.emit(
                      "onCodePathSegmentEnd",
                      currentSegment,
                      node
                  )
              }
          }
      }
  
      // Update state.
      state.currentSegments = headSegments
  
      // Fires entering events.
      for (i = 0; i < end; ++i) {
          currentSegment = currentSegments[i]
          headSegment = headSegments[i]
  
          if (currentSegment !== headSegment && headSegment) {
              CodePathSegment.markUsed(headSegment)
              if (headSegment.reachable) {
                  analyzer.emitter.emit(
                      "onCodePathSegmentStart",
                      headSegment,
                      node
                  )
              }
          }
      }
  }
  
  /**
   * Checks whether a given node is `process.exit()` or not.
   *
   * @param {ASTNode} node - A node to check.
   * @returns {boolean} `true` if the node is `process.exit()`.
   */
  function isProcessExit(node) {
      return (
          node.type === "CallExpression" &&
          node.callee.type === "MemberExpression" &&
          node.callee.computed === false &&
          node.callee.object.type === "Identifier" &&
          node.callee.object.name === "process" &&
          node.callee.property.type === "Identifier" &&
          node.callee.property.name === "exit"
      )
  }
  
  /**
   * The function to override `CodePathAnalyzer.prototype.leaveNode` in order to
   * address `process.exit()` as throw.
   *
   * @this CodePathAnalyzer
   * @param {ASTNode} node - A node to be left.
   * @returns {void}
   */
  function overrideLeaveNode(node) {
      if (isProcessExit(node)) {
          this.currentNode = node
  
          forwardCurrentToHead(this, node)
          CodePath.getState(this.codePath).makeThrow()
  
          this.original.leaveNode(node)
          this.currentNode = null
      }
      else {
          originalLeaveNode.call(this, node)
      }
  }
  
  const visitor = CodePathAnalyzer == null ? {} : {
      "Program": function installProcessExitAsThrow() {
          CodePathAnalyzer.prototype.leaveNode = overrideLeaveNode
      },
      "Program:exit": function restoreProcessExitAsThrow() {
          CodePathAnalyzer.prototype.leaveNode = originalLeaveNode
      },
  }
  
  //------------------------------------------------------------------------------
  // Rule Definition
  //------------------------------------------------------------------------------
  
  module.exports = {
      meta: {
          docs: {
              description: "make `process.exit()` expressions the same code path as `throw`",
              category: "Possible Errors",
              recommended: true,
              url: getDocsUrl("process-exit-as-throw.md"),
          },
          fixable: false,
          schema: [],
          supported: CodePathAnalyzer != null,
      },
      create() {
          return visitor
      },
  }