forked from babel/babel
/
traverse.js
398 lines (351 loc) · 10.5 KB
/
traverse.js
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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
import { parse } from "@babel/parser";
import * as t from "@babel/types";
import _traverse from "../lib/index.js";
const traverse = _traverse.default || _traverse;
import { callFromAtBabelPackage } from "./helpers/@babel/fake-babel-package/index.js";
describe("traverse", function () {
const code = `
var foo = "bar";
this.test = "wow";
`;
const ast = parse(code);
const program = ast.program;
const body = program.body;
it("traverse replace", function () {
const replacement = {
type: "StringLiteral",
value: "foo",
};
const ast2 = JSON.parse(JSON.stringify(program));
traverse(ast2, {
enter: function (path) {
if (path.node.type === "ThisExpression") path.replaceWith(replacement);
},
});
expect(ast2.body[1].expression.left.object).toBe(replacement);
});
it("traverse", function () {
const expected = [
body[0],
body[0].declarations[0],
body[0].declarations[0].id,
body[0].declarations[0].init,
body[1],
body[1].expression,
body[1].expression.left,
body[1].expression.left.object,
body[1].expression.left.property,
body[1].expression.right,
];
const actual = [];
traverse(program, {
enter: function (path) {
actual.push(path.node);
},
});
expect(actual).toEqual(expected);
});
it("traverse falsy parent", function () {
traverse(null, {
enter: function () {
throw new Error("should not be ran");
},
});
});
it("traverse denylistTypes", function () {
const expected = [
body[0],
body[0].declarations[0],
body[0].declarations[0].id,
body[0].declarations[0].init,
body[1],
body[1].expression,
body[1].expression.right,
];
const actual = [];
traverse(program, {
denylist: ["MemberExpression"],
enter: function (path) {
actual.push(path.node);
},
});
expect(actual).toEqual(expected);
});
it("hasType", function () {
expect(traverse.hasType(ast, "ThisExpression")).toBeTruthy();
expect(
traverse.hasType(ast, "ThisExpression", ["AssignmentExpression"]),
).toBeFalsy();
expect(traverse.hasType(ast, "ThisExpression")).toBeTruthy();
expect(traverse.hasType(ast, "Program")).toBeTruthy();
expect(
traverse.hasType(ast, "ThisExpression", ["MemberExpression"]),
).toBeFalsy();
expect(traverse.hasType(ast, "ThisExpression", ["Program"])).toBeFalsy();
expect(traverse.hasType(ast, "ArrowFunctionExpression")).toBeFalsy();
});
it("clearCache", function () {
const paths = [];
const scopes = [];
traverse(ast, {
enter(path) {
scopes.push(path.scope);
paths.push(path);
path.stop();
},
});
traverse.cache.clear();
const paths2 = [];
const scopes2 = [];
traverse(ast, {
enter(path) {
scopes2.push(path.scope);
paths2.push(path);
path.stop();
},
});
scopes2.forEach(function (_, i) {
expect(scopes[i]).not.toBe(scopes2[i]);
expect(paths[i]).not.toBe(paths2[i]);
});
});
it("clearPath", function () {
const paths = [];
traverse(ast, {
enter(path) {
paths.push(path);
},
});
traverse.cache.clearPath();
const paths2 = [];
traverse(ast, {
enter(path) {
paths2.push(path);
},
});
paths2.forEach(function (p, i) {
expect(p).not.toBe(paths[i]);
});
});
it("clearScope", function () {
const scopes = [];
traverse(ast, {
enter(path) {
scopes.push(path.scope);
path.stop();
},
});
traverse.cache.clearScope();
const scopes2 = [];
traverse(ast, {
enter(path) {
scopes2.push(path.scope);
path.stop();
},
});
scopes2.forEach(function (p, i) {
expect(p).not.toBe(scopes[i]);
});
});
describe("path.skip()", function () {
it("replaced paths can be skipped", function () {
const ast = parse("id");
let skipped;
traverse(ast, {
noScope: true,
Identifier(path) {
path.replaceWith(t.numericLiteral(0));
path.skip();
skipped = true;
},
NumericLiteral() {
skipped = false;
},
});
expect(skipped).toBe(true);
});
// Skipped: see the comment in the `NodePath.requeue` method.
// eslint-disable-next-line jest/no-disabled-tests
it.skip("skipped and requeued paths should be visited", function () {
const ast = parse("id");
let visited = false;
traverse(ast, {
noScope: true,
Identifier(path) {
path.replaceWith(t.numericLiteral(0));
path.skip();
path.requeue();
},
NumericLiteral() {
visited = true;
},
});
expect(visited).toBe(true);
});
});
describe("path.visit()", () => {
it("should preserve traversal context after enter hook is executed", () => {
const ast = parse("{;}");
// The test initiates a sub-traverse from program. When the `enter` hook of BlockStatement
// is called, the unshiftContainer will change the traversal context of the BlockStatement
// to the one of Program which has an EmptyStatement visitor. If the traversal context
// is not restored after the `enter` hook is executed, the `EmptyStatement` visitor will
// be run twice: one in the sub-traverse and the other in the top level traverse.
let emptyStatementVisitedCounter = 0;
traverse(ast, {
noScope: true,
Program(path) {
path.traverse({
noScope: true,
BlockStatement: {
enter(path) {
path.parentPath.unshiftContainer("body", [t.numericLiteral(0)]);
},
},
});
},
EmptyStatement() {
++emptyStatementVisitedCounter;
},
});
expect(emptyStatementVisitedCounter).toBe(1);
});
it("should preserve traversal context after visitor is executed", () => {
const ast = parse("{;}");
// The test initiates a sub-traverse from program. During the BlockStatement is traversed,
// the EmptyStatement visitor will be called and the unshiftContainer will change the
// traversal context of the BlockStatement to that of Program which has an EmptyStatement
// visitor. If the traversal context is not restored after `enter` hook is executed,
// the `BlockStatement:exit` visitor will be run twice: one in the sub-traverse and the other
// in the top level traverse.
let blockStatementVisitedCounter = 0;
traverse(ast, {
noScope: true,
Program(path) {
path.traverse({
noScope: true,
EmptyStatement: {
enter(path) {
path.parentPath.parentPath.unshiftContainer("body", [
t.numericLiteral(0),
]);
},
},
});
},
BlockStatement: {
exit() {
++blockStatementVisitedCounter;
},
},
});
expect(blockStatementVisitedCounter).toBe(1);
});
});
describe("path.stop()", () => {
it("should stop the traversal when a grand child is stopped", () => {
const ast = parse("f;g;");
let visitedCounter = 0;
traverse(ast, {
noScope: true,
Identifier(path) {
visitedCounter += 1;
path.stop();
},
});
expect(visitedCounter).toBe(1);
});
it("can be reverted in the exit listener of the parent whose child is stopped", () => {
const ast = parse("f;g;");
let visitedCounter = 0;
traverse(ast, {
noScope: true,
Identifier(path) {
visitedCounter += 1;
path.stop();
},
ExpressionStatement: {
exit(path) {
path.shouldStop = false;
path.shouldSkip = false;
},
},
});
expect(visitedCounter).toBe(2);
});
it("should not affect root traversal", () => {
const ast = parse("f;g;");
let visitedCounter = 0;
let programShouldStop;
traverse(ast, {
noScope: true,
Program(path) {
path.traverse({
noScope: true,
Identifier(path) {
visitedCounter += 1;
path.stop();
},
});
programShouldStop = path.shouldStop;
},
});
expect(visitedCounter).toBe(1);
expect(programShouldStop).toBe(false);
});
});
describe("traverse.explode", () => {
describe("deprecated types and aliases", () => {
beforeAll(() => {
jest.spyOn(console, "warn").mockImplementation(() => {});
});
afterEach(() => {
console.warn.mockClear();
});
afterAll(() => {
console.warn.mockRestore();
});
it("should warn for deprecated node types", function testFn1() {
const visitNumericLiteral = () => {};
const visitor = {
NumberLiteral: visitNumericLiteral,
};
traverse.explode(visitor);
expect(console.warn).toHaveBeenCalledWith(
expect.stringMatching(
/Visitor `NumberLiteral` has been deprecated, please migrate to `NumericLiteral`[^]+at.+testFn1/,
),
);
expect(visitor).toHaveProperty("NumericLiteral.enter", [
visitNumericLiteral,
]);
});
it("should warn for deprecated aliases", function testFn2() {
const visitImportOrExportDeclaration = () => {};
const visitor = {
ModuleDeclaration: visitImportOrExportDeclaration,
};
traverse.explode(visitor);
expect(console.warn).toHaveBeenCalledWith(
expect.stringMatching(
/Visitor `ModuleDeclaration` has been deprecated, please migrate to `ImportOrExportDeclaration`[^]+at.+testFn2/,
),
);
expect(visitor).toHaveProperty("ImportDeclaration.enter", [
visitImportOrExportDeclaration,
]);
});
it("should not warn deprecations if usage comes from a @babel/* package", () => {
const visitImportOrExportDeclaration = () => {};
const visitor = {
ModuleDeclaration: visitImportOrExportDeclaration,
};
callFromAtBabelPackage(traverse.explode, visitor);
expect(console.warn).not.toHaveBeenCalled();
expect(visitor).toHaveProperty("ImportDeclaration.enter", [
visitImportOrExportDeclaration,
]);
});
});
});
});