Open History to see the last commit
1import { describe, expect, test } from 'vitest'
2import {
3 detectDevtoolsFile,
4 findDevtoolsComponentName,
5 transformAndInject,
6} from './inject-plugin'
7β
8const removeEmptySpace = (str: string) => {
9 return str.replace(/\s/g, '').trim()
10}
11β
12// Helper to test transformation without file I/O
13const testTransform = (
14 code: string,
15 packageName: string,
16 pluginName: string,
17 pluginImport: {
18 importName: string
19 type: 'jsx' | 'function'
20 },
21) => {
22 const devtoolsComponentName = findDevtoolsComponentName(code)
23 if (!devtoolsComponentName) {
24 return { transformed: false, code }
25 }
26β
27 const result = transformAndInject(
28 code,
29 { packageName, pluginName, pluginImport },
30 devtoolsComponentName,
31 )
32β
33 if (!result?.transformed) {
34 return { transformed: false, code }
35 }
36β
37 return { transformed: true, code: result.code }
38}
39β
40describe('inject-plugin', () => {
41 describe('detectDevtoolsFile', () => {
42 test('should detect named import from @tanstack/react-devtools', () => {
43 const code = `
44 import { TanStackDevtools } from '@tanstack/react-devtools'
45 `
46 expect(detectDevtoolsFile(code)).toBe(true)
47 })
48β
49 test('should detect named import from @tanstack/solid-devtools', () => {
50 const code = `
51 import { TanStackDevtools } from '@tanstack/solid-devtools'
52 `
53 expect(detectDevtoolsFile(code)).toBe(true)
54 })
55β
56 test('should detect namespace import', () => {
57 const code = `
58 import * as Devtools from '@tanstack/react-devtools'
59 `
60 expect(detectDevtoolsFile(code)).toBe(true)
61 })
62β
63 test('should detect renamed named import', () => {
64 const code = `
65 import { TanStackDevtools as DevtoolsPanel } from '@tanstack/react-devtools'
66 `
67 expect(detectDevtoolsFile(code)).toBe(true)
68 })
69β
70 test('should not detect non-devtools imports', () => {
71 const code = `
72 import React from 'react'
73 import { useState } from 'react'
74 `
75 expect(detectDevtoolsFile(code)).toBe(false)
76 })
77β
78 test('should not detect files without imports', () => {
79 const code = `
80 function App() {
81 return <div>Hello</div>
82 }
83 `
84 expect(detectDevtoolsFile(code)).toBe(false)
85 })
86β
87 test('should handle invalid code gracefully', () => {
88 const code = `
89 this is not valid javascript{{{
90 `
91 expect(detectDevtoolsFile(code)).toBe(false)
92 })
93 })
94β
95 describe('named import pattern', () => {
96 test('should add plugin to existing empty plugins array', () => {
97 const code = `
98 import { TanStackDevtools } from '@tanstack/react-devtools'
99β
100 function App() {
101 return <TanStackDevtools plugins={[]} />
102 }
103 `
104β
105 const result = testTransform(
106 code,
107 '@tanstack/react-query-devtools',
108 'TanStack Query',
109 {
110 importName: 'ReactQueryDevtoolsPanel',
111 type: 'jsx',
112 },
113 )
114β
115 expect(result.transformed).toBe(true)
116 expect(removeEmptySpace(result.code)).toBe(
117 removeEmptySpace(`
118 import { TanStackDevtools } from '@tanstack/react-devtools'
119 import { ReactQueryDevtoolsPanel } from "@tanstack/react-query-devtools";
120β
121 function App() {
122 return <TanStackDevtools plugins={[{
123 name: "TanStack Query",
124 render: <ReactQueryDevtoolsPanel />
125 }]} />
126 }
127 `),
128 )
129 })
130β
131 test('should add plugin to existing plugins array with other plugins', () => {
132 const code = `
133 import { TanStackDevtools } from '@tanstack/react-devtools'
134 import { OtherPlugin } from '@tanstack/other-plugin'
135β
136 function App() {
137 return <TanStackDevtools plugins={[
138 { name: 'other', render: <OtherPlugin /> }
139 ]} />
140 }
141 `
142β
143 const result = testTransform(
144 code,
145 '@tanstack/react-query-devtools',
146 'TanStack Query',
147 {
148 importName: 'ReactQueryDevtoolsPanel',
149 type: 'jsx',
150 },
151 )
152β
153 expect(result.transformed).toBe(true)
154 expect(removeEmptySpace(result.code)).toBe(
155 removeEmptySpace(`
156 import { TanStackDevtools } from '@tanstack/react-devtools'
157 import { OtherPlugin } from '@tanstack/other-plugin'
158 import { ReactQueryDevtoolsPanel } from "@tanstack/react-query-devtools";
159β
160 function App() {
161 return <TanStackDevtools plugins={[
162 { name: 'other', render: <OtherPlugin /> },
163 {
164 name: "TanStack Query",
165 render: <ReactQueryDevtoolsPanel />
166 }
167 ]} />
168 }
169 `),
170 )
171 })
172β
173 test('should create plugins prop if it does not exist', () => {
174 const code = `
175 import { TanStackDevtools } from '@tanstack/react-devtools'
176β
177 function App() {
178 return <TanStackDevtools />
179 }
180 `
181β
182 const result = testTransform(
183 code,
184 '@tanstack/react-query-devtools',
185 'TanStack Query',
186 {
187 importName: 'ReactQueryDevtoolsPanel',
188 type: 'jsx',
189 },
190 )
191β
192 expect(result.transformed).toBe(true)
193 expect(removeEmptySpace(result.code)).toBe(
194 removeEmptySpace(`
195 import { TanStackDevtools } from '@tanstack/react-devtools'
196 import { ReactQueryDevtoolsPanel } from "@tanstack/react-query-devtools";
197β
198 function App() {
199 return <TanStackDevtools plugins={[{
200 name: "TanStack Query",
201 render: <ReactQueryDevtoolsPanel />
202 }]} />
203 }
204 `),
205 )
206 })
207β
208 test('should create plugins prop with other existing props', () => {
209 const code = `
210 import { TanStackDevtools } from '@tanstack/react-devtools'
211β
212 function App() {
213 return <TanStackDevtools position="bottom-right" />
214 }
215 `
216β
217 const result = testTransform(
218 code,
219 '@tanstack/react-query-devtools',
220 'TanStack Query',
221 {
222 importName: 'ReactQueryDevtoolsPanel',
223 type: 'jsx',
224 },
225 )
226β
227 expect(result.transformed).toBe(true)
228 expect(removeEmptySpace(result.code)).toBe(
229 removeEmptySpace(`
230 import { TanStackDevtools } from '@tanstack/react-devtools'
231 import { ReactQueryDevtoolsPanel } from "@tanstack/react-query-devtools";
232β
233 function App() {
234 return <TanStackDevtools position="bottom-right" plugins={[{
235 name: "TanStack Query",
236 render: <ReactQueryDevtoolsPanel />
237 }]} />
238 }
239 `),
240 )
241 })
242β
243 test('should not add plugin if it already exists', () => {
244 const code = `
245 import { TanStackDevtools } from '@tanstack/react-devtools'
246 import { ReactQueryDevtoolsPanel } from '@tanstack/react-query-devtools'
247β
248 function App() {
249 return <TanStackDevtools plugins={[
250 { name: 'TanStack Query', render: <ReactQueryDevtoolsPanel /> }
251 ]} />
252 }
253 `
254β
255 const result = testTransform(
256 code,
257 '@tanstack/react-query-devtools',
258 'TanStack Query',
259 {
260 importName: 'ReactQueryDevtoolsPanel',
261 type: 'jsx',
262 },
263 )
264β
265 expect(result.transformed).toBe(false)
266 })
267 })
268β
269 describe('renamed named import pattern', () => {
270 test('should handle renamed named import', () => {
271 const code = `
272 import { TanStackDevtools as DevtoolsPanel } from '@tanstack/react-devtools'
273β
274 function App() {
275 return <DevtoolsPanel plugins={[]} />
276 }
277 `
278β
279 const result = testTransform(
280 code,
281 '@tanstack/react-query-devtools',
282 'TanStack Query',
283 {
284 importName: 'ReactQueryDevtoolsPanel',
285 type: 'jsx',
286 },
287 )
288β
289 expect(result.transformed).toBe(true)
290 expect(removeEmptySpace(result.code)).toBe(
291 removeEmptySpace(`
292 import { TanStackDevtools as DevtoolsPanel } from '@tanstack/react-devtools'
293 import { ReactQueryDevtoolsPanel } from "@tanstack/react-query-devtools";
294β
295 function App() {
296 return <DevtoolsPanel plugins={[{
297 name: "TanStack Query",
298 render: <ReactQueryDevtoolsPanel />
299 }]} />
300 }
301 `),
302 )
303 })
304β
305 test('should handle renamed import without plugins prop', () => {
306 const code = `
307 import { TanStackDevtools as MyDevtools } from '@tanstack/solid-devtools'
308β
309 function App() {
310 return <MyDevtools />
311 }
312 `
313β
314 const result = testTransform(
315 code,
316 '@tanstack/react-query-devtools',
317 'TanStack Query',
318 {
319 importName: 'ReactQueryDevtoolsPanel',
320 type: 'jsx',
321 },
322 )
323β
324 expect(result.transformed).toBe(true)
325 expect(removeEmptySpace(result.code)).toBe(
326 removeEmptySpace(`
327 import { TanStackDevtools as MyDevtools } from '@tanstack/solid-devtools'
328 import { ReactQueryDevtoolsPanel } from "@tanstack/react-query-devtools";
329β
330 function App() {
331 return <MyDevtools plugins={[{
332 name: "TanStack Query",
333 render: <ReactQueryDevtoolsPanel />
334 }]} />
335 }
336 `),
337 )
338 })
339 })
340β
341 describe('namespace import pattern', () => {
342 test('should handle namespace import', () => {
343 const code = `
344 import * as DevtoolsModule from '@tanstack/react-devtools'
345β
346 function App() {
347 return <DevtoolsModule.TanStackDevtools plugins={[]} />
348 }
349 `
350β
351 const result = testTransform(
352 code,
353 '@tanstack/react-query-devtools',
354 'TanStack Query',
355 {
356 importName: 'ReactQueryDevtoolsPanel',
357 type: 'jsx',
358 },
359 )
360β
361 expect(result.transformed).toBe(true)
362 expect(removeEmptySpace(result.code)).toBe(
363 removeEmptySpace(`
364 import * as DevtoolsModule from '@tanstack/react-devtools'
365 import { ReactQueryDevtoolsPanel } from "@tanstack/react-query-devtools";
366β
367 function App() {
368 return <DevtoolsModule.TanStackDevtools plugins={[{
369 name: "TanStack Query",
370 render: <ReactQueryDevtoolsPanel />
371 }]} />
372 }
373 `),
374 )
375 })
376β
377 test('should handle namespace import without plugins prop', () => {
378 const code = `
379 import * as TSD from '@tanstack/solid-devtools'
380β
381 function App() {
382 return <TSD.TanStackDevtools />
383 }
384 `
385β
386 const result = testTransform(
387 code,
388 '@tanstack/solid-router-devtools',
389 'TanStack Router',
390 {
391 importName: 'SolidRouterDevtoolsPanel',
392 type: 'jsx',
393 },
394 )
395β
396 expect(result.transformed).toBe(true)
397 expect(removeEmptySpace(result.code)).toBe(
398 removeEmptySpace(`
399 import * as TSD from '@tanstack/solid-devtools'
400 import { SolidRouterDevtoolsPanel } from "@tanstack/solid-router-devtools";
401β
402 function App() {
403 return <TSD.TanStackDevtools plugins={[{
404 name: "TanStack Router",
405 render: <SolidRouterDevtoolsPanel />
406 }]} />
407 }
408 `),
409 )
410 })
411 })
412β
413 describe('different plugin types', () => {
414 test('should handle router devtools', () => {
415 const code = `
416 import { TanStackDevtools } from '@tanstack/react-devtools'
417β
418 function App() {
419 return <TanStackDevtools plugins={[]} />
420 }
421 `
422β
423 const result = testTransform(
424 code,
425 '@tanstack/react-router-devtools',
426 'TanStack Router',
427 {
428 importName: 'ReactRouterDevtoolsPanel',
429 type: 'jsx',
430 },
431 )
432β
433 expect(result.transformed).toBe(true)
434 expect(removeEmptySpace(result.code)).toBe(
435 removeEmptySpace(`
436 import { TanStackDevtools } from '@tanstack/react-devtools'
437 import { ReactRouterDevtoolsPanel } from "@tanstack/react-router-devtools";
438β
439 function App() {
440 return <TanStackDevtools plugins={[{
441 name: "TanStack Router",
442 render: <ReactRouterDevtoolsPanel />
443 }]} />
444 }
445 `),
446 )
447 })
448β
449 test('should handle form devtools', () => {
450 const code = `
451 import { TanStackDevtools } from '@tanstack/solid-devtools'
452β
453 function App() {
454 return <TanStackDevtools />
455 }
456 `
457β
458 const result = testTransform(
459 code,
460 '@tanstack/react-form-devtools',
461 'TanStack Form',
462 {
463 importName: 'ReactFormDevtoolsPanel',
464 type: 'jsx',
465 },
466 )
467β
468 expect(result.transformed).toBe(true)
469 expect(removeEmptySpace(result.code)).toBe(
470 removeEmptySpace(`
471 import { TanStackDevtools } from '@tanstack/solid-devtools'
472 import { ReactFormDevtoolsPanel } from "@tanstack/react-form-devtools";
473β
474 function App() {
475 return <TanStackDevtools plugins={[{
476 name: "TanStack Form",
477 render: <ReactFormDevtoolsPanel />
478 }]} />
479 }
480 `),
481 )
482 })
483β
484 test('should handle query devtools', () => {
485 const code = `
486 import { TanStackDevtools } from '@tanstack/vue-devtools'
487β
488 function App() {
489 return <TanStackDevtools plugins={[]} />
490 }
491 `
492β
493 const result = testTransform(
494 code,
495 '@tanstack/react-query-devtools',
496 'TanStack Query',
497 {
498 importName: 'ReactQueryDevtoolsPanel',
499 type: 'jsx',
500 },
501 )
502β
503 expect(result.transformed).toBe(true)
504 expect(removeEmptySpace(result.code)).toBe(
505 removeEmptySpace(`
506 import { TanStackDevtools } from '@tanstack/vue-devtools'
507 import { ReactQueryDevtoolsPanel } from "@tanstack/react-query-devtools";
508β
509 function App() {
510 return <TanStackDevtools plugins={[{
511 name: "TanStack Query",
512 render: <ReactQueryDevtoolsPanel />
513 }]} />
514 }
515 `),
516 )
517 })
518 })
519β
520 describe('edge cases', () => {
521 test('should not transform files without TanStackDevtools component', () => {
522 const code = `
523 import { TanStackDevtools } from '@tanstack/react-devtools'
524β
525 function App() {
526 return <div>Hello World</div>
527 }
528 `
529β
530 const result = testTransform(
531 code,
532 '@tanstack/react-query-devtools',
533 'TanStack Query',
534 {
535 importName: 'ReactQueryDevtoolsPanel',
536 type: 'jsx',
537 },
538 )
539β
540 expect(result.transformed).toBe(false)
541 })
542β
543 test('should handle TanStackDevtools with children', () => {
544 const code = `
545 import { TanStackDevtools } from '@tanstack/react-devtools'
546β
547 function App() {
548 return (
549 <TanStackDevtools plugins={[]}>
550 <div>Custom content</div>
551 </TanStackDevtools>
552 )
553 }
554 `
555β
556 const result = testTransform(
557 code,
558 '@tanstack/react-query-devtools',
559 'TanStack Query',
560 {
561 importName: 'ReactQueryDevtoolsPanel',
562 type: 'jsx',
563 },
564 )
565β
566 expect(result.transformed).toBe(true)
567 expect(removeEmptySpace(result.code)).toBe(
568 removeEmptySpace(`
569 import { TanStackDevtools } from '@tanstack/react-devtools'
570 import { ReactQueryDevtoolsPanel } from "@tanstack/react-query-devtools";
571β
572 function App() {
573 return (
574 <TanStackDevtools plugins={[{
575 name: "TanStack Query",
576 render: <ReactQueryDevtoolsPanel />
577 }]}>
578 <div>Custom content</div>
579 </TanStackDevtools>
580 )
581 }
582 `),
583 )
584 })
585β
586 test('should handle multiple TanStackDevtools in same file', () => {
587 const code = `
588 import { TanStackDevtools } from '@tanstack/react-devtools'
589β
590 function App() {
591 return (
592 <>
593 <TanStackDevtools plugins={[]} />
594 <TanStackDevtools plugins={[]} />
595 </>
596 )
597 }
598 `
599β
600 const result = testTransform(
601 code,
602 '@tanstack/react-query-devtools',
603 'TanStack Query',
604 {
605 importName: 'ReactQueryDevtoolsPanel',
606 type: 'jsx',
607 },
608 )
609β
610 expect(result.transformed).toBe(true)
611 expect(removeEmptySpace(result.code)).toBe(
612 removeEmptySpace(`
613 import { TanStackDevtools } from '@tanstack/react-devtools'
614 import { ReactQueryDevtoolsPanel } from "@tanstack/react-query-devtools";
615β
616 function App() {
617 return (
618 <>
619 <TanStackDevtools plugins={[{
620 name: "TanStack Query",
621 render: <ReactQueryDevtoolsPanel />
622 }]} />
623 <TanStackDevtools plugins={[{
624 name: "TanStack Query",
625 render: <ReactQueryDevtoolsPanel />
626 }]} />
627 </>
628 )
629 }
630 `),
631 )
632 })
633β
634 test('should handle TanStackDevtools deeply nested', () => {
635 const code = `
636 import { TanStackDevtools } from '@tanstack/react-devtools'
637β
638 function App() {
639 return (
640 <div>
641 <header>
642 <nav>
643 <TanStackDevtools plugins={[]} />
644 </nav>
645 </header>
646 </div>
647 )
648 }
649 `
650β
651 const result = testTransform(
652 code,
653 '@tanstack/react-query-devtools',
654 'TanStack Query',
655 {
656 importName: 'ReactQueryDevtoolsPanel',
657 type: 'jsx',
658 },
659 )
660β
661 expect(result.transformed).toBe(true)
662 expect(removeEmptySpace(result.code)).toBe(
663 removeEmptySpace(`
664 import { TanStackDevtools } from '@tanstack/react-devtools'
665 import { ReactQueryDevtoolsPanel } from "@tanstack/react-query-devtools";
666β
667 function App() {
668 return (
669 <div>
670 <header>
671 <nav>
672 <TanStackDevtools plugins={[{
673 name: "TanStack Query",
674 render: <ReactQueryDevtoolsPanel />
675 }]} />
676 </nav>
677 </header>
678 </div>
679 )
680 }
681 `),
682 )
683 })
684β
685 test('should preserve existing code formatting and structure', () => {
686 const code = `
687 import { TanStackDevtools } from '@tanstack/react-devtools'
688 import { useState } from 'react'
689β
690 function App() {
691 const [count, setCount] = useState(0)
692β
693 return (
694 <div>
695 <button onClick={() => setCount(count + 1)}>
696 Count: {count}
697 </button>
698 <TanStackDevtools />
699 </div>
700 )
701 }
702 `
703β
704 const result = testTransform(
705 code,
706 '@tanstack/react-query-devtools',
707 'TanStack Query',
708 {
709 importName: 'ReactQueryDevtoolsPanel',
710 type: 'jsx',
711 },
712 )
713β
714 expect(result.transformed).toBe(true)
715 expect(removeEmptySpace(result.code)).toBe(
716 removeEmptySpace(`
717 import { TanStackDevtools } from '@tanstack/react-devtools'
718 import { useState } from 'react'
719 import { ReactQueryDevtoolsPanel } from "@tanstack/react-query-devtools";
720β
721 function App() {
722 const [count, setCount] = useState(0)
723 return (
724 <div>
725 <button onClick={() => setCount(count + 1)}>
726 Count: {count}
727 </button>
728 <TanStackDevtools plugins={[{
729 name: "TanStack Query",
730 render: <ReactQueryDevtoolsPanel />
731 }]} />
732 </div>
733 )
734 }
735 `),
736 )
737 })
738β
739 test('should handle TypeScript code', () => {
740 const code = `
741 import { TanStackDevtools } from '@tanstack/react-devtools'
742 import type { FC } from 'react'
743β
744 const App: FC = () => {
745 return <TanStackDevtools plugins={[]} />
746 }
747 `
748β
749 const result = testTransform(
750 code,
751 '@tanstack/react-query-devtools',
752 'TanStack Query',
753 {
754 importName: 'ReactQueryDevtoolsPanel',
755 type: 'jsx',
756 },
757 )
758β
759 expect(result.transformed).toBe(true)
760 expect(removeEmptySpace(result.code)).toBe(
761 removeEmptySpace(`
762 import { TanStackDevtools } from '@tanstack/react-devtools'
763 import type { FC } from 'react'
764 import { ReactQueryDevtoolsPanel } from "@tanstack/react-query-devtools";
765β
766 const App: FC = () => {
767 return <TanStackDevtools plugins={[{
768 name: "TanStack Query",
769 render: <ReactQueryDevtoolsPanel />
770 }]} />
771 }
772 `),
773 )
774 })
775β
776 test('should handle plugins array with trailing comma', () => {
777 const code = `
778 import { TanStackDevtools } from '@tanstack/react-devtools'
779β
780 function App() {
781 return <TanStackDevtools plugins={[
782 { name: 'other', render: <OtherPlugin /> },
783 ]} />
784 }
785 `
786β
787 const result = testTransform(
788 code,
789 '@tanstack/react-query-devtools',
790 'TanStack Query',
791 {
792 importName: 'ReactQueryDevtoolsPanel',
793 type: 'jsx',
794 },
795 )
796β
797 expect(result.transformed).toBe(true)
798 expect(removeEmptySpace(result.code)).toBe(
799 removeEmptySpace(`
800 import { TanStackDevtools } from '@tanstack/react-devtools'
801 import { ReactQueryDevtoolsPanel } from "@tanstack/react-query-devtools";
802β
803 function App() {
804 return <TanStackDevtools plugins={[
805 { name: 'other', render: <OtherPlugin /> },
806 {
807 name: "TanStack Query",
808 render: <ReactQueryDevtoolsPanel />
809 }
810 ]} />
811 }
812 `),
813 )
814 })
815β
816 test('should not transform if devtools import not found', () => {
817 const code = `
818 import { SomeOtherComponent } from 'some-package'
819β
820 function App() {
821 return <SomeOtherComponent />
822 }
823 `
824β
825 const result = testTransform(
826 code,
827 '@tanstack/react-query-devtools',
828 'TanStack Query',
829 {
830 importName: 'ReactQueryDevtoolsPanel',
831 type: 'jsx',
832 },
833 )
834β
835 expect(result.transformed).toBe(false)
836 })
837 })
838β
839 describe('function-based plugins', () => {
840 test('should add function plugin to empty plugins array', () => {
841 const code = `
842 import { TanStackDevtools } from '@tanstack/react-devtools'
843β
844 function App() {
845 return <TanStackDevtools plugins={[]} />
846 }
847 `
848β
849 const result = testTransform(
850 code,
851 '@tanstack/react-form-devtools',
852 'react-form',
853 {
854 importName: 'FormDevtoolsPlugin',
855 type: 'function',
856 },
857 )
858β
859 expect(result.transformed).toBe(true)
860 expect(removeEmptySpace(result.code)).toBe(
861 removeEmptySpace(`
862 import { TanStackDevtools } from '@tanstack/react-devtools'
863 import { FormDevtoolsPlugin } from "@tanstack/react-form-devtools";
864β
865 function App() {
866 return <TanStackDevtools plugins={[FormDevtoolsPlugin()]} />
867 }
868 `),
869 )
870 })
871β
872 test('should add function plugin alongside JSX plugins', () => {
873 const code = `
874 import { TanStackDevtools } from '@tanstack/react-devtools'
875 import { ReactQueryDevtoolsPanel } from '@tanstack/react-query-devtools'
876β
877 function App() {
878 return <TanStackDevtools plugins={[
879 { name: 'TanStack Query', render: <ReactQueryDevtoolsPanel /> }
880 ]} />
881 }
882 `
883β
884 const result = testTransform(
885 code,
886 '@tanstack/react-form-devtools',
887 'react-form',
888 {
889 importName: 'FormDevtoolsPlugin',
890 type: 'function',
891 },
892 )
893β
894 expect(result.transformed).toBe(true)
895 expect(removeEmptySpace(result.code)).toBe(
896 removeEmptySpace(`
897 import { TanStackDevtools } from '@tanstack/react-devtools'
898 import { ReactQueryDevtoolsPanel } from '@tanstack/react-query-devtools'
899 import { FormDevtoolsPlugin } from "@tanstack/react-form-devtools";
900β
901 function App() {
902 return <TanStackDevtools plugins={[
903 { name: 'TanStack Query', render: <ReactQueryDevtoolsPanel /> },
904 FormDevtoolsPlugin()
905 ]} />
906 }
907 `),
908 )
909 })
910β
911 test('should create plugins prop with function plugin when it does not exist', () => {
912 const code = `
913 import { TanStackDevtools } from '@tanstack/react-devtools'
914β
915 function App() {
916 return <TanStackDevtools />
917 }
918 `
919β
920 const result = testTransform(
921 code,
922 '@tanstack/react-form-devtools',
923 'react-form',
924 {
925 importName: 'FormDevtoolsPlugin',
926 type: 'function',
927 },
928 )
929β
930 expect(result.transformed).toBe(true)
931 expect(removeEmptySpace(result.code)).toBe(
932 removeEmptySpace(`
933 import { TanStackDevtools } from '@tanstack/react-devtools'
934 import { FormDevtoolsPlugin } from "@tanstack/react-form-devtools";
935β
936 function App() {
937 return <TanStackDevtools plugins={[FormDevtoolsPlugin()]} />
938 }
939 `),
940 )
941 })
942β
943 test('should not add function plugin if it already exists', () => {
944 const code = `
945 import { TanStackDevtools } from '@tanstack/react-devtools'
946 import { FormDevtoolsPlugin } from '@tanstack/react-form-devtools'
947β
948 function App() {
949 return <TanStackDevtools plugins={[FormDevtoolsPlugin()]} />
950 }
951 `
952β
953 const result = testTransform(
954 code,
955 '@tanstack/react-form-devtools',
956 'react-form',
957 {
958 importName: 'FormDevtoolsPlugin',
959 type: 'function',
960 },
961 )
962β
963 expect(result.transformed).toBe(false)
964 })
965β
966 test('should handle function plugin with renamed devtools import', () => {
967 const code = `
968 import { TanStackDevtools as DevtoolsPanel } from '@tanstack/react-devtools'
969β
970 function App() {
971 return <DevtoolsPanel plugins={[]} />
972 }
973 `
974β
975 const result = testTransform(
976 code,
977 '@tanstack/react-form-devtools',
978 'react-form',
979 {
980 importName: 'FormDevtoolsPlugin',
981 type: 'function',
982 },
983 )
984β
985 expect(result.transformed).toBe(true)
986 expect(removeEmptySpace(result.code)).toBe(
987 removeEmptySpace(`
988 import { TanStackDevtools as DevtoolsPanel } from '@tanstack/react-devtools'
989 import { FormDevtoolsPlugin } from "@tanstack/react-form-devtools";
990β
991 function App() {
992 return <DevtoolsPanel plugins={[FormDevtoolsPlugin()]} />
993 }
994 `),
995 )
996 })
997β
998 test('should handle function plugin with namespace import', () => {
999 const code = `
1000 import * as DevtoolsModule from '@tanstack/solid-devtools'
1001β
1002 function App() {
1003 return <DevtoolsModule.TanStackDevtools plugins={[]} />
1004 }
1005 `
1006β
1007 const result = testTransform(
1008 code,
1009 '@tanstack/solid-form-devtools',
1010 'solid-form',
1011 {
1012 importName: 'FormDevtoolsPlugin',
1013 type: 'function',
1014 },
1015 )
1016β
1017 expect(result.transformed).toBe(true)
1018 expect(removeEmptySpace(result.code)).toBe(
1019 removeEmptySpace(`
1020 import * as DevtoolsModule from '@tanstack/solid-devtools'
1021 import { FormDevtoolsPlugin } from "@tanstack/solid-form-devtools";
1022β
1023 function App() {
1024 return <DevtoolsModule.TanStackDevtools plugins={[FormDevtoolsPlugin()]} />
1025 }
1026 `),
1027 )
1028 })
1029β
1030 test('should add multiple function plugins correctly', () => {
1031 const code = `
1032 import { TanStackDevtools } from '@tanstack/react-devtools'
1033 import { FormDevtoolsPlugin } from '@tanstack/react-form-devtools'
1034β
1035 function App() {
1036 return <TanStackDevtools plugins={[FormDevtoolsPlugin()]} />
1037 }
1038 `
1039β
1040 const result = testTransform(
1041 code,
1042 '@tanstack/react-router-devtools',
1043 'react-router',
1044 {
1045 importName: 'RouterDevtoolsPlugin',
1046 type: 'function',
1047 },
1048 )
1049β
1050 expect(result.transformed).toBe(true)
1051 expect(removeEmptySpace(result.code)).toBe(
1052 removeEmptySpace(`
1053 import { TanStackDevtools } from '@tanstack/react-devtools'
1054 import { FormDevtoolsPlugin } from '@tanstack/react-form-devtools'
1055 import { RouterDevtoolsPlugin } from "@tanstack/react-router-devtools";
1056β
1057 function App() {
1058 return <TanStackDevtools plugins={[FormDevtoolsPlugin(), RouterDevtoolsPlugin()]} />
1059 }
1060 `),
1061 )
1062 })
1063β
1064 test('should not transform when pluginImport is not provided', () => {
1065 const code = `
1066 import { TanStackDevtools } from '@tanstack/react-devtools'
1067β
1068 function App() {
1069 return <TanStackDevtools plugins={[]} />
1070 }
1071 `
1072β
1073 // No pluginImport provided - should return false
1074 const result = testTransform(
1075 code,
1076 '@tanstack/react-query-devtools',
1077 'TanStack Query',
1078 {
1079 importName: '',
1080 type: 'jsx',
1081 },
1082 )
1083β
1084 expect(result.transformed).toBe(false)
1085 })
1086 })
1087β
1088 describe('safe code generation', () => {
1089 test('escapes quotes/backslashes in displayName when emitting JSX object', () => {
1090 const code = `
1091 import { TanStackDevtools } from '@tanstack/react-devtools'
1092β
1093 function App() {
1094 return <TanStackDevtools />
1095 }
1096 `
1097 const result = testTransform(
1098 code,
1099 '@example/plugin',
1100 'has "quotes" and \\backslash',
1101 { importName: 'ExamplePlugin', type: 'jsx' },
1102 )
1103β
1104 expect(result.transformed).toBe(true)
1105 // displayName must be serialized via JSON.stringify so embedded quotes
1106 // and backslashes don't break the generated source.
1107 expect(result.code).toContain(
1108 'name: "has \\"quotes\\" and \\\\backslash"',
1109 )
1110 // and the package name in the appended import is also a JSON literal
1111 expect(result.code).toContain(
1112 'import { ExamplePlugin } from "@example/plugin"',
1113 )
1114 })
1115β
1116 test('does not re-add an existing import when the plugin component is already imported', () => {
1117 const code = `
1118import { TanStackDevtools } from '@tanstack/react-devtools'
1119import { ExamplePlugin } from '@example/plugin'
1120β
1121function App() {
1122 return <TanStackDevtools />
1123}
1124 `
1125 const result = testTransform(code, '@example/plugin', 'Example', {
1126 importName: 'ExamplePlugin',
1127 type: 'jsx',
1128 })
1129β
1130 expect(result.transformed).toBe(true)
1131 // Exactly one import for ExamplePlugin from @example/plugin should remain.
1132 const importMatches = result.code.match(
1133 /import\s*\{\s*ExamplePlugin\s*\}\s*from\s*['"]@example\/plugin['"]/g,
1134 )
1135 expect(importMatches).not.toBeNull()
1136 expect(importMatches!.length).toBe(1)
1137 })
1138 })
1139})