Skip to content

Commit 1e68341

Browse files
fix
1 parent 02fccde commit 1e68341

4 files changed

Lines changed: 83 additions & 13 deletions

File tree

‎packages/router-generator/src/template.ts‎

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,10 @@ export type TargetTemplate = {
4444
}
4545
}
4646

47+
function serializeRoutePath(routePath: string) {
48+
return JSON.stringify(routePath)
49+
}
50+
4751
export function getTargetTemplate(config: Config): TargetTemplate {
4852
const target = config.target
4953
switch (target) {
@@ -79,7 +83,7 @@ export function getTargetTemplate(config: Config): TargetTemplate {
7983
tsrImports: () =>
8084
"import { createFileRoute } from '@tanstack/react-router';",
8185
tsrExportStart: (routePath) =>
82-
`export const Route = createFileRoute('${routePath}')(`,
86+
`export const Route = createFileRoute(${serializeRoutePath(routePath)})(`,
8387
tsrExportEnd: () => ');',
8488
},
8589
},
@@ -95,7 +99,7 @@ export function getTargetTemplate(config: Config): TargetTemplate {
9599
tsrImports: () =>
96100
"import { createLazyFileRoute } from '@tanstack/react-router';",
97101
tsrExportStart: (routePath) =>
98-
`export const Route = createLazyFileRoute('${routePath}')(`,
102+
`export const Route = createLazyFileRoute(${serializeRoutePath(routePath)})(`,
99103
tsrExportEnd: () => ');',
100104
},
101105
},
@@ -132,7 +136,7 @@ export function getTargetTemplate(config: Config): TargetTemplate {
132136
tsrImports: () =>
133137
"import { createFileRoute } from '@tanstack/solid-router';",
134138
tsrExportStart: (routePath) =>
135-
`export const Route = createFileRoute('${routePath}')(`,
139+
`export const Route = createFileRoute(${serializeRoutePath(routePath)})(`,
136140
tsrExportEnd: () => ');',
137141
},
138142
},
@@ -149,7 +153,7 @@ export function getTargetTemplate(config: Config): TargetTemplate {
149153
"import { createLazyFileRoute } from '@tanstack/solid-router';",
150154

151155
tsrExportStart: (routePath) =>
152-
`export const Route = createLazyFileRoute('${routePath}')(`,
156+
`export const Route = createLazyFileRoute(${serializeRoutePath(routePath)})(`,
153157

154158
tsrExportEnd: () => ');',
155159
},
@@ -188,7 +192,7 @@ export function getTargetTemplate(config: Config): TargetTemplate {
188192
tsrImports: () =>
189193
"import { createFileRoute } from '@tanstack/vue-router';",
190194
tsrExportStart: (routePath) =>
191-
`export const Route = createFileRoute('${routePath}')(`,
195+
`export const Route = createFileRoute(${serializeRoutePath(routePath)})(`,
192196
tsrExportEnd: () => ');',
193197
},
194198
},
@@ -206,7 +210,7 @@ export function getTargetTemplate(config: Config): TargetTemplate {
206210
"import { createLazyFileRoute } from '@tanstack/vue-router';",
207211

208212
tsrExportStart: (routePath) =>
209-
`export const Route = createLazyFileRoute('${routePath}')(`,
213+
`export const Route = createLazyFileRoute(${serializeRoutePath(routePath)})(`,
210214

211215
tsrExportEnd: () => ');',
212216
},

‎packages/router-generator/src/transform/transform.ts‎

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ type SupportedRouteId = t.StringLiteral | t.TemplateLiteral
1010
type NamedImport = {
1111
imported: string
1212
local: string
13+
importKind?: 'type' | 'typeof' | 'value'
1314
}
1415

