NodeGuards.ts 8.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292
  1. import * as ESTree from 'estree';
  2. import { TNodeWithBlockStatement } from '../types/node/TNodeWithBlockStatement';
  3. import { NodeType } from '../enums/node/NodeType';
  4. export class NodeGuards {
  5. /**
  6. * @param {Node} node
  7. * @returns {boolean}
  8. */
  9. public static isArrowFunctionExpressionNode (node: ESTree.Node): node is ESTree.ArrowFunctionExpression {
  10. return node.type === NodeType.ArrowFunctionExpression;
  11. }
  12. /**
  13. * @param {Node} node
  14. * @returns {boolean}
  15. */
  16. public static isAssignmentPatternNode (node: ESTree.Node): node is ESTree.AssignmentPattern {
  17. return node.type === NodeType.AssignmentPattern;
  18. }
  19. /**
  20. * @param {Node} node
  21. * @returns {boolean}
  22. */
  23. public static isAwaitExpressionNode (node: ESTree.Node): node is ESTree.AwaitExpression {
  24. return node.type === NodeType.AwaitExpression;
  25. }
  26. /**
  27. * @param {Node} node
  28. * @returns {boolean}
  29. */
  30. public static isBlockStatementNode (node: ESTree.Node): node is ESTree.BlockStatement {
  31. return node.type === NodeType.BlockStatement;
  32. }
  33. /**
  34. * @param {Node} node
  35. * @returns {boolean}
  36. */
  37. public static isBreakStatementNode (node: ESTree.Node): node is ESTree.BreakStatement {
  38. return node.type === NodeType.BreakStatement;
  39. }
  40. /**
  41. * @param {Node} node
  42. * @returns {boolean}
  43. */
  44. public static isCallExpressionNode (node: ESTree.Node): node is ESTree.CallExpression {
  45. return node.type === NodeType.CallExpression;
  46. }
  47. /**
  48. * @param {Node} node
  49. * @returns {boolean}
  50. */
  51. public static isCatchClauseNode (node: ESTree.Node): node is ESTree.CatchClause {
  52. return node.type === NodeType.CatchClause;
  53. }
  54. /**
  55. * @param {Node} node
  56. * @returns {boolean}
  57. */
  58. public static isClassDeclarationNode (node: ESTree.Node): node is ESTree.ClassDeclaration {
  59. return node.type === NodeType.ClassDeclaration;
  60. }
  61. /**
  62. * @param {Node} node
  63. * @returns {boolean}
  64. */
  65. public static isContinueStatementNode (node: ESTree.Node): node is ESTree.ContinueStatement {
  66. return node.type === NodeType.ContinueStatement;
  67. }
  68. /**
  69. * @param {Node} node
  70. * @returns {boolean}
  71. */
  72. public static isExpressionStatementNode (node: ESTree.Node): node is ESTree.ExpressionStatement {
  73. return node.type === NodeType.ExpressionStatement;
  74. }
  75. /**
  76. * @param {Node} node
  77. * @returns {boolean}
  78. */
  79. public static isFunctionDeclarationNode (node: ESTree.Node): node is ESTree.FunctionDeclaration {
  80. return node.type === NodeType.FunctionDeclaration;
  81. }
  82. /**
  83. * @param {Node} node
  84. * @returns {boolean}
  85. */
  86. public static isFunctionExpressionNode (node: ESTree.Node): node is ESTree.FunctionExpression {
  87. return node.type === NodeType.FunctionExpression;
  88. }
  89. /**
  90. * @param {Node} node
  91. * @returns {boolean}
  92. */
  93. public static isIdentifierNode (node: ESTree.Node): node is ESTree.Identifier {
  94. return node.type === NodeType.Identifier;
  95. }
  96. /**
  97. * @param {Node} node
  98. * @returns {boolean}
  99. */
  100. public static isIfStatementNode (node: ESTree.Node): node is ESTree.IfStatement {
  101. return node.type === NodeType.IfStatement;
  102. }
  103. /**
  104. * @param {Node} node
  105. * @param {Node} parentNode
  106. * @returns {boolean}
  107. */
  108. public static isLabelIdentifierNode (node: ESTree.Node, parentNode: ESTree.Node): node is ESTree.Identifier {
  109. const parentNodeIsLabeledStatementNode: boolean = NodeGuards.isLabeledStatementNode(parentNode) && parentNode.label === node;
  110. const parentNodeIsContinueStatementNode: boolean = NodeGuards.isContinueStatementNode(parentNode) && parentNode.label === node;
  111. const parentNodeIsBreakStatementNode: boolean = NodeGuards.isBreakStatementNode(parentNode) && parentNode.label === node;
  112. return parentNodeIsLabeledStatementNode || parentNodeIsContinueStatementNode || parentNodeIsBreakStatementNode;
  113. }
  114. /**
  115. * @param {Node} node
  116. * @returns {boolean}
  117. */
  118. public static isLabeledStatementNode (node: ESTree.Node): node is ESTree.LabeledStatement {
  119. return node.type === NodeType.LabeledStatement;
  120. }
  121. /**
  122. * @param {Node} node
  123. * @returns {boolean}
  124. */
  125. public static isLiteralNode (node: ESTree.Node): node is ESTree.Literal {
  126. return node.type === NodeType.Literal;
  127. }
  128. /**
  129. * @param {Node} node
  130. * @returns {boolean}
  131. */
  132. public static isMemberExpressionNode (node: ESTree.Node): node is ESTree.MemberExpression {
  133. return node.type === NodeType.MemberExpression;
  134. }
  135. /**
  136. * @param {Node} node
  137. * @returns {boolean}
  138. */
  139. public static isMethodDefinitionNode (node: ESTree.Node): node is ESTree.MethodDefinition {
  140. return node.type === NodeType.MethodDefinition;
  141. }
  142. /**
  143. * @param {Object} object
  144. * @returns {boolean}
  145. */
  146. public static isNode (object: Object & { type?: string }): object is ESTree.Node {
  147. return object && !object.type !== undefined;
  148. }
  149. /**
  150. * @param {Node} node
  151. * @returns {boolean}
  152. */
  153. public static isNodeHasBlockStatement (node: ESTree.Node): node is TNodeWithBlockStatement {
  154. return Array.isArray((<TNodeWithBlockStatement>node).body);
  155. }
  156. /**
  157. * @param {Node} node
  158. * @returns {boolean}
  159. */
  160. public static isObjectPatternNode (node: ESTree.Node): node is ESTree.ObjectPattern {
  161. return node.type === NodeType.ObjectPattern;
  162. }
  163. /**
  164. * @param {Node} node
  165. * @returns {boolean}
  166. */
  167. public static isObjectExpressionNode (node: ESTree.Node): node is ESTree.ObjectExpression {
  168. return node.type === NodeType.ObjectExpression;
  169. }
  170. /**
  171. * @param {Node} node
  172. * @returns {boolean}
  173. */
  174. public static isProgramNode (node: ESTree.Node): node is ESTree.Program {
  175. return node.type === NodeType.Program;
  176. }
  177. /**
  178. * @param {Node} node
  179. * @returns {boolean}
  180. */
  181. public static isPropertyNode (node: ESTree.Node): node is ESTree.Property {
  182. return node.type === NodeType.Property;
  183. }
  184. /**
  185. * @param {Node} node
  186. * @param {Node} parentNode
  187. * @returns {boolean}
  188. */
  189. public static isReplaceableIdentifierNode (node: ESTree.Node, parentNode: ESTree.Node): node is ESTree.Identifier {
  190. if (!NodeGuards.isIdentifierNode(node)) {
  191. return false;
  192. }
  193. const parentNodeIsPropertyNode: boolean = NodeGuards.isPropertyNode(parentNode)
  194. && !parentNode.computed
  195. && parentNode.key === node;
  196. const parentNodeIsMemberExpressionNode: boolean = (
  197. NodeGuards.isMemberExpressionNode(parentNode) &&
  198. parentNode.computed === false &&
  199. parentNode.property === node
  200. );
  201. return !parentNodeIsPropertyNode &&
  202. !parentNodeIsMemberExpressionNode &&
  203. !NodeGuards.isLabelIdentifierNode(node, parentNode);
  204. }
  205. /**
  206. * @param {Node} node
  207. * @returns {boolean}
  208. */
  209. public static isReturnStatementNode (node: ESTree.Node): node is ESTree.ReturnStatement {
  210. return node.type === NodeType.ReturnStatement;
  211. }
  212. /**
  213. * @param {Node} node
  214. * @returns {boolean}
  215. */
  216. public static isTemplateLiteralNode (node: ESTree.Node): node is ESTree.TemplateLiteral {
  217. return node.type === NodeType.TemplateLiteral;
  218. }
  219. /**
  220. * @param {Node} node
  221. * @returns {boolean}
  222. */
  223. public static isUnaryExpressionNode (node: ESTree.Node): node is ESTree.UnaryExpression {
  224. return node.type === NodeType.UnaryExpression;
  225. }
  226. /**
  227. * @param {Node} node
  228. * @returns {boolean}
  229. */
  230. public static isUseStrictOperator (node: ESTree.Node): node is ESTree.ExpressionStatement {
  231. return node.type === NodeType.ExpressionStatement && node.directive === 'use strict';
  232. }
  233. /**
  234. * @param {Node} node
  235. * @returns {boolean}
  236. */
  237. public static isVariableDeclarationNode (node: ESTree.Node): node is ESTree.VariableDeclaration {
  238. return node.type === NodeType.VariableDeclaration;
  239. }
  240. /**
  241. * @param {Node} node
  242. * @returns {boolean}
  243. */
  244. public static isVariableDeclaratorNode (node: ESTree.Node): node is ESTree.VariableDeclarator {
  245. return node.type === NodeType.VariableDeclarator;
  246. }
  247. /**
  248. * @param {Node} node
  249. * @returns {boolean}
  250. */
  251. public static isWhileStatementNode (node: ESTree.Node): node is ESTree.WhileStatement {
  252. return node.type === NodeType.WhileStatement;
  253. }
  254. }