forked from babel/babel
/
index.ts
314 lines (272 loc) 路 8.36 KB
/
index.ts
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
import type { HubInterface } from "../hub";
import type TraversalContext from "../context";
import * as virtualTypes from "./lib/virtual-types";
import buildDebug from "debug";
import traverse from "../index";
import type { Visitor } from "../types";
import Scope from "../scope";
import { validate } from "@babel/types";
import * as t from "@babel/types";
import { path as pathCache } from "../cache";
import generator from "@babel/generator";
// NodePath is split across many files.
import * as NodePath_ancestry from "./ancestry";
import * as NodePath_inference from "./inference";
import * as NodePath_replacement from "./replacement";
import * as NodePath_evaluation from "./evaluation";
import * as NodePath_conversion from "./conversion";
import * as NodePath_introspection from "./introspection";
import * as NodePath_context from "./context";
import * as NodePath_removal from "./removal";
import * as NodePath_modification from "./modification";
import * as NodePath_family from "./family";
import * as NodePath_comments from "./comments";
import * as NodePath_virtual_types_validator from "./lib/virtual-types-validator";
import type { NodePathAssetions } from "./generated/asserts";
import type { NodePathValidators } from "./generated/validators";
const debug = buildDebug("babel");
export const REMOVED = 1 << 0;
export const SHOULD_STOP = 1 << 1;
export const SHOULD_SKIP = 1 << 2;
class NodePath<T extends t.Node = t.Node> {
constructor(hub: HubInterface, parent: t.ParentMaps[T["type"]]) {
this.parent = parent;
this.hub = hub;
this.data = null;
this.context = null;
this.scope = null;
}
declare parent: t.ParentMaps[T["type"]];
declare hub: HubInterface;
declare data: Record<string | symbol, unknown>;
// TraversalContext is configured by setContext
declare context: TraversalContext;
declare scope: Scope;
contexts: Array<TraversalContext> = [];
state: any = null;
opts: any = null;
// this.shouldSkip = false; this.shouldStop = false; this.removed = false;
_traverseFlags: number = 0;
skipKeys: any = null;
parentPath: t.ParentMaps[T["type"]] extends null
? null
: NodePath<t.ParentMaps[T["type"]]> | null = null;
container: t.Node | Array<t.Node> | null = null;
listKey: string | null = null;
key: string | number | null = null;
node: T = null;
type: string | null = null;
static get({
hub,
parentPath,
parent,
container,
listKey,
key,
}: {
hub?: HubInterface;
parentPath: NodePath | null;
parent: t.Node;
container: t.Node | t.Node[];
listKey?: string;
key: string | number;
}): NodePath {
if (!hub && parentPath) {
hub = parentPath.hub;
}
if (!parent) {
throw new Error("To get a node path the parent needs to exist");
}
const targetNode =
// @ts-expect-error key must present in container
container[key];
let paths = pathCache.get(parent);
if (!paths) {
paths = new Map();
pathCache.set(parent, paths);
}
let path = paths.get(targetNode);
if (!path) {
path = new NodePath(hub, parent);
if (targetNode) paths.set(targetNode, path);
}
path.setup(parentPath, container, listKey, key);
return path;
}
getScope(scope: Scope): Scope {
return this.isScope() ? new Scope(this) : scope;
}
setData(key: string | symbol, val: any): any {
if (this.data == null) {
this.data = Object.create(null);
}
return (this.data[key] = val);
}
getData(key: string | symbol, def?: any): any {
if (this.data == null) {
this.data = Object.create(null);
}
let val = this.data[key];
if (val === undefined && def !== undefined) val = this.data[key] = def;
return val;
}
hasNode(): this is NodePath<NonNullable<this["node"]>> {
return this.node != null;
}
buildCodeFrameError(
msg: string,
Error: new () => Error = SyntaxError,
): Error {
return this.hub.buildError(this.node, msg, Error);
}
traverse<T>(visitor: Visitor<T>, state: T): void;
traverse(visitor: Visitor): void;
traverse(visitor: any, state?: any) {
traverse(this.node, visitor, this.scope, state, this);
}
set(key: string, node: any) {
validate(this.node, key, node);
// @ts-expect-error key must present in this.node
this.node[key] = node;
}
getPathLocation(): string {
const parts = [];
let path: NodePath = this;
do {
let key = path.key;
if (path.inList) key = `${path.listKey}[${key}]`;
parts.unshift(key);
} while ((path = path.parentPath));
return parts.join(".");
}
debug(message: string) {
if (!debug.enabled) return;
debug(`${this.getPathLocation()} ${this.type}: ${message}`);
}
toString() {
return generator(this.node).code;
}
get inList() {
return !!this.listKey;
}
set inList(inList) {
if (!inList) {
this.listKey = null;
}
// ignore inList = true as it should depend on `listKey`
}
get parentKey(): string {
return (this.listKey || this.key) as string;
}
get shouldSkip() {
return !!(this._traverseFlags & SHOULD_SKIP);
}
set shouldSkip(v) {
if (v) {
this._traverseFlags |= SHOULD_SKIP;
} else {
this._traverseFlags &= ~SHOULD_SKIP;
}
}
get shouldStop() {
return !!(this._traverseFlags & SHOULD_STOP);
}
set shouldStop(v) {
if (v) {
this._traverseFlags |= SHOULD_STOP;
} else {
this._traverseFlags &= ~SHOULD_STOP;
}
}
get removed() {
return !!(this._traverseFlags & REMOVED);
}
set removed(v) {
if (v) {
this._traverseFlags |= REMOVED;
} else {
this._traverseFlags &= ~REMOVED;
}
}
}
Object.assign(
NodePath.prototype,
NodePath_ancestry,
NodePath_inference,
NodePath_replacement,
NodePath_evaluation,
NodePath_conversion,
NodePath_introspection,
NodePath_context,
NodePath_removal,
NodePath_modification,
NodePath_family,
NodePath_comments,
);
if (!process.env.BABEL_8_BREAKING) {
// The original _guessExecutionStatusRelativeToDifferentFunctions only worked for paths in
// different functions, but _guessExecutionStatusRelativeTo works as a replacement in those cases.
// @ts-expect-error
NodePath.prototype._guessExecutionStatusRelativeToDifferentFunctions =
NodePath_introspection._guessExecutionStatusRelativeTo;
}
// we can not use `import { TYPES } from "@babel/types"` here
// because the transformNamedBabelTypesImportToDestructuring plugin in babel.config.js
// does not offer live bindings for `TYPES`
// we can change to `import { TYPES }` when we are publishing ES modules only
for (const type of t.TYPES) {
const typeKey = `is${type}`;
// @ts-expect-error typeKey must present in t
const fn = t[typeKey];
// @ts-expect-error augmenting NodePath prototype
NodePath.prototype[typeKey] = function (opts: any) {
return fn(this.node, opts);
};
// @ts-expect-error augmenting NodePath prototype
NodePath.prototype[`assert${type}`] = function (opts: any) {
if (!fn(this.node, opts)) {
throw new TypeError(`Expected node path of type ${type}`);
}
};
}
// Register virtual types validators after base types validators
Object.assign(NodePath.prototype, NodePath_virtual_types_validator);
for (const type of Object.keys(virtualTypes) as (keyof typeof virtualTypes)[]) {
if (type[0] === "_") continue;
if (!t.TYPES.includes(type)) t.TYPES.push(type);
}
type NodePathMixins = typeof NodePath_ancestry &
typeof NodePath_inference &
typeof NodePath_replacement &
typeof NodePath_evaluation &
typeof NodePath_conversion &
typeof NodePath_introspection &
typeof NodePath_context &
typeof NodePath_removal &
typeof NodePath_modification &
typeof NodePath_family &
typeof NodePath_comments;
// @ts-expect-error TS throws because ensureBlock returns the body node path
// however, we don't use the return value and treat it as a transform and
// assertion utilities. For better type inference we annotate it as an
// assertion method
// eslint-disable-next-line @typescript-eslint/no-unused-vars
interface NodePath<T>
extends NodePathAssetions,
NodePathValidators,
NodePathMixins {
/**
* @see ./conversion.ts for implementation
*/
ensureBlock<
T extends
| t.Loop
| t.WithStatement
| t.Function
| t.LabeledStatement
| t.CatchClause,
>(
this: NodePath<T>,
): asserts this is NodePath<T & { body: t.BlockStatement }>;
}
export default NodePath;