-
-
Notifications
You must be signed in to change notification settings - Fork 188
/
index.ts
470 lines (430 loc) · 15.7 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
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
459
460
461
462
463
464
465
466
467
468
469
470
import { Node } from 'estree-walker';
import MagicString from 'magic-string';
import { convertHtmlxToJsx } from '../htmlxtojsx';
import { convertHtmlxToJsx as convertHtmlxToJsxNew } from '../htmlxtojsx_v2';
import { parseHtmlx } from '../utils/htmlxparser';
import { ComponentDocumentation } from './nodes/ComponentDocumentation';
import { ComponentEvents } from './nodes/ComponentEvents';
import { EventHandler } from './nodes/event-handler';
import { ExportedNames } from './nodes/ExportedNames';
import {
handleScopeAndResolveForSlot,
handleScopeAndResolveLetVarForSlot
} from './nodes/handleScopeAndResolveForSlot';
import { ImplicitStoreValues } from './nodes/ImplicitStoreValues';
import { Scripts } from './nodes/Scripts';
import { SlotHandler } from './nodes/slot';
import { Stores } from './nodes/Stores';
import TemplateScope from './nodes/TemplateScope';
import { processInstanceScriptContent } from './processInstanceScriptContent';
import { processModuleScriptTag } from './processModuleScriptTag';
import { ScopeStack } from './utils/Scope';
import { Generics } from './nodes/Generics';
import { addComponentExport } from './addComponentExport';
import { createRenderFunction } from './createRenderFunction';
import { TemplateNode } from 'svelte/types/compiler/interfaces';
type TemplateProcessResult = {
/**
* The HTML part of the Svelte AST.
*/
htmlAst: TemplateNode;
uses$$props: boolean;
uses$$restProps: boolean;
uses$$slots: boolean;
slots: Map<string, Map<string, string>>;
scriptTag: Node;
moduleScriptTag: Node;
/** To be added later as a comment on the default class export */
componentDocumentation: ComponentDocumentation;
events: ComponentEvents;
resolvedStores: string[];
usesAccessors: boolean;
};
function processSvelteTemplate(
str: MagicString,
options?: {
emitOnTemplateError?: boolean;
namespace?: string;
accessors?: boolean;
mode?: 'ts' | 'tsx' | 'dts';
typingsNamespace?: string;
}
): TemplateProcessResult {
const { htmlxAst, tags } = parseHtmlx(str.original, {
...options,
useNewTransformation: options?.mode === 'ts'
});
let uses$$props = false;
let uses$$restProps = false;
let uses$$slots = false;
let usesAccessors = !!options.accessors;
const componentDocumentation = new ComponentDocumentation();
//track if we are in a declaration scope
const isDeclaration = { value: false };
//track $store variables since we are only supposed to give top level scopes special treatment, and users can declare $blah variables at higher scopes
//which prevents us just changing all instances of Identity that start with $
const scopeStack = new ScopeStack();
const stores = new Stores(scopeStack, str, isDeclaration);
const scripts = new Scripts(htmlxAst);
const handleSvelteOptions = (node: Node) => {
for (let i = 0; i < node.attributes.length; i++) {
const optionName = node.attributes[i].name;
const optionValue = node.attributes[i].value;
switch (optionName) {
case 'accessors':
if (Array.isArray(optionValue)) {
if (optionValue[0].type === 'MustacheTag') {
usesAccessors = optionValue[0].expression.value;
}
} else {
usesAccessors = true;
}
break;
}
}
};
const handleIdentifier = (node: Node) => {
if (node.name === '$$props') {
uses$$props = true;
return;
}
if (node.name === '$$restProps') {
uses$$restProps = true;
return;
}
if (node.name === '$$slots') {
uses$$slots = true;
return;
}
};
const handleStyleTag = (node: Node) => {
str.remove(node.start, node.end);
};
const slotHandler = new SlotHandler(str.original);
let templateScope = new TemplateScope();
const handleEach = (node: Node) => {
templateScope = templateScope.child();
if (node.context) {
handleScopeAndResolveForSlotInner(node.context, node.expression, node);
}
};
const handleAwait = (node: Node) => {
templateScope = templateScope.child();
if (node.value) {
handleScopeAndResolveForSlotInner(node.value, node.expression, node.then);
}
if (node.error) {
handleScopeAndResolveForSlotInner(node.error, node.expression, node.catch);
}
};
const handleComponentLet = (component: Node) => {
templateScope = templateScope.child();
const lets = slotHandler.getSlotConsumerOfComponent(component);
for (const { letNode, slotName } of lets) {
handleScopeAndResolveLetVarForSlot({
letNode,
slotName,
slotHandler,
templateScope,
component
});
}
};
const handleScopeAndResolveForSlotInner = (
identifierDef: Node,
initExpression: Node,
owner: Node
) => {
handleScopeAndResolveForSlot({
identifierDef,
initExpression,
slotHandler,
templateScope,
owner
});
};
const eventHandler = new EventHandler();
const onHtmlxWalk = (node: Node, parent: Node, prop: string) => {
if (
prop == 'params' &&
(parent.type == 'FunctionDeclaration' || parent.type == 'ArrowFunctionExpression')
) {
isDeclaration.value = true;
}
if (prop == 'id' && parent.type == 'VariableDeclarator') {
isDeclaration.value = true;
}
switch (node.type) {
case 'Comment':
componentDocumentation.handleComment(node);
break;
case 'Options':
handleSvelteOptions(node);
break;
case 'Identifier':
handleIdentifier(node);
stores.handleIdentifier(node, parent, prop);
eventHandler.handleIdentifier(node, parent, prop);
break;
case 'Transition':
case 'Action':
case 'Animation':
stores.handleDirective(node, str);
break;
case 'Slot':
slotHandler.handleSlot(node, templateScope);
break;
case 'Style':
handleStyleTag(node);
break;
case 'Element':
scripts.checkIfElementIsScriptTag(node, parent);
break;
case 'RawMustacheTag':
scripts.checkIfContainsScriptTag(node);
break;
case 'BlockStatement':
scopeStack.push();
break;
case 'FunctionDeclaration':
scopeStack.push();
break;
case 'ArrowFunctionExpression':
scopeStack.push();
break;
case 'EventHandler':
eventHandler.handleEventHandler(node, parent);
break;
case 'VariableDeclarator':
isDeclaration.value = true;
break;
case 'EachBlock':
handleEach(node);
break;
case 'AwaitBlock':
handleAwait(node);
break;
case 'InlineComponent':
handleComponentLet(node);
break;
}
};
const onHtmlxLeave = (node: Node, parent: Node, prop: string, _index: number) => {
if (
prop == 'params' &&
(parent.type == 'FunctionDeclaration' || parent.type == 'ArrowFunctionExpression')
) {
isDeclaration.value = false;
}
if (prop == 'id' && parent.type == 'VariableDeclarator') {
isDeclaration.value = false;
}
const onTemplateScopeLeave = () => {
templateScope = templateScope.parent;
};
switch (node.type) {
case 'BlockStatement':
scopeStack.pop();
break;
case 'FunctionDeclaration':
scopeStack.pop();
break;
case 'ArrowFunctionExpression':
scopeStack.pop();
break;
case 'EachBlock':
onTemplateScopeLeave();
break;
case 'AwaitBlock':
onTemplateScopeLeave();
break;
case 'InlineComponent':
onTemplateScopeLeave();
break;
}
};
if (options.mode === 'ts') {
convertHtmlxToJsxNew(str, htmlxAst, onHtmlxWalk, onHtmlxLeave, {
preserveAttributeCase: options?.namespace == 'foreign',
typingsNamespace: options.typingsNamespace
});
} else {
convertHtmlxToJsx(str, htmlxAst, onHtmlxWalk, onHtmlxLeave, {
preserveAttributeCase: options?.namespace == 'foreign'
});
}
// resolve scripts
const { scriptTag, moduleScriptTag } = scripts.getTopLevelScriptTags();
scripts.blankOtherScriptTags(str);
//resolve stores
const resolvedStores = stores.resolveStores();
return {
htmlAst: htmlxAst,
moduleScriptTag,
scriptTag,
slots: slotHandler.getSlotDef(),
events: new ComponentEvents(
eventHandler,
tags.some((tag) => tag.attributes?.some((a) => a.name === 'strictEvents')),
str
),
uses$$props,
uses$$restProps,
uses$$slots,
componentDocumentation,
resolvedStores,
usesAccessors
};
}
export function svelte2tsx(
svelte: string,
options: {
filename?: string;
isTsFile?: boolean;
emitOnTemplateError?: boolean;
namespace?: string;
mode?: 'ts' | 'tsx' | 'dts';
accessors?: boolean;
typingsNamespace?: string;
} = {}
) {
// TODO temporary
options.mode = options.mode || 'ts';
const str = new MagicString(svelte);
// process the htmlx as a svelte template
let {
htmlAst,
moduleScriptTag,
scriptTag,
slots,
uses$$props,
uses$$slots,
uses$$restProps,
events,
componentDocumentation,
resolvedStores,
usesAccessors
} = processSvelteTemplate(str, options);
/* Rearrange the script tags so that module is first, and instance second followed finally by the template
* This is a bit convoluted due to some trouble I had with magic string. A simple str.move(start,end,0) for each script wasn't enough
* since if the module script was already at 0, it wouldn't move (which is fine) but would mean the order would be swapped when the script tag tried to move to 0
* In this case we instead have to move it to moduleScriptTag.end. We track the location for the script move in the MoveInstanceScriptTarget var
*/
let instanceScriptTarget = 0;
if (moduleScriptTag) {
if (moduleScriptTag.start != 0) {
//move our module tag to the top
str.move(moduleScriptTag.start, moduleScriptTag.end, 0);
} else {
//since our module script was already at position 0, we need to move our instance script tag to the end of it.
instanceScriptTarget = moduleScriptTag.end;
}
}
const renderFunctionStart = scriptTag
? str.original.lastIndexOf('>', scriptTag.content.start) + 1
: instanceScriptTarget;
const implicitStoreValues = new ImplicitStoreValues(resolvedStores, renderFunctionStart);
//move the instance script and process the content
let exportedNames = new ExportedNames(str, 0);
let generics = new Generics(str, 0);
let uses$$SlotsInterface = false;
if (scriptTag) {
//ensure it is between the module script and the rest of the template (the variables need to be declared before the jsx template)
if (scriptTag.start != instanceScriptTarget) {
str.move(scriptTag.start, scriptTag.end, instanceScriptTarget);
}
const res = processInstanceScriptContent(
str,
scriptTag,
events,
implicitStoreValues,
options.mode,
/**hasModuleScripts */ !!moduleScriptTag
);
uses$$props = uses$$props || res.uses$$props;
uses$$restProps = uses$$restProps || res.uses$$restProps;
uses$$slots = uses$$slots || res.uses$$slots;
({ exportedNames, events, generics, uses$$SlotsInterface } = res);
}
//wrap the script tag and template content in a function returning the slot and exports
createRenderFunction({
str,
scriptTag,
scriptDestination: instanceScriptTarget,
slots,
events,
exportedNames,
isTsFile: options?.isTsFile,
uses$$props,
uses$$restProps,
uses$$slots,
uses$$SlotsInterface,
generics,
mode: options.mode
});
// we need to process the module script after the instance script has moved otherwise we get warnings about moving edited items
if (moduleScriptTag) {
processModuleScriptTag(
str,
moduleScriptTag,
new ImplicitStoreValues(
implicitStoreValues.getAccessedStores(),
renderFunctionStart,
scriptTag || options.mode === 'ts' ? undefined : (input) => `</>;${input}<>`
),
options.mode === 'ts'
);
}
addComponentExport({
str,
canHaveAnyProp: !exportedNames.uses$$Props && (uses$$props || uses$$restProps),
strictEvents: events.hasStrictEvents(),
isTsFile: options?.isTsFile,
exportedNames,
usesAccessors,
fileName: options?.filename,
componentDocumentation,
mode: options.mode,
generics
});
if (options.mode === 'dts') {
// Prepend the import and for JS files a single definition.
// The other shims need to be provided by the user ambient-style,
// for example through filenames.push(require.resolve('svelte2tsx/svelte-shims.d.ts'))
str.prepend(
'import { SvelteComponentTyped } from "svelte"\n' +
(options?.isTsFile
? ''
: // Not part of svelte-shims.d.ts because it would throw type errors as this function assumes
// the presence of a SvelteComponentTyped import
`
declare function __sveltets_1_createSvelteComponentTyped<Props, Events, Slots>(
render: {props: Props, events: Events, slots: Slots }
): SvelteComponentConstructor<SvelteComponentTyped<Props, Events, Slots>,Svelte2TsxComponentConstructorParameters<Props>>;
`) +
'\n'
);
let code = str.toString();
// Remove all tsx occurences and the template part from the output
code = code
// prepended before each script block
.replace('<></>;', '')
.replace('<></>;', '')
// tsx in render function
.replace(/<>.*<\/>/s, '')
.replace('\n() => ();', '');
return {
code
};
} else {
str.prepend('///<reference types="svelte" />\n');
return {
code: str.toString(),
map: str.generateMap({ hires: true, source: options?.filename }),
exportedNames: exportedNames.getExportsMap(),
events: events.createAPI(),
// not part of the public API so people don't start using it
htmlAst
};
}
}