Open History to see the last commit
1import { describe, expect, test } from 'vitest'
2import { removeDevtools } from './remove-devtools'
3β
4const removeEmptySpace = (str: string) => {
5 return str.replace(/\s/g, '').trim()
6}
7β
8describe('remove-devtools', () => {
9 test('it removes devtools if Imported directly', () => {
10 const output = removeEmptySpace(
11 removeDevtools(
12 `
13 import { ReactQueryDevtoolsPanel } from '@tanstack/react-query-devtools'
14import { TanStackRouterDevtoolsPanel } from '@tanstack/react-router-devtools'
15import {
16 Link,
17 Outlet,
18 RouterProvider,
19 createRootRoute,
20 createRoute,
21 createRouter,
22} from '@tanstack/react-router'
23import { TanStackDevtools } from '@tanstack/react-devtools'
25β
27export default function DevtoolsExample() {
28 return (
29 <>
30 <TanStackDevtools
31 eventBusConfig={{
32 connectToServerBus: true,
33 }}
34 plugins={[
35 {
36 name: 'TanStack Query',
37 render: <ReactQueryDevtoolsPanel />,
38 },
39 {
40 name: 'TanStack Router',
41 render: <TanStackRouterDevtoolsPanel router={router} />,
42 },
43 /* {
44 name: "The actual app",
45 render: <iframe style={{ width: '100%', height: '100%' }} src="http://localhost:3005" />,
46 } */
47 ]}
48 />
49 <RouterProvider router={router} />
50 </>
51 )
52}
53β
54 `,
55 'test.jsx',
56 )!.code,
57 )
58 expect(output).toBe(
59 removeEmptySpace(`
60 import {
61 Link,
62 Outlet,
63 RouterProvider,
64 createRootRoute,
65 createRoute,
66 createRouter,
67 } from '@tanstack/react-router'
68β
69 export default function DevtoolsExample() {
70 return (
71 <>
72 <RouterProvider router={router} />
73 </>
74 )
75 }
76 `),
77 )
78 })
79β
80 test("it removes devtools if Imported and renamed with 'as' ", () => {
81 const output = removeEmptySpace(
82 removeDevtools(
83 `
84 import { ReactQueryDevtoolsPanel } from '@tanstack/react-query-devtools'
85import { TanStackRouterDevtoolsPanel } from '@tanstack/react-router-devtools'
86import {
87 Link,
88 Outlet,
89 RouterProvider,
90 createRootRoute,
91 createRoute,
92 createRouter,
93} from '@tanstack/react-router'
94import { TanStackDevtools as Devtools } from '@tanstack/react-devtools'
95β
96β
97β
98export default function DevtoolsExample() {
99 return (
100 <>
101 <Devtools
102 eventBusConfig={{
103 connectToServerBus: true,
104 }}
105 plugins={[
106 {
107 name: 'TanStack Query',
108 render: <ReactQueryDevtoolsPanel />,
109 },
110 {
111 name: 'TanStack Router',
112 render: <TanStackRouterDevtoolsPanel router={router} />,
113 },
114 /* {
115 name: "The actual app",
116 render: <iframe style={{ width: '100%', height: '100%' }} src="http://localhost:3005" />,
117 } */
118 ]}
119 />
120 <RouterProvider router={router} />
121 </>
122 )
123}
124β
125 `,
126 'test.jsx',
127 )!.code,
128 )
129 expect(output).toBe(
130 removeEmptySpace(`
131 import {
132 Link,
133 Outlet,
134 RouterProvider,
135 createRootRoute,
136 createRoute,
137 createRouter,
138 } from '@tanstack/react-router'
139β
140 export default function DevtoolsExample() {
141 return (
142 <>
143 <RouterProvider router={router} />
144 </>
145 )
146 }
147 `),
148 )
149 })
150β
151 test('it removes devtools if Imported as * then used as a subcomponent ', () => {
152 const output = removeEmptySpace(
153 removeDevtools(
154 `
155 import { ReactQueryDevtoolsPanel } from '@tanstack/react-query-devtools'
156import { TanStackRouterDevtoolsPanel } from '@tanstack/react-router-devtools'
157import {
158 Link,
159 Outlet,
160 RouterProvider,
161 createRootRoute,
162 createRoute,
163 createRouter,
164} from '@tanstack/react-router'
165import * as Tools from '@tanstack/react-devtools'
166β
167β
168β
169export default function DevtoolsExample() {
170 return (
171 <>
172 <Tools.TanStackDevtools
173 eventBusConfig={{
174 connectToServerBus: true,
175 }}
176 plugins={[
177 {
178 name: 'TanStack Query',
179 render: <ReactQueryDevtoolsPanel />,
180 },
181 {
182 name: 'TanStack Router',
183 render: <TanStackRouterDevtoolsPanel router={router} />,
184 },
185 /* {
186 name: "The actual app",
187 render: <iframe style={{ width: '100%', height: '100%' }} src="http://localhost:3005" />,
188 } */
189 ]}
190 />
191 <RouterProvider router={router} />
192 </>
193 )
194}
195β
196 `,
197 'test.jsx',
198 )!.code,
199 )
200 expect(output).toBe(
201 removeEmptySpace(`
202 import {
203 Link,
204 Outlet,
205 RouterProvider,
206 createRootRoute,
207 createRoute,
208 createRouter,
209 } from '@tanstack/react-router'
210β
211 export default function DevtoolsExample() {
212 return (
213 <>
214 <RouterProvider router={router} />
215 </>
216 )
217 }
218 `),
219 )
220 })
221β
222 test('it removes devtools and all possible variations of the plugins', () => {
223 const output = removeEmptySpace(
224 removeDevtools(
225 `
226 import { ReactQueryDevtoolsPanel } from '@tanstack/react-query-devtools'
227import { TanStackRouterDevtoolsPanel } from '@tanstack/react-router-devtools'
228import {
229 Link,
230 Outlet,
231 RouterProvider,
232 createRootRoute,
233 createRoute,
234 createRouter,
235} from '@tanstack/react-router'
236import * as Tools from '@tanstack/react-devtools'
238β
240export default function DevtoolsExample() {
241 return (
242 <>
243 <Tools.TanStackDevtools
244 eventBusConfig={{
245 connectToServerBus: true,
246 }}
247 plugins={[
248 {
249 name: 'TanStack Query',
250 render: <ReactQueryDevtoolsPanel />,
251 },
252 {
253 name: 'TanStack Query',
254 render: () => <ReactQueryDevtoolsPanel />,
255 },
256 {
257 name: 'TanStack Router',
258 render: TanStackRouterDevtoolsPanel,
259 },
260 some()
261 ]}
262 />
263 <RouterProvider router={router} />
264 </>
265 )
266}`,
267 'test.jsx',
268 )!.code,
269 )
270β
271 expect(output).toBe(
272 removeEmptySpace(`
273import {
274 Link,
275 Outlet,
276 RouterProvider,
277 createRootRoute,
278 createRoute,
279 createRouter,
280} from '@tanstack/react-router'
281β
282export default function DevtoolsExample() {
283 return (
284 <>
285 <RouterProvider router={router} />
286 </>
287 )
288}
289 `),
290 )
291 })
292β
293 describe('removing plugin imports', () => {
294 test('it removes the plugin import from the import array if multiple import identifiers exist', () => {
295 const output = removeEmptySpace(
296 removeDevtools(
297 `
298 import { ReactQueryDevtoolsPanel, test } from '@tanstack/react-query-devtools'
300import * as Tools from '@tanstack/react-devtools'
302β
304export default function DevtoolsExample() {
305 return (
306 <>
307 <Tools.TanStackDevtools
308 eventBusConfig={{
309 connectToServerBus: true,
310 }}
311 plugins={[
312 {
313 name: 'TanStack Query',
314 render: <ReactQueryDevtoolsPanel />,
315 }
316 ]}
317 />
318 <RouterProvider router={router} />
319 </>
320 )
321}`,
322 'test.jsx',
323 )!.code,
324 )
325β
326 expect(output).toBe(
327 removeEmptySpace(`
328 import { test } from '@tanstack/react-query-devtools'
329β
330export default function DevtoolsExample() {
331 return (
332 <>
333 <RouterProvider router={router} />
334 </>
335 )
336}
337 `),
338 )
339 })
340β
341 test("it doesn't remove the whole import if imported with * as", () => {
342 const output = removeEmptySpace(
343 removeDevtools(
344 `
345 import * as Stuff from '@tanstack/react-query-devtools'
347import * as Tools from '@tanstack/react-devtools'
349β
351export default function DevtoolsExample() {
352 return (
353 <>
354 <Tools.TanStackDevtools
355 eventBusConfig={{
356 connectToServerBus: true,
357 }}
358 plugins={[
359 {
360 name: 'TanStack Query',
361 render: <Stuff.ReactQueryDevtoolsPanel />,
362 }
363 ]}
364 />
365 <RouterProvider router={router} />
366 </>
367 )
368}`,
369 'test.jsx',
370 )!.code,
371 )
372β
373 expect(output).toBe(
374 removeEmptySpace(`
375 import * as Stuff from '@tanstack/react-query-devtools'
376β
377export default function DevtoolsExample() {
378 return (
379 <>
380 <RouterProvider router={router} />
381 </>
382 )
383}
384 `),
385 )
386 })
387β
388 test('it removes the import completely if nothing is left', () => {
389 const output = removeEmptySpace(
390 removeDevtools(
391 `
392 import { ReactQueryDevtoolsPanel } from '@tanstack/react-query-devtools'
393import * as Tools from '@tanstack/react-devtools'
395export default function DevtoolsExample() {
396 return (
397 <>
398 <Tools.TanStackDevtools
399 eventBusConfig={{
400 connectToServerBus: true,
401 }}
402 plugins={[
403 {
404 name: 'TanStack Query',
405 render: <ReactQueryDevtoolsPanel />,
406 }
407 ]}
408 />
409 <RouterProvider router={router} />
410 </>
411 )
412}`,
413 'test.jsx',
414 )!.code,
415 )
416β
417 expect(output).toBe(
418 removeEmptySpace(`
419export default function DevtoolsExample() {
420 return (
421 <>
422 <RouterProvider router={router} />
423 </>
424 )
425}
426 `),
427 )
428 })
429β
430 test('it removes the import completely even if used as a function instead of jsx', () => {
431 const output = removeEmptySpace(
432 removeDevtools(
433 `
434 import { plugin } from '@tanstack/react-query-devtools'
435import * as Tools from '@tanstack/react-devtools'
437export default function DevtoolsExample() {
438 return (
439 <>
440 <Tools.TanStackDevtools
441 eventBusConfig={{
442 connectToServerBus: true,
443 }}
444 plugins={[
445 {
446 name: 'TanStack Query',
447 render: plugin()
448 }
449 ]}
450 />
451 <RouterProvider router={router} />
452 </>
453 )
454}`,
455 'test.jsx',
456 )!.code,
457 )
458β
459 expect(output).toBe(
460 removeEmptySpace(`
461export default function DevtoolsExample() {
462 return (
463 <>
464 <RouterProvider router={router} />
465 </>
466 )
467}
468 `),
469 )
470 })
471β
472 test('it removes the import completely even if used as a function inside of render', () => {
473 const output = removeEmptySpace(
474 removeDevtools(
475 `
476 import { ReactQueryDevtoolsPanel } from '@tanstack/react-query-devtools'
477import * as Tools from '@tanstack/react-devtools'
479export default function DevtoolsExample() {
480 return (
481 <>
482 <Tools.TanStackDevtools
483 eventBusConfig={{
484 connectToServerBus: true,
485 }}
486 plugins={[
487 {
488 name: 'TanStack Query',
489 render: () => <ReactQueryDevtoolsPanel />
490 }
491 ]}
492 />
493 <RouterProvider router={router} />
494 </>
495 )
496}`,
497 'test.jsx',
498 )!.code,
499 )
500β
501 expect(output).toBe(
502 removeEmptySpace(`
503export default function DevtoolsExample() {
504 return (
505 <>
506 <RouterProvider router={router} />
507 </>
508 )
509}
510 `),
511 )
512 })
513β
514 test('it removes the import completely even if used as a reference inside of render', () => {
515 const output = removeEmptySpace(
516 removeDevtools(
517 `
518 import { ReactQueryDevtoolsPanel } from '@tanstack/react-query-devtools'
519import * as Tools from '@tanstack/react-devtools'
521export default function DevtoolsExample() {
522 return (
523 <>
524 <Tools.TanStackDevtools
525 eventBusConfig={{
526 connectToServerBus: true,
527 }}
528 plugins={[
529 {
530 name: 'TanStack Query',
531 render: ReactQueryDevtoolsPanel
532 }
533 ]}
534 />
535 <RouterProvider router={router} />
536 </>
537 )
538}`,
539 'test.jsx',
540 )!.code,
541 )
542β
543 expect(output).toBe(
544 removeEmptySpace(`
545export default function DevtoolsExample() {
546 return (
547 <>
548 <RouterProvider router={router} />
549 </>
550 )
551}
552 `),
553 )
554 })
555 })
556β
557 describe('framework devtools package coverage', () => {
558 test.each([
559 ['@tanstack/preact-devtools'],
560 ['@tanstack/vue-devtools'],
561 ['@tanstack/svelte-devtools'],
562 ['@tanstack/angular-devtools'],
563 ])('strips imports + JSX from %s', (pkg) => {
564 const output = removeDevtools(
565 `
566import { TanStackDevtools } from '${pkg}'
567β
568export default function App() {
569 return <TanStackDevtools />
570}
571 `,
572 'test.jsx',
573 )
574β
575 expect(output).toBeDefined()
576 expect(output!.code).not.toContain(pkg)
577 expect(output!.code).not.toContain('TanStackDevtools')
578 })
579 })
580β
581 test('preserves valid syntax when removing parenthesized devtools return', () => {
582 const output = removeEmptySpace(
583 removeDevtools(
584 `
585import { TanStackDevtools } from '@tanstack/react-devtools'
586β
587export function DevtoolsProvider() {
588 return (
589 <TanStackDevtools />
590 )
591}
592`,
593 'test.tsx',
594 )!.code,
595 )
596β
597 expect(output).toBe(
598 removeEmptySpace(`
599export function DevtoolsProvider() {
600 return (
601 null
602 )
603}
604`),
605 )
606 })
607})