1516
type ParsedImportDeclaration = {
@@ -385,6 +386,7 @@ function parseTargetImports(
385386
? specifier.imported.name
386387
: specifier.imported.value,
387388
local: specifier.local.name,
389+
importKind: specifier.importKind ?? undefined,
388390
})),
389391
moduleName: statement.source.value,
390392
quote: rawSource[0] as '"' | "'",
@@ -588,7 +590,7 @@ function normalizeNamedImports({
588590
continue
589591
}
590592

591-
const key = `${specifier.imported}:${specifier.local}`
593+
const key = `${specifier.importKind ?? 'value'}:${specifier.imported}:${specifier.local}`
592594
if (seen.has(key)) {
593595
continue
594596
}
@@ -622,7 +624,9 @@ function hasNamedImport(
622624
) {
623625
return named.some(
624626
(specifier) =>
625-
specifier.imported === required && specifier.local === required,
627+
specifier.imported === required &&
628+
specifier.local === required &&
629+
specifier.importKind !== 'type',
626630
)
627631
}
628632

@@ -632,7 +636,8 @@ function sameNamedImports(left: Array<NamedImport>, right: Array<NamedImport>) {
632636
left.every(
633637
(specifier, index) =>
634638
specifier.imported === right[index]!.imported &&
635-
specifier.local === right[index]!.local,
639+
specifier.local === right[index]!.local &&
640+
specifier.importKind === right[index]!.importKind,
636641
)
637642
)
638643
}
@@ -662,10 +667,9 @@ function renderImportDeclaration(importDeclaration: {
662667
if (importDeclaration.named.length > 0) {
663668
parts.push(
664669
`{ ${importDeclaration.named
665-
.map((specifier) =>
666-
specifier.imported === specifier.local
667-
? specifier.imported
668-
: `${specifier.imported} as ${specifier.local}`,
670+
.map(
671+
(specifier) =>
672+
`${specifier.importKind === 'type' ? 'type ' : ''}${specifier.imported === specifier.local ? specifier.imported : `${specifier.imported} as ${specifier.local}`}`,
669673
)
670674
.join(', ')} }`,
671675
)
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
import { describe, expect, it } from 'vitest'
2+
import { getTargetTemplate } from '../src/template'
3+
4+
describe('template', () => {
5+
it('escapes quoted route paths in React route templates', () => {
6+
const template = getTargetTemplate({ target: 'react' } as never)
7+
8+
expect(template.route.imports.tsrExportStart(`/say-"hi"`)).toBe(
9+
`export const Route = createFileRoute(${JSON.stringify('/say-"hi"')})(`,
10+
)
11+
expect(template.lazyRoute.imports.tsrExportStart(`/say-"hi"`)).toBe(
12+
`export const Route = createLazyFileRoute(${JSON.stringify('/say-"hi"')})(`,
13+
)
14+
})
15+
16+
it('escapes quoted route paths in Solid route templates', () => {
17+
const template = getTargetTemplate({ target: 'solid' } as never)
18+
19+
expect(template.route.imports.tsrExportStart(`/say-"hi"`)).toBe(
20+
`export const Route = createFileRoute(${JSON.stringify('/say-"hi"')})(`,
21+
)
22+
expect(template.lazyRoute.imports.tsrExportStart(`/say-"hi"`)).toBe(
23+
`export const Route = createLazyFileRoute(${JSON.stringify('/say-"hi"')})(`,
24+
)
25+
})
26+
27+
it('escapes quoted route paths in Vue route templates', () => {
28+
const template = getTargetTemplate({ target: 'vue' } as never)
29+
30+
expect(template.route.imports.tsrExportStart(`/say-"hi"`)).toBe(
31+
`export const Route = createFileRoute(${JSON.stringify('/say-"hi"')})(`,
32+
)
33+
expect(template.lazyRoute.imports.tsrExportStart(`/say-"hi"`)).toBe(
34+
`export const Route = createLazyFileRoute(${JSON.stringify('/say-"hi"')})(`,
35+
)
36+
})
37+
})

‎packages/router-generator/tests/transform.test.ts‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -497,4 +497,29 @@ describe('transform', () => {
497497
)
498498
expect(result.output).not.toContain('createLazyFileRoute')
499499
})
500+
501+
it('preserves type import specifiers when normalizing route imports', async () => {
502+
const result = await transform({
503+
source: [
504+
"import { type LinkProps, createLazyFileRoute } from '@tanstack/react-router'",
505+
'',
506+
"export const Route = createLazyFileRoute('/old')({})",
507+
].join('\n'),
508+
ctx: {
509+
target: 'react',
510+
routeId: '/new',
511+
lazy: false,
512+
},
513+
node: makeNode(),
514+
})
515+
516+
expect(result.result).toBe('modified')
517+
if (result.result !== 'modified') {
518+
throw new Error(`expected modified result, got ${result.result}`)
519+
}
520+
expect(result.output).toContain(
521+
"import { type LinkProps, createFileRoute } from '@tanstack/react-router'",
522+
)
523+
expect(result.output).not.toContain('createLazyFileRoute')
524+
})
500525
})

0 commit comments

Comments
 (0)