-
Notifications
You must be signed in to change notification settings - Fork 20
/
js-ast-util.ts
458 lines (404 loc) · 15.9 KB
/
js-ast-util.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
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
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
/**
* JavaScript 语法树的工具
*
* AST Spec: ESTree Spec: https://github.com/estree/estree
* Implementation: acorn
*
* 方便读取和操作 ESTree 结构,本文件里提供的功能和实现逻辑是和具体 SSR 逻辑无关的,只和 ESTree 有关。
*/
import { ancestor, simple } from 'acorn-walk'
import assert, { equal } from 'assert'
import { Node as AcornNode } from 'acorn'
import { MethodDefinition, ExportDefaultDeclaration, ImportDeclaration, Property, BinaryExpression, ClassExpression, ClassDeclaration, ThisExpression, ExpressionStatement, TemplateLiteral, Literal, Identifier, MemberExpression, ArrayExpression, CallExpression, ObjectExpression, Node, Program, Pattern, VariableDeclaration, ObjectPattern, Class, AssignmentExpression, Expression, ImportSpecifier, ImportDefaultSpecifier, VariableDeclarator } from 'estree'
const OPERATORS = {
'+': (l: any, r: any) => l + r
}
// 按照 node 的 type 来过滤数组
export function filterByType (node: Node, type: 'VariableDeclaration'): VariableDeclaration[]
export function filterByType (node: Node, type: 'ImportDeclaration'): ImportDeclaration[]
export function filterByType (node: Node, type: 'MemberExpression'): MemberExpression[]
export function filterByType (node: Node, type: string) {
const results: any[] = []
simple(node as AcornNode, {
[type]: (node) => results.push(node)
})
return results
}
// 获取 require 的模块名。
// 例如:对于 node = <require('san')>,getRequireSpecifier(node) === 'san'
export function getRequireSpecifier (node: Node): string {
const arg = node['arguments'][0]
assertLiteral(arg)
return arg.value as string
}
// 是否是 require 了 spec 的语句。
// 例如:对于 node = <require('san')>,isRequireSpecifier(node, 'san') === true
export function isRequireSpecifier (node: Expression, spec: string) {
return isRequire(node) && getRequireSpecifier(node) === spec
}
export function isModuleExports (node: Node) {
// exports = Foo
if (isIdentifier(node) && node['name'] === 'exports') return true
// module.exports = Foo
if (isMemberExpression(node) && node.object['name'] === 'module' && node.property['name'] === 'exports') return true
return false
}
// expr 是否形如:exports.xxx
export function isExportsMemberExpression (expr: Pattern) {
return isMemberExpression(expr) &&
getStringValue(expr['object'] as Expression) === 'exports'
}
/**
* 找到 node 下面所有的 require 语句
*
* 通过迭代器返回每一个 require 的 localName、moduleName、exportName。
* 例如:let foo = require('bar').coo,会 yield ["foo", "bar", "coo"]
*/
export function * findScriptRequires (node: Node): Generator<[string, string, string, VariableDeclaration]> {
for (const decl of filterByType(node, 'VariableDeclaration')) {
const { id, init } = decl.declarations[0]
if (!init) continue
if (isRequire(init)) {
const specifier = getRequireSpecifier(init)
if (isIdentifier(id)) yield [id.name, specifier, 'default', decl]
if (isObjectPattern(id)) {
for (const [key, value] of getPropertiesFromObject(id)) {
assertIdentifier(value)
yield [value.name, specifier, key, decl]
}
}
}
// const C = require('san').Component
if (isMemberExpression(init) && isRequire(init.object)) {
const specifier = getRequireSpecifier(init.object)
assertIdentifier(id)
yield [id.name, specifier, getStringValue(init.property), decl]
}
}
}
/**
* 找到 root 下所有的 import 语句
*
* 通过迭代器返回每一个 require 的 localName、moduleName、exportName。
* 例如:import { coo as foo } from 'bar',会 yield ["foo", "bar", "coo"]
*/
export function * findESMImports (root: Node): Generator<[string, string, string, ImportDeclaration]> {
for (const node of filterByType(root, 'ImportDeclaration')) {
const relativeFile = node.source.value as string
for (const spec of node['specifiers']) {
if (isImportDefaultSpecifier(spec)) {
yield [spec.local.name, relativeFile, 'default', node]
}
if (isImportSpecifier(spec)) {
yield [spec.local.name, relativeFile, spec.imported.name, node]
}
}
}
}
/**
* 找到每个 localName 对应的 exportName。
*/
export function findExportNames (root: Program) {
const names: [string, string][] = []
simple(root as any as AcornNode, {
ExportDefaultDeclaration (node) {
const decl = node['declaration']
// export default Foo
if (isIdentifier(decl)) names.push([decl.name, 'default'])
},
ExportNamedDeclaration (node) {
if (isVariableDeclaration(node['declaration'])) {
// export const foo = Foo, bar = Bar
for (const decl of node['declaration'].declarations) {
assertVariableDeclarator(decl)
assertIdentifier(decl.id)
assertIdentifier(decl.init!)
names.push([decl.init.name, decl.id.name])
}
}
},
AssignmentExpression: (node) => {
const { left, right } = node as any
// module.exports.foo = bar
if (isIdentifier(right) && isMemberExpression(left) && isModuleExports(left.object)) {
names.push([right.name, getStringValue(left.property)])
}
if (isModuleExports(left)) {
// module.exports = Foo
if (isIdentifier(right)) {
names.push([right.name, 'default'])
}
// module.exports = {foo: bar}
if (isObjectExpression(right)) {
for (const [exported, value] of getPropertiesFromObject(right)) {
assertIdentifier(value)
names.push([value.name, exported])
}
}
}
}
})
return names
}
/**
* 获得字符串数组节点的值
*/
export function getStringArrayValue (expr: Node) {
assertArrayExpression(expr)
return expr.elements.map(getLiteralValue)
}
/**
* 从 Class 节点,获得它的所有属性的 key(字符串)和 value(AST 节点)
*/
export function * getMembersFromClassDeclaration (expr: Class): Generator<[string, Node]> {
for (const decl of expr.body.body) {
if (decl['kind'] === 'constructor') {
const constructorDecl = decl
for (const expr of constructorDecl.value.body.body) {
if (isExpressionStatement(expr) &&
isAssignmentExpression(expr.expression) &&
isMemberAssignment(expr.expression.left)
) yield [getStringValue(expr.expression.left['property']), expr.expression.right]
}
}
yield [getStringValue(decl.key), decl.value]
}
}
export function getConstructor (expr: Class): undefined | MethodDefinition {
for (const method of expr.body.body) {
if (method.kind === 'constructor') return method
}
}
/**
* 给字面量的对象,添加一个字符串类型的属性
*/
export function addStringPropertyForObject (expr: ObjectExpression, key: string, value: string) {
expr.properties.push({
type: 'Property',
method: false,
shorthand: false,
computed: false,
key: { type: 'Identifier', name: key },
value: { type: 'Literal', value: value, raw: JSON.stringify(value) },
kind: 'init'
})
}
export function getPropertyFromObject (obj: ObjectExpression | ObjectPattern, propertyName: string): Node | undefined {
for (const [key, val] of getPropertiesFromObject(obj)) {
if (key === propertyName) return val
}
}
export function * getPropertiesFromObject (obj: ObjectExpression | ObjectPattern): Generator<[string, Node]> {
for (const prop of obj.properties) {
assertProperty(prop)
yield [getStringValue(prop.key), prop.value]
}
}
function isMemberAssignment (expr: Pattern): boolean {
return isMemberExpression(expr) && isThisExpression(expr.object)
}
export function isClass (node: Node): node is Class {
return isClassExpression(node) || isClassDeclaration(node)
}
export function getClassName (node: Node) {
if (isClass(node) && node.id) return node.id.name
return ''
}
export function getStringValue (node: Expression): any {
if (isIdentifier(node)) return node['name']
if (isLiteral(node)) return node['value']
throw new Error(`${location(node)} cannot evaluate string value`)
}
/**
* 获取一个字面量表达式节点的值
*/
export function getLiteralValue (node: Node): any {
if (isBinaryExpression(node)) {
const left = getLiteralValue(node.left)
const right = getLiteralValue(node.right)
const op = OPERATORS[node.operator]
assert(op, `operator "${node.operator}" not supported'`)
return op(left, right)
}
if (isLiteral(node)) return node.value
if (isTemplateLiteral(node)) {
equal(node.expressions.length, 0, 'template expressions are not supported')
return node.quasis.map(quasis => quasis.value.cooked).join('')
}
throw new Error(`${location(node)} expected literal`)
}
/**
* 获取整个程序里,对 objName 的属性的所有赋值
*/
export function getMemberAssignmentsTo (program: Program, objName: string) {
const results: [string, Node][] = []
simple(program as any as AcornNode, {
AssignmentExpression (node: AcornNode) {
const expr = node as any as AssignmentExpression
if (isMemberExpression(expr.left) && isIdentifier(expr.left.object) && expr.left.object.name === objName) {
results.push([getStringValue(expr.left.property), expr.right])
}
}
})
return results
}
export function location (node: Node) {
return `[${node['start']},${node['end']})`
}
/**
* 获取一个源码文件的默认导出,有两种形式:
* 1. module.exports = foo
* 2. export foo
*/
export function findDefaultExport (node: Program): undefined | Node {
let result
simple(node as any as AcornNode, {
ExportDefaultDeclaration (node) {
result = (node as any as ExportDefaultDeclaration).declaration
},
AssignmentExpression (node) {
const expr = node as any as AssignmentExpression
if (isModuleExports(expr.left)) result = expr.right
}
})
return result
}
export function isProgram (node: Node): node is Program {
return node.type === 'Program'
}
export function isRequire (node: Node): node is CallExpression {
return isCallExpression(node) && node.callee['name'] === 'require'
}
export function isMemberExpression (expr: Node): expr is MemberExpression {
return expr.type === 'MemberExpression'
}
export function isBinaryExpression (expr: Node): expr is BinaryExpression {
return expr.type === 'BinaryExpression'
}
export function isIdentifier (expr: Node): expr is Identifier {
return expr.type === 'Identifier'
}
export function isTemplateLiteral (expr: Node): expr is TemplateLiteral {
return expr.type === 'TemplateLiteral'
}
export function isLiteral (expr: Node): expr is Literal {
return expr.type === 'Literal'
}
export function isVariableDeclaration (expr: Node): expr is VariableDeclaration {
return expr.type === 'VariableDeclaration'
}
export function isVariableDeclarator (expr: Node): expr is VariableDeclarator {
return expr.type === 'VariableDeclarator'
}
export function isCallExpression (expr: Node): expr is CallExpression {
return expr.type === 'CallExpression'
}
export function isObjectPattern (expr: Node): expr is ObjectPattern {
return expr.type === 'ObjectPattern'
}
export function isObjectExpression (expr: Node): expr is ObjectExpression {
return expr.type === 'ObjectExpression'
}
export function isImportDefaultSpecifier (expr: Node): expr is ImportDefaultSpecifier {
return expr.type === 'ImportDefaultSpecifier'
}
export function isImportSpecifier (expr: Node): expr is ImportSpecifier {
return expr.type === 'ImportSpecifier'
}
export function isExpressionStatement (expr: Node): expr is ExpressionStatement {
return expr.type === 'ExpressionStatement'
}
export function isAssignmentExpression (expr: Node): expr is AssignmentExpression {
return expr.type === 'AssignmentExpression'
}
export function isThisExpression (expr: Node): expr is ThisExpression {
return expr.type === 'ThisExpression'
}
export function isClassDeclaration (expr: Node): expr is ClassDeclaration {
return expr.type === 'ClassDeclaration'
}
export function isClassExpression (expr: Node): expr is ClassExpression {
return expr.type === 'ClassExpression'
}
export function isProperty (expr: Node): expr is Property {
return expr.type === 'Property'
}
export function isExportDefaultDeclaration (node: Node): node is ExportDefaultDeclaration {
return node.type === 'ExportDefaultDeclaration'
}
export function isArrayExpression (expr: Node): expr is ArrayExpression {
return expr.type === 'ArrayExpression'
}
export function assertProperty (expr: Node): asserts expr is Property {
assert(isProperty(expr))
}
export function assertLiteral (expr: Node): asserts expr is Literal {
assert(isLiteral(expr))
}
export function assertIdentifier (expr: Node): asserts expr is Identifier {
assert(isIdentifier(expr))
}
export function assertArrayExpression (expr: Node): asserts expr is ArrayExpression {
assert(isArrayExpression(expr))
}
export function assertObjectExpression (expr: Node): asserts expr is ObjectExpression {
assert(isObjectExpression(expr))
}
export function assertVariableDeclarator (expr: Node): asserts expr is VariableDeclarator {
assert(isVariableDeclarator(expr))
}
export function deleteMembersFromClassDeclaration (expr: Class, name: string) {
for (const [, decl] of expr.body.body.entries()) {
if (decl['kind'] === 'constructor') {
const constructorDecl = decl
for (const [index, node] of constructorDecl.value.body.body.entries()) {
if (isExpressionStatement(node) &&
isAssignmentExpression(node.expression) &&
isMemberAssignment(node.expression.left) &&
getStringValue(node.expression.left['property']) === name
) {
constructorDecl.value.body.body.splice(index, 1)
}
}
continue
}
}
}
export function deletePropertiesFromObject (obj: ObjectExpression | ObjectPattern, name: string) {
for (const [index, prop] of obj.properties.entries()) {
assertProperty(prop)
if (getStringValue(prop.key) === name) {
obj.properties.splice(index, 1)
}
}
}
export function deleteMemberAssignmentsTo (program: Program, objName: string, name: string) {
ancestor(program as any as AcornNode, {
AssignmentExpression (node: AcornNode, ancestors: AcornNode[]) {
const expr = node as any as AssignmentExpression
if (
isMemberExpression(expr.left) &&
isIdentifier(expr.left.object) &&
expr.left.object.name === objName &&
isIdentifier(expr.left.property) &&
expr.left.property.name === name
) {
const res = findValidParent(ancestors as Node[])
if (res && res.parent) {
res.parent.body.splice(res.index, 1)
}
}
}
})
function findValidParent (ancestors: Node[]) {
for (let i = ancestors.length - 1; i > -1; i--) {
const node = ancestors[i]
if (isProgram(node)) {
return {
parent: node,
index: node.body.indexOf(ancestors[i + 1] as ExpressionStatement)
}
}
}
}
}