Open History to see the last commit
1import { describe, expect, it } from 'vitest'
2import { transform } from '../src/transform/transform'
3import type { RouteNode } from '../src/types'
4β
5function makeNode(
6 fsRouteType: RouteNode['_fsRouteType'] = 'static',
7): RouteNode {
8 return {
9 filePath: '/test.tsx',
10 fullPath: '/test.tsx',
11 variableName: 'TestRoute',
12 _fsRouteType: fsRouteType,
13 }
14}
15β
16function transformToNewRoute(source: string, node = makeNode()) {
17 return transform({
18 source,
19 ctx: { target: 'react', routeId: '/new', lazy: false },
20 node,
21 })
22}
23β
24describe('transform', () => {
25 it('reads and rewrites the route constructor, id and options through parentheses', () => {
26 const node = makeNode()
27 const result = transformToNewRoute(
28 [
29 "import { createLazyFileRoute } from '@tanstack/react-router'",
30 "export const Route = (createLazyFileRoute)(('/old'))(({ component: Page, server: {} }))",
31 ].join('\n'),
32 node,
33 )
34β
35 expect(result).toEqual({
36 result: 'modified',
37 output: [
38 "import { createFileRoute } from '@tanstack/react-router'",
39 "export const Route = (createFileRoute)(('/new'))(({ component: Page, server: {} }))",
40 ].join('\n'),
41 })
42 expect(node.createFileRouteProps).toEqual(new Set(['component', 'server']))
43 })
44β
45 it('updates parenthesized route calls without changing their surrounding source', () => {
46 const result = transform({
47 source:
48 "import { createFileRoute } from '@tanstack/react-router'; export const Route = ((createFileRoute('/old'))({}));",
49 ctx: { target: 'react', routeId: '/new', lazy: false },
50 node: makeNode(),
51 })
52 expect(result.result).toBe('modified')
53 if (result.result === 'modified') {
54 expect(result.output).toContain("((createFileRoute('/new'))({}))")
55 }
56 })
57β
58 it('reads route call parts through parentheses and TypeScript wrappers', () => {
59 const node = makeNode()
60 const result = transform({
61 source:
62 "import { createFileRoute } from '@tanstack/react-router'\n" +
63 "export const Route = (createFileRoute as typeof createFileRoute)(('/old' as const))(({ component: Page, server: {} }) satisfies object)\n",
64 ctx: { target: 'react', routeId: '/new', lazy: false },
65 node,
66 })
67 expect(result).toEqual({
68 result: 'modified',
69 output:
70 "import { createFileRoute } from '@tanstack/react-router'\n" +
71 "export const Route = (createFileRoute as typeof createFileRoute)(('/new' as const))(({ component: Page, server: {} }) satisfies object)\n",
72 })
73 expect(node.createFileRouteProps).toEqual(new Set(['component', 'server']))
74 })
75β
76 it('does not treat root route exports as missing Route exports', async () => {
77 const result = await transform({
78 source: [
79 "import { createRootRoute } from '@tanstack/react-router'",
80 '',
81 'export const Route = createRootRoute()({})',
82 ].join('\n'),
83 ctx: {
84 target: 'react',
85 routeId: '/',
86 lazy: false,
87 },
88 node: makeNode('__root'),
89 })
90β
91 expect(result.result).toBe('not-modified')
92 })
93β
94 it('does not treat createRootRouteWithContext exports as missing Route exports', async () => {
95 const result = await transform({
96 source: [
97 "import { createRootRouteWithContext } from '@tanstack/react-router'",
98 '',
99 'interface RouterContext {}',
100 '',
101 'export const Route = createRootRouteWithContext<RouterContext>()({})',
102 ].join('\n'),
103 ctx: {
104 target: 'react',
105 routeId: '/',
106 lazy: false,
107 },
108 node: makeNode('__root'),
109 })
110β
111 expect(result.result).toBe('not-modified')
112 })
113β
114 it('does not treat createRootRoute exported via export { Route } as missing Route exports', async () => {
115 const result = await transform({
116 source: [
117 "import { createRootRoute } from '@tanstack/react-router'",
118 '',
119 'const Route = createRootRoute()({})',
120 '',
121 'export { Route }',
122 ].join('\n'),
123 ctx: {
124 target: 'react',
125 routeId: '/',
126 lazy: false,
127 },
128 node: makeNode('__root'),
129 })
130β
131 expect(result.result).toBe('not-modified')
132 })
133β
134 it('returns an error result for parse failures', async () => {
135 const result = await transform({
136 source: "export const Route = createFileRoute('/broken')(",
137 ctx: {
138 target: 'react',
139 routeId: '/broken',
140 lazy: false,
141 },
142 node: makeNode(),
143 })
144β
145 expect(result.result).toBe('error')
146 })
147β
148 it('rewrites an aliased exported Route binding', async () => {
149 const node = makeNode()
150 const result = await transform({
151 source: [
152 "import { createFileRoute } from '@tanstack/react-router'",
153 '',
154 "const MyRoute = createFileRoute('/old')({ component: Component })",
155 '',
156 'export { MyRoute as Route }',
157 '',
158 'function Component() {',
159 ' return null',
160 '}',
161 ].join('\n'),
162 ctx: {
163 target: 'react',
164 routeId: '/new',
165 lazy: false,
166 },
167 node,
168 })
169β
170 expect(result.result).toBe('modified')
171 if (result.result !== 'modified') {
172 throw new Error(`expected modified result, got ${result.result}`)
173 }
174 expect(result.output).toContain("createFileRoute('/new')")
175 expect(node.createFileRouteProps).toEqual(new Set(['component']))
176 })
177β
178 it('removes imports cleanly with CRLF line endings', async () => {
179 const result = await transform({
180 source: [
181 "import { createFileRoute } from '@tanstack/react-router'",
182 "import { createLazyFileRoute } from '@tanstack/react-router'",
183 '',
184 "export const Route = createFileRoute('/old')({})",
185 ].join('\r\n'),
186 ctx: {
187 target: 'react',
188 routeId: '/new',
189 lazy: false,
190 },
191 node: makeNode(),
192 })
193β
194 expect(result.result).toBe('modified')
195 if (result.result !== 'modified') {
196 throw new Error(`expected modified result, got ${result.result}`)
197 }
198 expect(result.output).toBe(
199 [
200 "import { createFileRoute } from '@tanstack/react-router'",
201 '',
202 "export const Route = createFileRoute('/new')({})",
203 ].join('\r\n'),
204 )
205 })
206β
207 it('preserves import formatting when only renaming the route constructor', async () => {
208 const result = await transform({
209 source: [
210 'import {',
211 ' Link,',
212 ' createFileRoute,',
213 `} from '@tanstack/react-router'`,
214 '',
215 "export const Route = createFileRoute('/old')({})",
216 ].join('\n'),
217 ctx: {
218 target: 'react',
219 routeId: '/new',
220 lazy: true,
221 },
222 node: makeNode('lazy'),
223 })
224β
225 expect(result.result).toBe('modified')
226 if (result.result !== 'modified') {
227 throw new Error(`expected modified result, got ${result.result}`)
228 }
229 expect(result.output).toBe(
230 [
231 'import {',
232 ' Link,',
233 ' createLazyFileRoute,',
234 `} from '@tanstack/react-router'`,
235 '',
236 "export const Route = createLazyFileRoute('/new')({})",
237 ].join('\n'),
238 )
239 })
240β
241 it('adds the missing constructor import with the file line ending', async () => {
242 const result = await transform({
243 source: [
244 "import { Link } from '@tanstack/react-router'",
245 '',
246 "export const Route = createFileRoute('/old')({})",
247 ].join('\r\n'),
248 ctx: {
249 target: 'react',
250 routeId: '/new',
251 lazy: false,
252 },
253 node: makeNode(),
254 })
255β
256 expect(result.result).toBe('modified')
257 if (result.result !== 'modified') {
258 throw new Error(`expected modified result, got ${result.result}`)
259 }
260 expect(result.output).toBe(
261 [
262 "import { Link, createFileRoute } from '@tanstack/react-router'",
263 '',
264 "export const Route = createFileRoute('/new')({})",
265 ].join('\r\n'),
266 )
267 })
268β
269 it('ignores non-exported route constructor calls in the same file', async () => {
270 const result = await transform({
271 source: [
272 "import { createFileRoute } from '@tanstack/react-router'",
273 '',
274 "const OtherRoute = createFileRoute('/other')({})",
275 "export const Route = createFileRoute('/old')({})",
276 ].join('\n'),
277 ctx: {
278 target: 'react',
279 routeId: '/new',
280 lazy: false,
281 },
282 node: makeNode(),
283 })
284β
285 expect(result.result).toBe('modified')
286 if (result.result !== 'modified') {
287 throw new Error(`expected modified result, got ${result.result}`)
288 }
289 expect(result.output).toContain(
290 "const OtherRoute = createFileRoute('/other')({})",
291 )
292 expect(result.output).toContain(
293 "export const Route = createFileRoute('/new')({})",
294 )
295 })
296β
297 it('returns an error for unsupported route id expressions', async () => {
298 const result = await transform({
299 source: [
300 "import { createFileRoute } from '@tanstack/react-router'",
301 '',
302 'const routeId = getRouteId()',
303 'export const Route = createFileRoute(routeId)({})',
304 ].join('\n'),
305 ctx: {
306 target: 'react',
307 routeId: '/new',
308 lazy: false,
309 },
310 node: makeNode(),
311 })
312β
313 expect(result.result).toBe('error')
314 if (result.result !== 'error') {
315 throw new Error(`expected error result, got ${result.result}`)
316 }
317 expect(String(result.error)).toContain(
318 'expected route id to be a string literal or plain template literal',
319 )
320 })
321β
322 it('returns a distinct error for malformed direct createFileRoute calls', async () => {
323 const result = await transform({
324 source: [
325 "import { createFileRoute } from '@tanstack/react-router'",
326 '',
327 'export const Route = createFileRoute({ component: Home })',
328 ].join('\n'),
329 ctx: {
330 target: 'react',
331 routeId: '/new',
332 lazy: false,
333 },
334 node: makeNode(),
335 })
336β
337 expect(result.result).toBe('error')
338 if (result.result !== 'error') {
339 throw new Error(`expected error result, got ${result.result}`)
340 }
341 expect(String(result.error)).toContain(
342 "expected Route export in /new to use createFileRoute('/path')({...}) or createLazyFileRoute('/path')({...})",
343 )
344 })
345β
346 it('returns a distinct error for malformed direct createLazyFileRoute calls', async () => {
347 const result = await transform({
348 source: [
349 "import { createLazyFileRoute } from '@tanstack/react-router'",
350 '',
351 'export const Route = createLazyFileRoute({ component: Home })',
352 ].join('\n'),
353 ctx: {
354 target: 'react',
355 routeId: '/new',
356 lazy: true,
357 },
358 node: makeNode('lazy'),
359 })
360β
361 expect(result.result).toBe('error')
362 if (result.result !== 'error') {
363 throw new Error(`expected error result, got ${result.result}`)
364 }
365 expect(String(result.error)).toContain(
366 "expected Route export in /new to use createFileRoute('/path')({...}) or createLazyFileRoute('/path')({...})",
367 )
368 })
369β
370 it('preserves double-quote route IDs', async () => {
371 const result = await transform({
372 source: [
373 "import { createFileRoute } from '@tanstack/react-router'",
374 '',
375 'export const Route = createFileRoute("/old")({})',
376 ].join('\n'),
377 ctx: {
378 target: 'react',
379 routeId: '/new',
380 lazy: false,
381 },
382 node: makeNode(),
383 })
384β
385 expect(result.result).toBe('modified')
386 if (result.result !== 'modified') {
387 throw new Error(`expected modified result, got ${result.result}`)
388 }
389 expect(result.output).toContain('createFileRoute("/new")')
390 })
391β
392 it('preserves template-literal route IDs', async () => {
393 const result = await transform({
394 source: [
395 "import { createFileRoute } from '@tanstack/react-router'",
396 '',
397 'export const Route = createFileRoute(`/old`)({})',
398 ].join('\n'),
399 ctx: {
400 target: 'react',
401 routeId: '/new',
402 lazy: false,
403 },
404 node: makeNode(),
405 })
406β
407 expect(result.result).toBe('modified')
408 if (result.result !== 'modified') {
409 throw new Error(`expected modified result, got ${result.result}`)
410 }
411 expect(result.output).toContain('createFileRoute(`/new`)')
412 })
413β
414 it('rewrites createLazyFileRoute to createFileRoute when lazy changes', async () => {
415 const result = await transform({
416 source: [
417 "import { createLazyFileRoute } from '@tanstack/react-router'",
418 '',
419 "export const Route = createLazyFileRoute('/test')({})",
420 ].join('\n'),
421 ctx: {
422 target: 'react',
423 routeId: '/test',
424 lazy: false,
425 },
426 node: makeNode(),
427 })
428β
429 expect(result.result).toBe('modified')
430 if (result.result !== 'modified') {
431 throw new Error(`expected modified result, got ${result.result}`)
432 }
433 expect(result.output).toContain("createFileRoute('/test')")
434 expect(result.output).not.toContain('createLazyFileRoute')
435 })
436β
437 it('handles export { Route } with a separate const declaration', async () => {
438 const result = await transform({
439 source: [
440 "import { createFileRoute } from '@tanstack/react-router'",
441 '',
442 "const Route = createFileRoute('/old')({})",
443 '',
444 'export { Route }',
445 ].join('\n'),
446 ctx: {
447 target: 'react',
448 routeId: '/new',
449 lazy: false,
450 },
451 node: makeNode(),
452 })
453β
454 expect(result.result).toBe('modified')
455 if (result.result !== 'modified') {
456 throw new Error(`expected modified result, got ${result.result}`)
457 }
458 expect(result.output).toContain("createFileRoute('/new')")
459 })
460β
461 it('rejects duplicate Route exports as a syntax error', async () => {
462 const result = await transform({
463 source: [
464 "import { createFileRoute } from '@tanstack/react-router'",
465 '',
466 "export const Route = createFileRoute('/a')({})",
467 '',
468 "const AltRoute = createFileRoute('/b')({})",
469 'export { AltRoute as Route }',
470 ].join('\n'),
471 ctx: {
472 target: 'react',
473 routeId: '/new',
474 lazy: false,
475 },
476 node: makeNode(),
477 })
478β
479 expect(result.result).toBe('error')
480 if (result.result !== 'error') {
481 throw new Error(`expected error result, got ${result.result}`)
482 }
483 expect(String(result.error)).toContain("Duplicate export of 'Route'")
484 })
485β
486 it('returns an error when a redeclared Route var holds two route calls', async () => {
487 const result = await transform({
488 source: [
489 "import { createFileRoute } from '@tanstack/react-router'",
490 '',
491 "var Route = createFileRoute('/a')({})",
492 "var Route = createFileRoute('/b')({})",
493 'export { Route }',
494 ].join('\n'),
495 ctx: {
496 target: 'react',
497 routeId: '/new',
498 lazy: false,
499 },
500 node: makeNode(),
501 })
502β
503 expect(result.result).toBe('error')
504 if (result.result !== 'error') {
505 throw new Error(`expected error result, got ${result.result}`)
506 }
507 expect(String(result.error)).toContain(
508 'expected exactly one createFileRoute/createLazyFileRoute call in /new',
509 )
510 })
511β
512 it('prepends a new import when no target-module import exists', async () => {
513 const result = await transform({
514 source: [
515 "import { useState } from 'react'",
516 '',
517 "export const Route = createFileRoute('/old')({})",
518 ].join('\n'),
519 ctx: {
520 target: 'react',
521 routeId: '/new',
522 lazy: false,
523 },
524 node: makeNode(),
525 })
526β
527 expect(result.result).toBe('modified')
528 if (result.result !== 'modified') {
529 throw new Error(`expected modified result, got ${result.result}`)
530 }
531 expect(result.output).toBe(
532 [
533 "import { createFileRoute } from '@tanstack/react-router'",
534 "import { useState } from 'react'",
535 '',
536 "export const Route = createFileRoute('/new')({})",
537 ].join('\n'),
538 )
539 })
540β
541 it('returns not-modified for a non-route-constructor call', async () => {
542 const result = await transform({
543 source: [
544 "import { createFileRoute } from '@tanstack/react-router'",
545 '',
546 'export const Route = someOtherFactory()({})',
547 ].join('\n'),
548 ctx: {
549 target: 'react',
550 routeId: '/test',
551 lazy: false,
552 },
553 node: makeNode(),
554 })
555β
556 expect(result.result).toBe('not-modified')
557 })
558β
559 it('preserves semicolons in normalized imports', async () => {
560 const result = await transform({
561 source: [
562 "import { createLazyFileRoute } from '@tanstack/react-router';",
563 '',
564 "export const Route = createLazyFileRoute('/old')({});",
565 ].join('\n'),
566 ctx: {
567 target: 'react',
568 routeId: '/new',
569 lazy: false,
570 },
571 node: makeNode(),
572 })
573β
574 expect(result.result).toBe('modified')
575 if (result.result !== 'modified') {
576 throw new Error(`expected modified result, got ${result.result}`)
577 }
578 expect(result.output).toContain(
579 "import { createFileRoute } from '@tanstack/react-router';",
580 )
581 expect(result.output).not.toContain('createLazyFileRoute')
582 })
583β
584 it('preserves type import specifiers when normalizing route imports', async () => {
585 const result = await transform({
586 source: [
587 "import { type LinkProps, createLazyFileRoute } from '@tanstack/react-router'",
588 '',
589 "export const Route = createLazyFileRoute('/old')({})",
590 ].join('\n'),
591 ctx: {
592 target: 'react',
593 routeId: '/new',
594 lazy: false,
595 },
596 node: makeNode(),
597 })
598β
599 expect(result.result).toBe('modified')
600 if (result.result !== 'modified') {
601 throw new Error(`expected modified result, got ${result.result}`)
602 }
603 expect(result.output).toContain(
604 "import { type LinkProps, createFileRoute } from '@tanstack/react-router'",
605 )
606 expect(result.output).not.toContain('createLazyFileRoute')
607 })
608β
609 // The recorded option keys drive prerendering and server-only route pruning.
610 it('records identifier and string-literal option keys, not computed or spread ones', () => {
611 const node = makeNode()
612 const result = transformToNewRoute(
613 [
614 "import { createFileRoute } from '@tanstack/react-router'",
615 "export const Route = createFileRoute('/new')({ 'component': Page, [key]: load, ...rest, server: {} })",
616 ].join('\n'),
617 node,
618 )
619β
620 expect(result).toEqual({ result: 'not-modified' })
621 expect(node.createFileRouteProps).toEqual(new Set(['component', 'server']))
622 })
623})
624β
625// The generator writes its output back over the user's route file, so every
626// byte outside the route id and the router import must survive unchanged.
627describe('transform preserves the rest of the route file', () => {
628 it('edits the right spans after a BOM and astral characters', () => {
629 const result = transformToNewRoute(
630 [
631 '\uFEFF// π',
632 "import { createLazyFileRoute } from '@tanstack/react-router'",
633 "import { createFileRoute } from '@tanstack/react-router'",
634 "export const Route = createFileRoute(/* π */ '/old')({})",
635 ].join('\n'),
636 )
637β
638 expect(result).toEqual({
639 result: 'modified',
640 output: [
641 '\uFEFF// π',
642 "import { createFileRoute } from '@tanstack/react-router'",
643 "export const Route = createFileRoute(/* π */ '/new')({})",
644 ].join('\n'),
645 })
646 })
647β
648 it.each([
649 {
650 name: 'a default import',
651 imports: "import Router from '@tanstack/react-router'",
652 expected:
653 "import Router, { createFileRoute } from '@tanstack/react-router'",
654 },
655 {
656 name: 'an aliased import of the constructor',
657 imports:
658 "import { createFileRoute as cfr } from '@tanstack/react-router'",
659 expected:
660 "import { createFileRoute as cfr, createFileRoute } from '@tanstack/react-router'",
661 },
662 {
663 // The constructor goes into the named import, never the namespace one.
664 name: 'a namespace import',
665 imports: [
666 "import * as Router from '@tanstack/react-router'",
667 "import { Link } from '@tanstack/react-router'",
668 ].join('\n'),
669 expected: [
670 "import * as Router from '@tanstack/react-router'",
671 "import { Link, createFileRoute } from '@tanstack/react-router'",
672 ].join('\n'),
673 },
674 ])('adds the missing constructor next to $name', ({ imports, expected }) => {
675 const route = "export const Route = createFileRoute('/old')({})"
676β
677 expect(transformToNewRoute(`${imports}\n${route}`)).toEqual({
678 result: 'modified',
679 output: `${expected}\n${route.replace('/old', '/new')}`,
680 })
681 })
682β
683 it('updates only the Route declarator of a multi-declarator export', () => {
684 const result = transformToNewRoute(
685 [
686 "import { createFileRoute } from '@tanstack/react-router'",
687 "export const Route = createFileRoute('/old')({}), path = '/old'",
688 ].join('\n'),
689 )
690β
691 expect(result).toEqual({
692 result: 'modified',
693 output: [
694 "import { createFileRoute } from '@tanstack/react-router'",
695 "export const Route = createFileRoute('/new')({}), path = '/old'",
696 ].join('\n'),
697 })
698 })
699})