NodeUtils.spec.ts 41 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940
  1. import * as ESTree from 'estree';
  2. import { assert } from 'chai';
  3. import { TStatement } from '../../../../src/types/node/TStatement';
  4. import { removeRangesFromStructure } from '../../../helpers/removeRangesFromStructure';
  5. import { NodeFactory } from '../../../../src/node/NodeFactory';
  6. import { NodeUtils } from '../../../../src/node/NodeUtils';
  7. describe('NodeUtils', () => {
  8. describe('addXVerbatimPropertyTo', () => {
  9. let literalNode: ESTree.Literal,
  10. expectedLiteralNode: ESTree.Literal;
  11. before(() => {
  12. literalNode = NodeFactory.literalNode('value');
  13. delete literalNode['x-verbatim-property'];
  14. expectedLiteralNode = NodeFactory.literalNode('value');
  15. NodeUtils.addXVerbatimPropertyTo(literalNode);
  16. });
  17. it('should add `x-verbatim-property` to `Literal` node', () => {
  18. assert.deepEqual(literalNode, expectedLiteralNode);
  19. });
  20. });
  21. describe('clone', () => {
  22. describe('Variant #1: simple AST-tree', () => {
  23. let programNode: ESTree.Program,
  24. expectedProgramNode: ESTree.Program;
  25. before(() => {
  26. // actual AST tree
  27. const expressionStatementNode1: ESTree.ExpressionStatement = NodeFactory.expressionStatementNode(NodeFactory.identifierNode('identifier'));
  28. const expressionStatementNode2: ESTree.ExpressionStatement = NodeFactory.expressionStatementNode(NodeFactory.identifierNode('identifier'));
  29. const ifStatementBlockStatementNode1: ESTree.BlockStatement = NodeFactory.blockStatementNode([
  30. expressionStatementNode1,
  31. expressionStatementNode2
  32. ]);
  33. const ifStatementNode1: ESTree.IfStatement = NodeFactory.ifStatementNode(
  34. NodeFactory.literalNode(true),
  35. ifStatementBlockStatementNode1
  36. );
  37. // expected AST tree
  38. const expressionStatementNode3: ESTree.ExpressionStatement = NodeFactory.expressionStatementNode(NodeFactory.identifierNode('identifier'));
  39. const expressionStatementNode4: ESTree.ExpressionStatement = NodeFactory.expressionStatementNode(NodeFactory.identifierNode('identifier'));
  40. const ifStatementBlockStatementNode2: ESTree.BlockStatement = NodeFactory.blockStatementNode([
  41. expressionStatementNode3,
  42. expressionStatementNode4
  43. ]);
  44. const ifStatementNode2: ESTree.IfStatement = NodeFactory.ifStatementNode(
  45. NodeFactory.literalNode(true),
  46. ifStatementBlockStatementNode2
  47. );
  48. programNode = NodeUtils.clone(
  49. NodeFactory.programNode([
  50. ifStatementNode1
  51. ])
  52. );
  53. expectedProgramNode = NodeUtils.parentizeAst(
  54. NodeFactory.programNode([
  55. ifStatementNode2
  56. ])
  57. );
  58. });
  59. it('should clone given AST-tree', () => {
  60. assert.deepEqual(programNode, expectedProgramNode);
  61. });
  62. });
  63. describe('Variant #2: array expression with `null` element', () => {
  64. let programNode: ESTree.Program,
  65. expectedProgramNode: ESTree.Program;
  66. before(() => {
  67. // actual AST tree
  68. const arrayExpressionNode: ESTree.ArrayExpression = NodeFactory.arrayExpressionNode([
  69. NodeFactory.literalNode(1),
  70. NodeFactory.literalNode(2),
  71. <any>null,
  72. NodeFactory.literalNode(4)
  73. ]);
  74. const expressionStatementNode: ESTree.ExpressionStatement = NodeFactory.expressionStatementNode(
  75. arrayExpressionNode
  76. );
  77. // expected AST tree
  78. const expectedArrayExpressionNode: ESTree.ArrayExpression = NodeFactory.arrayExpressionNode([
  79. NodeFactory.literalNode(1),
  80. NodeFactory.literalNode(2),
  81. <any>null,
  82. NodeFactory.literalNode(4)
  83. ]);
  84. const expectedExpressionStatementNode: ESTree.ExpressionStatement = NodeFactory.expressionStatementNode(
  85. expectedArrayExpressionNode
  86. );
  87. programNode = NodeUtils.clone(
  88. NodeFactory.programNode([
  89. expressionStatementNode
  90. ])
  91. );
  92. expectedProgramNode = NodeUtils.parentizeAst(
  93. NodeFactory.programNode([
  94. expectedExpressionStatementNode
  95. ])
  96. );
  97. });
  98. it('should clone given AST-tree', () => {
  99. assert.deepEqual(programNode, expectedProgramNode);
  100. });
  101. });
  102. });
  103. describe('convertCodeToStructure', () => {
  104. let structure: TStatement[],
  105. expectedStructure: TStatement[];
  106. before(() => {
  107. const code: string = `
  108. var abc = 'cde';
  109. `;
  110. const identifierNode: ESTree.Identifier = NodeFactory.identifierNode('abc');
  111. const literalNode: ESTree.Literal = NodeFactory.literalNode('cde');
  112. const variableDeclaratorNode: ESTree.VariableDeclarator = NodeFactory
  113. .variableDeclaratorNode(identifierNode, literalNode);
  114. const variableDeclarationNode: ESTree.VariableDeclaration = NodeFactory
  115. .variableDeclarationNode([variableDeclaratorNode]);
  116. const programNode: ESTree.Program = NodeFactory.programNode([variableDeclarationNode]);
  117. programNode.parentNode = programNode;
  118. variableDeclarationNode.parentNode = programNode;
  119. variableDeclaratorNode.parentNode = variableDeclarationNode;
  120. identifierNode.parentNode = variableDeclaratorNode;
  121. literalNode.parentNode = variableDeclaratorNode;
  122. structure = removeRangesFromStructure(
  123. NodeUtils.convertCodeToStructure(code)
  124. );
  125. expectedStructure = [variableDeclarationNode];
  126. });
  127. it('should convert code to `ESTree.Node[]` structure array', () => {
  128. assert.deepEqual(structure, expectedStructure);
  129. });
  130. });
  131. describe('convertStructureToCode', () => {
  132. let structure: ESTree.Node[],
  133. expectedCode: string;
  134. before(() => {
  135. structure = [
  136. NodeFactory.programNode([
  137. NodeFactory.variableDeclarationNode([
  138. NodeFactory.variableDeclaratorNode(
  139. NodeFactory.identifierNode('abc'),
  140. NodeFactory.literalNode('cde')
  141. )
  142. ])
  143. ])
  144. ];
  145. expectedCode = 'var abc = \'cde\';';
  146. });
  147. it('should convert `ESTree.Node[]` structure to source code', () => {
  148. assert.deepEqual(NodeUtils.convertStructureToCode(structure), expectedCode);
  149. });
  150. });
  151. describe('getBlockScopeOfNode', () => {
  152. let functionDeclarationBlockStatementNode: ESTree.BlockStatement,
  153. ifStatementBlockStatementNode1: ESTree.BlockStatement,
  154. ifStatementBlockStatementNode2: ESTree.BlockStatement,
  155. ifStatementNode1: ESTree.IfStatement,
  156. ifStatementNode2: ESTree.IfStatement,
  157. expressionStatementNode3: ESTree.ExpressionStatement,
  158. expressionStatementNode2: ESTree.ExpressionStatement,
  159. expressionStatementNode1: ESTree.ExpressionStatement,
  160. functionDeclarationNode: ESTree.FunctionDeclaration,
  161. programNode: ESTree.Program;
  162. before(() => {
  163. expressionStatementNode1 = NodeFactory.expressionStatementNode(NodeFactory.identifierNode('identifier'));
  164. expressionStatementNode2 = NodeFactory.expressionStatementNode(NodeFactory.identifierNode('identifier'));
  165. expressionStatementNode3 = NodeFactory.expressionStatementNode(NodeFactory.identifierNode('identifier'));
  166. ifStatementBlockStatementNode2 = NodeFactory.blockStatementNode([
  167. expressionStatementNode2,
  168. expressionStatementNode3
  169. ]);
  170. ifStatementNode2 = NodeFactory.ifStatementNode(
  171. NodeFactory.literalNode(true),
  172. ifStatementBlockStatementNode2
  173. );
  174. ifStatementBlockStatementNode1 = NodeFactory.blockStatementNode([
  175. ifStatementNode2
  176. ]);
  177. ifStatementNode1 = NodeFactory.ifStatementNode(
  178. NodeFactory.literalNode(true),
  179. ifStatementBlockStatementNode1
  180. );
  181. functionDeclarationBlockStatementNode = NodeFactory.blockStatementNode([
  182. expressionStatementNode1,
  183. ifStatementNode1
  184. ]);
  185. functionDeclarationNode = NodeFactory.functionDeclarationNode('test', [], functionDeclarationBlockStatementNode);
  186. programNode = NodeFactory.programNode([
  187. functionDeclarationNode
  188. ]);
  189. programNode.parentNode = programNode;
  190. functionDeclarationNode.parentNode = programNode;
  191. functionDeclarationBlockStatementNode.parentNode = functionDeclarationNode;
  192. expressionStatementNode1.parentNode = functionDeclarationBlockStatementNode;
  193. ifStatementNode1.parentNode = functionDeclarationBlockStatementNode;
  194. ifStatementBlockStatementNode1.parentNode = ifStatementNode1;
  195. ifStatementNode2.parentNode = ifStatementBlockStatementNode1;
  196. ifStatementBlockStatementNode2.parentNode = ifStatementNode2;
  197. expressionStatementNode3.parentNode = ifStatementBlockStatementNode2;
  198. });
  199. it('should return block-scope node for `program` node child node', () => {
  200. assert.deepEqual(NodeUtils.getBlockScopeOfNode(programNode), programNode);
  201. });
  202. it('should return block-scope node for `functionDeclaration` node child node', () => {
  203. assert.deepEqual(NodeUtils.getBlockScopeOfNode(functionDeclarationNode), programNode);
  204. });
  205. it('should return block-scope node for `functionDeclaration blockStatement` node child node', () => {
  206. assert.deepEqual(NodeUtils.getBlockScopeOfNode(functionDeclarationBlockStatementNode), programNode);
  207. });
  208. it('should return block-scope node for `expressionStatement` node #1 child node', () => {
  209. assert.deepEqual(NodeUtils.getBlockScopeOfNode(expressionStatementNode1), functionDeclarationBlockStatementNode);
  210. });
  211. it('should return block-scope node for `ifStatement` node child node', () => {
  212. assert.deepEqual(NodeUtils.getBlockScopeOfNode(ifStatementNode1), functionDeclarationBlockStatementNode);
  213. });
  214. it('should return block-scope node for `ifStatement blockStatement` node #1 child node', () => {
  215. assert.deepEqual(NodeUtils.getBlockScopeOfNode(ifStatementBlockStatementNode1), functionDeclarationBlockStatementNode);
  216. });
  217. it('should return block-scope node for `ifStatement blockStatement` node #2 child node', () => {
  218. assert.deepEqual(NodeUtils.getBlockScopeOfNode(ifStatementBlockStatementNode2), functionDeclarationBlockStatementNode);
  219. });
  220. it('should return block-scope node for `expressionStatement` node #3 child node', () => {
  221. assert.deepEqual(NodeUtils.getBlockScopeOfNode(expressionStatementNode3), functionDeclarationBlockStatementNode);
  222. });
  223. it('should throw a `ReferenceError` if node has no `parentNode` property', () => {
  224. assert.throws(() => NodeUtils.getBlockScopeOfNode(expressionStatementNode2), ReferenceError);
  225. });
  226. });
  227. describe('getBlockScopesOfNode', () => {
  228. let functionDeclarationBlockStatementNode: ESTree.BlockStatement,
  229. ifStatementBlockStatementNode1: ESTree.BlockStatement,
  230. ifStatementBlockStatementNode2: ESTree.BlockStatement,
  231. ifStatementNode1: ESTree.IfStatement,
  232. ifStatementNode2: ESTree.IfStatement,
  233. expressionStatementNode3: ESTree.ExpressionStatement,
  234. expressionStatementNode2: ESTree.ExpressionStatement,
  235. expressionStatementNode1: ESTree.ExpressionStatement,
  236. functionDeclarationNode: ESTree.FunctionDeclaration,
  237. programNode: ESTree.Program;
  238. before(() => {
  239. expressionStatementNode1 = NodeFactory.expressionStatementNode(NodeFactory.identifierNode('identifier'));
  240. expressionStatementNode2 = NodeFactory.expressionStatementNode(NodeFactory.identifierNode('identifier'));
  241. expressionStatementNode3 = NodeFactory.expressionStatementNode(NodeFactory.identifierNode('identifier'));
  242. ifStatementBlockStatementNode2 = NodeFactory.blockStatementNode([
  243. expressionStatementNode2,
  244. expressionStatementNode3
  245. ]);
  246. ifStatementNode2 = NodeFactory.ifStatementNode(
  247. NodeFactory.literalNode(true),
  248. ifStatementBlockStatementNode2
  249. );
  250. ifStatementBlockStatementNode1 = NodeFactory.blockStatementNode([
  251. ifStatementNode2
  252. ]);
  253. ifStatementNode1 = NodeFactory.ifStatementNode(
  254. NodeFactory.literalNode(true),
  255. ifStatementBlockStatementNode1
  256. );
  257. functionDeclarationBlockStatementNode = NodeFactory.blockStatementNode([
  258. expressionStatementNode1,
  259. ifStatementNode1
  260. ]);
  261. functionDeclarationNode = NodeFactory.functionDeclarationNode('test', [], functionDeclarationBlockStatementNode);
  262. programNode = NodeFactory.programNode([
  263. functionDeclarationNode
  264. ]);
  265. programNode.parentNode = programNode;
  266. functionDeclarationNode.parentNode = programNode;
  267. functionDeclarationBlockStatementNode.parentNode = functionDeclarationNode;
  268. expressionStatementNode1.parentNode = functionDeclarationBlockStatementNode;
  269. ifStatementNode1.parentNode = functionDeclarationBlockStatementNode;
  270. ifStatementBlockStatementNode1.parentNode = ifStatementNode1;
  271. ifStatementNode2.parentNode = ifStatementBlockStatementNode1;
  272. ifStatementBlockStatementNode2.parentNode = ifStatementNode2;
  273. expressionStatementNode3.parentNode = ifStatementBlockStatementNode2;
  274. });
  275. it('should return block-scope node for `program` node child node', () => {
  276. assert.deepEqual(NodeUtils.getBlockScopesOfNode(programNode)[0], programNode);
  277. });
  278. it('should return block-scope node for `functionDeclaration` node child node #1', () => {
  279. assert.deepEqual(NodeUtils.getBlockScopesOfNode(functionDeclarationNode)[0], programNode);
  280. });
  281. it('should return block-scope node for `functionDeclaration blockStatement` node child node #1', () => {
  282. assert.deepEqual(NodeUtils.getBlockScopesOfNode(functionDeclarationBlockStatementNode)[0], programNode);
  283. });
  284. it('should return block-scope node for `expressionStatement` node #1 child node #1', () => {
  285. assert.deepEqual(NodeUtils.getBlockScopesOfNode(expressionStatementNode1)[0], functionDeclarationBlockStatementNode);
  286. });
  287. it('should return block-scope node for `expressionStatement` node #1 child node #2', () => {
  288. assert.deepEqual(NodeUtils.getBlockScopesOfNode(expressionStatementNode1)[1], programNode);
  289. });
  290. it('should return block-scope node for `ifStatement` node child node #1', () => {
  291. assert.deepEqual(NodeUtils.getBlockScopesOfNode(ifStatementNode1)[0], functionDeclarationBlockStatementNode);
  292. });
  293. it('should return block-scope node for `ifStatement` node child node #2', () => {
  294. assert.deepEqual(NodeUtils.getBlockScopesOfNode(ifStatementNode1)[1], programNode);
  295. });
  296. it('should return block-scope node for `ifStatement blockStatement` node #1 child node #1', () => {
  297. assert.deepEqual(NodeUtils.getBlockScopesOfNode(ifStatementBlockStatementNode1)[0], functionDeclarationBlockStatementNode);
  298. });
  299. it('should return block-scope node for `ifStatement blockStatement` node #1 child node #2', () => {
  300. assert.deepEqual(NodeUtils.getBlockScopesOfNode(ifStatementBlockStatementNode1)[1], programNode);
  301. });
  302. it('should return block-scope node for `ifStatement blockStatement` node #2 child node #1', () => {
  303. assert.deepEqual(NodeUtils.getBlockScopesOfNode(ifStatementBlockStatementNode2)[0], functionDeclarationBlockStatementNode);
  304. });
  305. it('should return block-scope node for `ifStatement blockStatement` node #1 child node #2', () => {
  306. assert.deepEqual(NodeUtils.getBlockScopesOfNode(ifStatementBlockStatementNode2)[1], programNode);
  307. });
  308. it('should return block-scope node for `expressionStatement` node #3 child node #1', () => {
  309. assert.deepEqual(NodeUtils.getBlockScopesOfNode(expressionStatementNode3)[0], functionDeclarationBlockStatementNode);
  310. });
  311. it('should return block-scope node for `expressionStatement` node #3 child node #2', () => {
  312. assert.deepEqual(NodeUtils.getBlockScopesOfNode(expressionStatementNode3)[1], programNode);
  313. });
  314. it('should throw a `ReferenceError` if node has no `parentNode` property', () => {
  315. assert.throws(() => NodeUtils.getBlockScopesOfNode(expressionStatementNode2)[0], ReferenceError);
  316. });
  317. });
  318. describe('getNextSiblingStatement', () => {
  319. describe('Variant #1: block statement node as scope node', () => {
  320. let statementNode1: ESTree.Statement,
  321. statementNode2: ESTree.Statement,
  322. statementNode3: ESTree.Statement;
  323. before(() => {
  324. statementNode1 = NodeFactory.expressionStatementNode(
  325. NodeFactory.identifierNode('a')
  326. );
  327. statementNode2 = NodeFactory.expressionStatementNode(
  328. NodeFactory.identifierNode('b')
  329. );
  330. statementNode3 = NodeFactory.expressionStatementNode(
  331. NodeFactory.identifierNode('c')
  332. );
  333. const blockStatementNode: ESTree.BlockStatement = NodeFactory.blockStatementNode([
  334. statementNode1,
  335. statementNode2,
  336. statementNode3
  337. ]);
  338. statementNode1.parentNode = blockStatementNode;
  339. statementNode2.parentNode = blockStatementNode;
  340. statementNode3.parentNode = blockStatementNode;
  341. });
  342. it('should return next sibling statement node', () => {
  343. assert.deepEqual(NodeUtils.getNextSiblingStatement(statementNode1), statementNode2);
  344. });
  345. it('should return next sibling statement node', () => {
  346. assert.deepEqual(NodeUtils.getNextSiblingStatement(statementNode2), statementNode3);
  347. });
  348. it('should return `null` if given statement node is last node in the scope', () => {
  349. assert.deepEqual(NodeUtils.getNextSiblingStatement(statementNode3), null);
  350. });
  351. });
  352. describe('Variant #2: switch case node as scope node', () => {
  353. let statementNode1: ESTree.Statement,
  354. statementNode2: ESTree.Statement,
  355. statementNode3: ESTree.Statement;
  356. before(() => {
  357. statementNode1 = NodeFactory.expressionStatementNode(
  358. NodeFactory.identifierNode('a')
  359. );
  360. statementNode2 = NodeFactory.expressionStatementNode(
  361. NodeFactory.identifierNode('b')
  362. );
  363. statementNode3 = NodeFactory.expressionStatementNode(
  364. NodeFactory.identifierNode('c')
  365. );
  366. const switchCaseNode: ESTree.SwitchCase = NodeFactory.switchCaseNode(
  367. NodeFactory.literalNode(true),
  368. [
  369. statementNode1,
  370. statementNode2,
  371. statementNode3
  372. ]
  373. );
  374. statementNode1.parentNode = switchCaseNode;
  375. statementNode2.parentNode = switchCaseNode;
  376. statementNode3.parentNode = switchCaseNode;
  377. });
  378. it('should return next sibling statement node', () => {
  379. assert.deepEqual(NodeUtils.getNextSiblingStatement(statementNode1), statementNode2);
  380. });
  381. it('should return next sibling statement node', () => {
  382. assert.deepEqual(NodeUtils.getNextSiblingStatement(statementNode2), statementNode3);
  383. });
  384. it('should return `null` if given statement node is last node in the scope', () => {
  385. assert.deepEqual(NodeUtils.getNextSiblingStatement(statementNode3), null);
  386. });
  387. });
  388. });
  389. describe('getPreviousSiblingStatement', () => {
  390. describe('Variant #1: block statement node as scope node', () => {
  391. let statementNode1: ESTree.Statement,
  392. statementNode2: ESTree.Statement,
  393. statementNode3: ESTree.Statement;
  394. before(() => {
  395. statementNode1 = NodeFactory.expressionStatementNode(
  396. NodeFactory.identifierNode('a')
  397. );
  398. statementNode2 = NodeFactory.expressionStatementNode(
  399. NodeFactory.identifierNode('b')
  400. );
  401. statementNode3 = NodeFactory.expressionStatementNode(
  402. NodeFactory.identifierNode('c')
  403. );
  404. const blockStatementNode: ESTree.BlockStatement = NodeFactory.blockStatementNode([
  405. statementNode1,
  406. statementNode2,
  407. statementNode3
  408. ]);
  409. statementNode1.parentNode = blockStatementNode;
  410. statementNode2.parentNode = blockStatementNode;
  411. statementNode3.parentNode = blockStatementNode;
  412. });
  413. it('should return next sibling statement node', () => {
  414. assert.deepEqual(NodeUtils.getPreviousSiblingStatement(statementNode1), null);
  415. });
  416. it('should return next sibling statement node', () => {
  417. assert.deepEqual(NodeUtils.getPreviousSiblingStatement(statementNode2), statementNode1);
  418. });
  419. it('should return `null` if given statement node is last node in the scope', () => {
  420. assert.deepEqual(NodeUtils.getPreviousSiblingStatement(statementNode3), statementNode2);
  421. });
  422. });
  423. describe('Variant #2: switch case node as scope node', () => {
  424. let statementNode1: ESTree.Statement,
  425. statementNode2: ESTree.Statement,
  426. statementNode3: ESTree.Statement;
  427. before(() => {
  428. statementNode1 = NodeFactory.expressionStatementNode(
  429. NodeFactory.identifierNode('a')
  430. );
  431. statementNode2 = NodeFactory.expressionStatementNode(
  432. NodeFactory.identifierNode('b')
  433. );
  434. statementNode3 = NodeFactory.expressionStatementNode(
  435. NodeFactory.identifierNode('c')
  436. );
  437. const switchCaseNode: ESTree.SwitchCase = NodeFactory.switchCaseNode(
  438. NodeFactory.literalNode(true),
  439. [
  440. statementNode1,
  441. statementNode2,
  442. statementNode3
  443. ]
  444. );
  445. statementNode1.parentNode = switchCaseNode;
  446. statementNode2.parentNode = switchCaseNode;
  447. statementNode3.parentNode = switchCaseNode;
  448. });
  449. it('should return next sibling statement node', () => {
  450. assert.deepEqual(NodeUtils.getPreviousSiblingStatement(statementNode1), null);
  451. });
  452. it('should return next sibling statement node', () => {
  453. assert.deepEqual(NodeUtils.getPreviousSiblingStatement(statementNode2), statementNode1);
  454. });
  455. it('should return `null` if given statement node is last node in the scope', () => {
  456. assert.deepEqual(NodeUtils.getPreviousSiblingStatement(statementNode3), statementNode2);
  457. });
  458. });
  459. });
  460. describe('getRootStatementOfNode', () => {
  461. let assignmentExpression: ESTree.AssignmentExpression,
  462. expressionStatement: ESTree.ExpressionStatement,
  463. identifierNode1: ESTree.Identifier,
  464. identifierNode2: ESTree.Identifier,
  465. identifierNode3: ESTree.Identifier,
  466. identifierNode4: ESTree.Identifier,
  467. identifierNode5: ESTree.Identifier,
  468. functionDeclarationNode: ESTree.FunctionDeclaration,
  469. functionDeclarationBlockStatementNode: ESTree.BlockStatement,
  470. programNode: ESTree.Program,
  471. variableDeclarationNode: ESTree.VariableDeclaration;
  472. before(() => {
  473. identifierNode1 = NodeFactory.identifierNode('identifier');
  474. identifierNode2 = NodeFactory.identifierNode('identifier');
  475. identifierNode3 = NodeFactory.identifierNode('identifier');
  476. identifierNode4 = NodeFactory.identifierNode('foo');
  477. identifierNode5 = NodeFactory.identifierNode('bar');
  478. assignmentExpression = NodeFactory.assignmentExpressionNode(
  479. '=',
  480. identifierNode4,
  481. identifierNode5
  482. );
  483. expressionStatement = NodeFactory.expressionStatementNode(
  484. assignmentExpression
  485. );
  486. variableDeclarationNode = NodeFactory.variableDeclarationNode([
  487. NodeFactory.variableDeclaratorNode(
  488. identifierNode1,
  489. NodeFactory.binaryExpressionNode(
  490. '+',
  491. identifierNode2,
  492. identifierNode3
  493. )
  494. )
  495. ]);
  496. functionDeclarationBlockStatementNode = NodeFactory.blockStatementNode([
  497. variableDeclarationNode
  498. ]);
  499. functionDeclarationNode = NodeFactory.functionDeclarationNode('test', [], functionDeclarationBlockStatementNode);
  500. programNode = NodeFactory.programNode([
  501. functionDeclarationNode,
  502. NodeFactory.ifStatementNode(
  503. NodeFactory.literalNode(true),
  504. NodeFactory.blockStatementNode([
  505. expressionStatement
  506. ])
  507. )
  508. ]);
  509. NodeUtils.parentizeAst(programNode);
  510. identifierNode3.parentNode = undefined;
  511. });
  512. it('should return root statement in scope for `program` node child', () => {
  513. assert.throws(() => NodeUtils.getRootStatementOfNode(programNode), Error);
  514. });
  515. it('should return root statement in scope for `functionDeclaration` node #1', () => {
  516. assert.deepEqual(NodeUtils.getRootStatementOfNode(functionDeclarationNode), functionDeclarationNode);
  517. });
  518. it('should return root statement in scope for `functionDeclaration blockStatement` node #1', () => {
  519. assert.deepEqual(NodeUtils.getRootStatementOfNode(functionDeclarationBlockStatementNode), functionDeclarationNode);
  520. });
  521. it('should return root statement in scope for `identifier` node #1', () => {
  522. assert.deepEqual(NodeUtils.getRootStatementOfNode(identifierNode1), variableDeclarationNode);
  523. });
  524. it('should return root statement in scope for `identifier` node #2', () => {
  525. assert.deepEqual(NodeUtils.getRootStatementOfNode(identifierNode2), variableDeclarationNode);
  526. });
  527. it('should return root statement in scope for `identifier` node #4', () => {
  528. assert.deepEqual(NodeUtils.getRootStatementOfNode(identifierNode4), expressionStatement);
  529. });
  530. it('should return root statement in scope for `identifier` node #5', () => {
  531. assert.deepEqual(NodeUtils.getRootStatementOfNode(identifierNode5), expressionStatement);
  532. });
  533. it('should throw a `ReferenceError` if node has no `parentNode` property', () => {
  534. assert.throws(() => NodeUtils.getRootStatementOfNode(identifierNode3), ReferenceError);
  535. });
  536. });
  537. describe('getScopeOfNode', () => {
  538. let functionDeclarationBlockStatementNode: ESTree.BlockStatement,
  539. ifStatementBlockStatementNode1: ESTree.BlockStatement,
  540. ifStatementBlockStatementNode2: ESTree.BlockStatement,
  541. ifStatementBlockStatementNode3: ESTree.BlockStatement,
  542. ifStatementNode1: ESTree.IfStatement,
  543. ifStatementNode2: ESTree.IfStatement,
  544. ifStatementNode3: ESTree.IfStatement,
  545. switchCaseNode: ESTree.SwitchCase,
  546. switchStatementNode: ESTree.SwitchStatement,
  547. expressionStatementNode3: ESTree.ExpressionStatement,
  548. expressionStatementNode2: ESTree.ExpressionStatement,
  549. expressionStatementNode1: ESTree.ExpressionStatement,
  550. functionDeclarationNode: ESTree.FunctionDeclaration,
  551. programNode: ESTree.Program;
  552. before(() => {
  553. expressionStatementNode1 = NodeFactory.expressionStatementNode(NodeFactory.identifierNode('identifier'));
  554. expressionStatementNode2 = NodeFactory.expressionStatementNode(NodeFactory.identifierNode('identifier'));
  555. expressionStatementNode3 = NodeFactory.expressionStatementNode(NodeFactory.identifierNode('identifier'));
  556. ifStatementBlockStatementNode3 = NodeFactory.blockStatementNode([
  557. expressionStatementNode2,
  558. expressionStatementNode3
  559. ]);
  560. ifStatementNode3 = NodeFactory.ifStatementNode(
  561. NodeFactory.literalNode(true),
  562. ifStatementBlockStatementNode3
  563. );
  564. ifStatementBlockStatementNode2 = NodeFactory.blockStatementNode();
  565. ifStatementBlockStatementNode1 = NodeFactory.blockStatementNode([
  566. ifStatementNode3
  567. ]);
  568. ifStatementNode2 = NodeFactory.ifStatementNode(
  569. NodeFactory.literalNode(true),
  570. ifStatementBlockStatementNode2
  571. );
  572. ifStatementNode1 = NodeFactory.ifStatementNode(
  573. NodeFactory.literalNode(true),
  574. ifStatementBlockStatementNode1
  575. );
  576. switchCaseNode = NodeFactory.switchCaseNode(
  577. NodeFactory.literalNode(1),
  578. [
  579. ifStatementNode2
  580. ]
  581. );
  582. switchStatementNode = NodeFactory.switchStatementNode(
  583. NodeFactory.literalNode(1),
  584. [
  585. switchCaseNode
  586. ]
  587. );
  588. functionDeclarationBlockStatementNode = NodeFactory.blockStatementNode([
  589. expressionStatementNode1,
  590. ifStatementNode1,
  591. switchStatementNode
  592. ]);
  593. functionDeclarationNode = NodeFactory.functionDeclarationNode('test', [], functionDeclarationBlockStatementNode);
  594. programNode = NodeFactory.programNode([
  595. functionDeclarationNode
  596. ]);
  597. programNode.parentNode = programNode;
  598. functionDeclarationNode.parentNode = programNode;
  599. functionDeclarationBlockStatementNode.parentNode = functionDeclarationNode;
  600. expressionStatementNode1.parentNode = functionDeclarationBlockStatementNode;
  601. ifStatementNode1.parentNode = functionDeclarationBlockStatementNode;
  602. ifStatementBlockStatementNode1.parentNode = ifStatementNode1;
  603. switchStatementNode.parentNode = functionDeclarationBlockStatementNode;
  604. switchCaseNode.parentNode = switchStatementNode;
  605. ifStatementNode2.parentNode = switchCaseNode;
  606. ifStatementBlockStatementNode2.parentNode = ifStatementNode2;
  607. ifStatementNode3.parentNode = ifStatementBlockStatementNode1;
  608. ifStatementBlockStatementNode3.parentNode = ifStatementNode3;
  609. expressionStatementNode3.parentNode = ifStatementBlockStatementNode3;
  610. });
  611. it('should return scope node for `program` node child', () => {
  612. assert.deepEqual(NodeUtils.getScopeOfNode(programNode), programNode);
  613. });
  614. it('should return scope node for `functionDeclaration` node child node #1', () => {
  615. assert.deepEqual(NodeUtils.getScopeOfNode(functionDeclarationNode), programNode);
  616. });
  617. it('should return scope node for `functionDeclaration blockStatement` node child node #1', () => {
  618. assert.deepEqual(NodeUtils.getScopeOfNode(functionDeclarationBlockStatementNode), programNode);
  619. });
  620. it('should return scope node for `expressionStatement` node #1 child node', () => {
  621. assert.deepEqual(NodeUtils.getScopeOfNode(expressionStatementNode1), functionDeclarationBlockStatementNode);
  622. });
  623. it('should return scope node for `ifStatement` node #1 child node', () => {
  624. assert.deepEqual(NodeUtils.getScopeOfNode(ifStatementNode1), functionDeclarationBlockStatementNode);
  625. });
  626. it('should return scope node for `switchStatement` node child node', () => {
  627. assert.deepEqual(NodeUtils.getScopeOfNode(switchStatementNode), functionDeclarationBlockStatementNode);
  628. });
  629. it('should return scope node for `switchCase` node child node', () => {
  630. assert.deepEqual(NodeUtils.getScopeOfNode(switchCaseNode), functionDeclarationBlockStatementNode);
  631. });
  632. it('should return scope node for `ifStatement` node #2 child node', () => {
  633. assert.deepEqual(NodeUtils.getScopeOfNode(ifStatementNode2), switchCaseNode);
  634. });
  635. it('should return scope node for `ifStatement blockStatement` node #2 child node', () => {
  636. assert.deepEqual(NodeUtils.getScopeOfNode(ifStatementBlockStatementNode2), switchCaseNode);
  637. });
  638. it('should return scope node for `ifStatement blockStatement` node #1 child node', () => {
  639. assert.deepEqual(NodeUtils.getScopeOfNode(ifStatementBlockStatementNode1), functionDeclarationBlockStatementNode);
  640. });
  641. it('should return scope node for `ifStatement blockStatement` node #3 child node', () => {
  642. assert.deepEqual(NodeUtils.getScopeOfNode(ifStatementBlockStatementNode3), ifStatementBlockStatementNode1);
  643. });
  644. it('should return scope node for `expressionStatement` node #3 child node', () => {
  645. assert.deepEqual(NodeUtils.getScopeOfNode(expressionStatementNode3), ifStatementBlockStatementNode3);
  646. });
  647. it('should throw a `ReferenceError` if node has no `parentNode` property', () => {
  648. assert.throws(() => NodeUtils.getScopeOfNode(expressionStatementNode2), ReferenceError);
  649. });
  650. });
  651. describe('getUnaryExpressionArgumentNode', () => {
  652. let expectedNode: ESTree.Literal,
  653. unaryExpressionArgumentNode: ESTree.Node;
  654. before(() => {
  655. const literalNode: ESTree.Literal = NodeFactory.literalNode('test');
  656. const unaryExpressionNode2: ESTree.UnaryExpression = NodeFactory.unaryExpressionNode('!', literalNode);
  657. const unaryExpressionNode1: ESTree.UnaryExpression = NodeFactory.unaryExpressionNode('!', unaryExpressionNode2);
  658. const expressionStatementNode: ESTree.ExpressionStatement = NodeFactory.expressionStatementNode(unaryExpressionNode1);
  659. const programNode: ESTree.Program = NodeFactory.programNode([
  660. expressionStatementNode
  661. ]);
  662. programNode.parentNode = programNode;
  663. expressionStatementNode.parentNode = programNode;
  664. unaryExpressionNode1.parentNode = expressionStatementNode;
  665. unaryExpressionNode2.parentNode = unaryExpressionNode1;
  666. literalNode.parentNode = unaryExpressionNode2;
  667. unaryExpressionArgumentNode = NodeUtils.getUnaryExpressionArgumentNode(unaryExpressionNode1);
  668. expectedNode = literalNode;
  669. });
  670. it('should return unary expression argument node', () => {
  671. assert.deepEqual(unaryExpressionArgumentNode, expectedNode);
  672. });
  673. });
  674. describe('parentizeAst', () => {
  675. let ifStatementNode: ESTree.IfStatement,
  676. ifStatementBlockStatementNode: ESTree.BlockStatement,
  677. expressionStatementNode1: ESTree.ExpressionStatement,
  678. expressionStatementNode2: ESTree.ExpressionStatement,
  679. programNode: ESTree.Program;
  680. beforeEach(() => {
  681. expressionStatementNode1 = NodeFactory.expressionStatementNode(NodeFactory.identifierNode('identifier'));
  682. expressionStatementNode2 = NodeFactory.expressionStatementNode(NodeFactory.identifierNode('identifier'));
  683. ifStatementBlockStatementNode = NodeFactory.blockStatementNode([
  684. expressionStatementNode1,
  685. expressionStatementNode2
  686. ]);
  687. ifStatementNode = NodeFactory.ifStatementNode(
  688. NodeFactory.literalNode(true),
  689. ifStatementBlockStatementNode
  690. );
  691. });
  692. describe('Variant #1: parentize AST-tree with `ProgramNode` as root node', () => {
  693. beforeEach(() => {
  694. programNode = NodeFactory.programNode([
  695. ifStatementNode
  696. ]);
  697. programNode = NodeUtils.parentizeAst(programNode);
  698. });
  699. it('should parentize `program` node with `ProgramNode` as root node', () => {
  700. assert.deepEqual(programNode.parentNode, programNode);
  701. });
  702. it('should parentize `ifStatement` node with `ProgramNode` as root node', () => {
  703. assert.deepEqual(ifStatementNode.parentNode, programNode);
  704. });
  705. it('should parentize `ifStatement blockStatement` node with `ProgramNode` as root node', () => {
  706. assert.deepEqual(ifStatementBlockStatementNode.parentNode, ifStatementNode);
  707. });
  708. it('should parentize `expressionStatement` node #1 with `ProgramNode` as root node', () => {
  709. assert.deepEqual(expressionStatementNode1.parentNode, ifStatementBlockStatementNode);
  710. });
  711. it('should parentize `expressionStatement` node #2 with `ProgramNode` as root node', () => {
  712. assert.deepEqual(expressionStatementNode2.parentNode, ifStatementBlockStatementNode);
  713. });
  714. });
  715. describe('Variant #2: parentize AST-tree', () => {
  716. beforeEach(() => {
  717. ifStatementNode = NodeUtils.parentizeAst(ifStatementNode);
  718. });
  719. it('should parentize `ifStatement` node', () => {
  720. assert.deepEqual(ifStatementNode.parentNode, ifStatementNode);
  721. });
  722. it('should parentize `ifStatement blockStatement` node', () => {
  723. assert.deepEqual(ifStatementBlockStatementNode.parentNode, ifStatementNode);
  724. });
  725. it('should parentize `expressionStatement` node #1', () => {
  726. assert.deepEqual(expressionStatementNode1.parentNode, ifStatementBlockStatementNode);
  727. });
  728. it('should parentize `expressionStatement` node #2', () => {
  729. assert.deepEqual(expressionStatementNode2.parentNode, ifStatementBlockStatementNode);
  730. });
  731. });
  732. });
  733. describe('parentizeNode', () => {
  734. describe('Variant #1: node with parent node', () => {
  735. const identifier: ESTree.Identifier = NodeFactory.identifierNode('foo');
  736. const breakStatement: ESTree.BreakStatement = NodeFactory.breakStatement(identifier);
  737. const expectedResult: ESTree.Identifier = NodeUtils.clone(identifier);
  738. let result: ESTree.Identifier;
  739. before(() => {
  740. expectedResult.parentNode = breakStatement;
  741. result = NodeUtils.parentizeNode(identifier, breakStatement);
  742. });
  743. it('should parentize given node', () => {
  744. assert.deepEqual(result, expectedResult);
  745. });
  746. });
  747. describe('Variant #2: node without parent node', () => {
  748. const identifier: ESTree.Identifier = NodeFactory.identifierNode('Foo');
  749. const expectedResult: ESTree.Identifier = NodeUtils.clone(identifier);
  750. let result: ESTree.Identifier;
  751. before(() => {
  752. expectedResult.parentNode = expectedResult;
  753. result = NodeUtils.parentizeNode(identifier, <any>null);
  754. });
  755. it('should parentize given node', () => {
  756. assert.deepEqual(result, expectedResult);
  757. });
  758. });
  759. });
  760. });