-
Notifications
You must be signed in to change notification settings - Fork 20
/
javascript-san-parser.ts
299 lines (268 loc) · 11.9 KB
/
javascript-san-parser.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
/**
* JavaScript 文件解析器
*
* 从 JavaScript 文件源码,得到它里面的 San 信息,产出 JSSanSourceFile。
* JSSanSourceFile 包含了若干个 JSComponentInfo 和一个 entryComponentInfo。
*/
import debugFactory from 'debug'
import { ancestor } from 'acorn-walk'
import { Node as AcornNode, parse } from 'acorn'
import { CallExpression, Program, Node, Class } from 'estree'
import { generate } from 'astring'
import { JSComponentInfo } from '../models/component-info'
import {
isVariableDeclarator,
isProperty,
isAssignmentExpression,
isExportDefaultDeclaration,
location,
isMemberExpression,
isObjectExpression,
isCallExpression,
isIdentifier,
isLiteral,
getMemberAssignmentsTo,
getPropertyFromObject,
getPropertiesFromObject,
getMembersFromClassDeclaration,
isClass,
getClassName,
getStringValue,
isExportsMemberExpression,
isRequireSpecifier,
findExportNames,
isModuleExports,
findESMImports,
findScriptRequires,
deleteMembersFromClassDeclaration,
deletePropertiesFromObject,
deleteMemberAssignmentsTo
} from '../ast/js-ast-util'
import { JSSanSourceFile } from '../models/san-source-file'
import { componentID, ComponentReference } from '../models/component-reference'
import { readFileSync } from 'fs'
import { parseSanSourceFileOptions } from '../compilers/renderer-options'
const debug = debugFactory('ts-component-parser')
const DEFAULT_LOADER_CMP = 'SanSSRDefaultLoaderComponent'
type LocalName = string
type ImportName = string
type ExportName = string
type ImportSpecifier = string
/**
* 把包含 San 组件定义的 JavaScript 源码,通过静态分析(AST),得到组件信息。
*/
export class JavaScriptSanParser {
root: Program
componentInfos: JSComponentInfo[] = []
entryComponentInfo?: JSComponentInfo
private sanComponentIdentifier?: string
private defineComponentIdentifier?: string
private defaultExport?: string
private imports: Map<LocalName, [ImportSpecifier, ImportName]> = new Map()
private exports: Map<LocalName, ExportName> = new Map()
private componentIDs: Map<Node | undefined, string> = new Map()
private defaultPlaceholderComponent?: JSComponentInfo
private id = 0
private sanReferenceInfo?: parseSanSourceFileOptions['sanReferenceInfo']
constructor (
private readonly filePath: string,
fileContent?: string,
sourceType: 'module' | 'script' = 'script',
options?: parseSanSourceFileOptions
) {
this.root = parse(
fileContent === undefined ? readFileSync(filePath, 'utf8') : fileContent,
{ ecmaVersion: 2020, sourceType }
) as any as Program
this.sanReferenceInfo = options?.sanReferenceInfo
}
parse (): JSSanSourceFile {
this.parseNames()
this.parseComponents()
this.wireChildComponents()
this.deleteChildComponentRequires()
return new JSSanSourceFile(this.filePath, this.stringify(this.root), this.componentInfos, this.entryComponentInfo)
}
parseComponents (): [JSComponentInfo[], JSComponentInfo | undefined] {
const parseComponentFromNode = (node: AcornNode, ancestors: AcornNode[]) => {
const parent = ancestors[ancestors.length - 2] as Node
if (!this.isComponent(node as Node)) return
const component = this.parseComponentFromNode(node as Node, parent)
if (component.className === this.defaultExport) {
this.entryComponentInfo = component
}
}
ancestor(this.root as any as AcornNode, {
CallExpression: parseComponentFromNode,
ClassExpression: parseComponentFromNode,
ClassDeclaration: parseComponentFromNode
})
return [this.componentInfos, this.entryComponentInfo]
}
wireChildComponents () {
for (const info of this.componentInfos) {
for (const [key, value] of info.getComponentsDelcarations()) {
info.childComponents.set(key, this.createChildComponentReference(value, info.id))
}
}
}
private deleteChildComponentRequires () {
const childComponentsSpecifier = new Set()
for (const component of this.componentInfos) {
for (const [, childComponent] of component.childComponents) {
childComponentsSpecifier.add(childComponent.specifier)
}
}
const a = [...findESMImports(this.root), ...findScriptRequires(this.root)]
for (const [, moduleName, , node] of a) {
if (!childComponentsSpecifier.has(moduleName)) {
continue
}
const index = this.root.body.indexOf(node)
if (index !== -1) {
this.root.body.splice(index, 1)
}
}
}
private createChildComponentReference (child: Node, selfId: string): ComponentReference {
if (isObjectExpression(child)) {
this.createComponent(child)
}
if (this.componentIDs.has(child)) {
return new ComponentReference('.', this.componentIDs.get(child)!)
}
// 'self' 指定组件为自身
// 用法见 https://baidu.github.io/san/tutorial/component/#components
if (isLiteral(child) && child.value === 'self') {
return new ComponentReference('.', selfId)
}
if (isIdentifier(child)) {
if (this.imports.has(child.name)) {
const [specifier, id] = this.imports.get(child.name)!
return new ComponentReference(specifier, id)
}
return new ComponentReference('.', child.name)
}
if (this.isCreateComponentLoaderCall(child)) {
const options = child.arguments[0]
const placeholder = isObjectExpression(options) && getPropertyFromObject(options, 'placeholder')
// placeholder 是一个组件声明或组件的引用
if (placeholder) return this.createChildComponentReference(placeholder, selfId)
// placeholder 未定义,生成一个默认的组件
const cmpt = this.getOrCreateDefaultLoaderComponent()
return new ComponentReference('.', cmpt.id)
}
throw new Error(`${location(child)} cannot parse components`)
}
private parseComponentFromNode (node: Node, parent: Node) {
// export default Component
if (isExportDefaultDeclaration(parent)) {
return (this.entryComponentInfo = this.createComponent(node, undefined, true))
}
// module.exports = Component
if (isAssignmentExpression(parent) && isModuleExports(parent.left)) {
return (this.entryComponentInfo = this.createComponent(node, undefined, true))
}
// exports.Foo = Component
if (isAssignmentExpression(parent) && isExportsMemberExpression(parent.left)) {
return this.createComponent(node, getStringValue(parent.left['property']))
}
// const Foo = Component
if (isVariableDeclarator(parent)) {
return this.createComponent(node, parent.id['name'])
}
// Foo = Component
if (isAssignmentExpression(parent) && isIdentifier(parent.left)) {
return this.createComponent(node, parent.left.name)
}
// { 'x-list': san.defineComponent() }
if (isProperty(parent) && this.isComponent(parent.value)) {
return this.createComponent(node)
}
return this.createComponent(node)
}
/**
* 解析文件中出现的名字:找到重要的类名、方法名以及它们的来源
*/
parseNames () {
for (const [local, specifier, imported] of this.parseImportedNames()) {
this.imports.set(local, [specifier, imported])
if (imported === 'Component' && specifier === 'san') {
this.sanComponentIdentifier = local
}
if (imported === 'defineComponent' && specifier === 'san') {
this.defineComponentIdentifier = local
}
}
for (const [local, exported] of findExportNames(this.root)) {
if (exported === 'default') this.defaultExport = local
this.exports.set(local, exported)
}
}
* parseImportedNames (): Generator<[string, string, string]> {
for (const [localName, moduleName, exportName] of findESMImports(this.root)) yield [localName, moduleName, exportName]
for (const [localName, moduleName, exportName] of findScriptRequires(this.root)) yield [localName, moduleName, exportName]
}
createComponent (node: Node, name: string = getClassName(node), isDefault = false) {
const properties = new Map(this.getPropertiesFromComponentDeclaration(node, name))
const id = componentID(isDefault, (name
? (this.exports.get(name) || name)
: ('SanSSRAnonymousComponent' + this.id++)
))
this.componentIDs.set(node, id)
const comp = new JSComponentInfo(id, name, properties, this.stringify(node), isObjectExpression(node))
this.componentInfos.push(comp)
// 删除掉子组件
this.deletePropertiesFromComponentDecalration(node, name, 'components')
return comp
}
private getOrCreateDefaultLoaderComponent (): JSComponentInfo {
if (!this.defaultPlaceholderComponent) {
this.defaultPlaceholderComponent = new JSComponentInfo(DEFAULT_LOADER_CMP, '', new Map(), 'function(){}')
this.componentInfos.push(this.defaultPlaceholderComponent)
}
return this.defaultPlaceholderComponent
}
private deletePropertiesFromComponentDecalration (node: Node, targetName: string, name: string) {
if (this.isComponentClass(node)) {
deleteMembersFromClassDeclaration(node, name)
} else if (isObjectExpression(node)) {
deletePropertiesFromObject(node, name)
} else {
deletePropertiesFromObject(node['arguments'][0], name)
}
deleteMemberAssignmentsTo(this.root, targetName, name)
}
private * getPropertiesFromComponentDeclaration (node: Node, name: string) {
if (this.isComponentClass(node)) yield * getMembersFromClassDeclaration(node as Class)
else if (isObjectExpression(node)) yield * getPropertiesFromObject(node)
else yield * getPropertiesFromObject(node['arguments'][0])
yield * getMemberAssignmentsTo(this.root, name)
}
private isComponent (node: Node) {
return this.isDefineComponentCall(node) || this.isComponentClass(node)
}
private isDefineComponentCall (node: Node): node is CallExpression {
return isCallExpression(node) && this.isImportedFromSan(node.callee, this.sanReferenceInfo?.methodName || 'defineComponent')
}
private isCreateComponentLoaderCall (node: Node): node is CallExpression {
return isCallExpression(node) && this.isImportedFromSan(node.callee, 'createComponentLoader')
}
private isComponentClass (node: Node): node is Class {
return isClass(node) && !!node.superClass && this.isImportedFromSan(node.superClass, 'Component')
}
private isImportedFromSan (expr: Node, sanExport: string): boolean {
if (isIdentifier(expr)) return this.isImportedFrom(expr.name, this.sanReferenceInfo?.moduleName || 'san', sanExport)
if (isMemberExpression(expr)) return this.isImportedFromSan(expr.object, 'default') && getStringValue(expr.property) === sanExport
if (isCallExpression(expr)) return isRequireSpecifier(expr, this.sanReferenceInfo?.moduleName || 'san') && sanExport === 'default'
return false
}
private isImportedFrom (localName: string, packageSpec: string, importedName: string) {
if (!this.imports.has(localName)) return false
const [spec, name] = this.imports.get(localName)!
return spec === packageSpec && name === importedName
}
private stringify (node: Node) {
return generate(node, { indent: ' ' })
}
}