-
Notifications
You must be signed in to change notification settings - Fork 230
Expand file tree
/
Copy pathmigrator.spec.ts
More file actions
5278 lines (4767 loc) · 207 KB
/
Copy pathmigrator.spec.ts
File metadata and controls
5278 lines (4767 loc) · 207 KB
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
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import fs from 'node:fs';
import os from 'node:os';
import path from 'node:path';
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
import { parse as parseYaml } from 'yaml';
import { PackageManager } from '../../types/index.js';
import { VITE_PLUS_OVERRIDE_PACKAGES, VITEST_VERSION } from '../../utils/constants.js';
import { createMigrationReport } from '../report.js';
// Mock VITE_PLUS_VERSION to a stable value for snapshot tests.
// When tests run via `vp test`, the env var is injected with the actual version,
// which would cause snapshot mismatches.
vi.mock('../../utils/constants.js', async (importOriginal) => {
const mod = await importOriginal<typeof import('../../utils/constants.js')>();
return { ...mod, VITE_PLUS_VERSION: 'latest' };
});
const {
rewritePackageJson,
rewriteStandaloneProject,
rewriteMonorepo,
rewriteMonorepoProject,
detectPendingCoreMigration,
detectVitePlusBootstrapPending,
ensureVitePlusBootstrap,
finalizeCoreMigrationForExistingVitePlus,
parseNvmrcVersion,
detectNodeVersionManagerFile,
migrateNodeVersionManagerFile,
detectFramework,
hasFrameworkShim,
addFrameworkShim,
injectCreateDefaultTemplate,
injectFmtDefaults,
injectLintTypeCheckDefaults,
rewriteEslintPackageJson,
detectIncompatibleEslintIntegration,
preflightGitHooksSetup,
detectLegacyGitHooksMigrationCandidate,
setPackageManager,
} = await import('../migrator.js');
describe('rewritePackageJson', () => {
it('should rewrite package.json scripts and extract staged config', async () => {
const pkg = {
scripts: {
test: 'vitest',
test_run: 'vitest run && vitest --ui',
lint: 'oxlint',
lint_config: 'oxlint --config .oxlint.json',
lint_type_aware: 'oxlint --type-aware',
fmt: 'oxfmt',
fmt_config: 'oxfmt --config .oxfmt.json',
pack: 'tsdown',
pack_watch: 'tsdown --watch',
preview: 'vite preview',
optimize: 'vite optimize',
build: 'pnpm install && vite build -r && vite run build --watch && tsdown && tsc || exit 1',
dev: 'vite',
dev_cjs: 'VITE_CJS_IGNORE_WARNING=true vite',
dev_cjs_cross_env: 'cross-env VITE_CJS_IGNORE_WARNING=true vite',
version: 'vite --version',
version_short: 'vite -v',
dev_help: 'vite --help && vite -h',
dev_port: 'vite --port 3000',
dev_host: 'vite --host 0.0.0.0',
dev_open: 'vite --open',
dev_verbose: 'vite --verbose',
dev_debug: 'vite --debug',
dev_trace: 'vite --trace',
dev_profile: 'vite --profile',
dev_stats: 'vite --stats',
dev_analyze: 'vite --analyze',
ready: 'oxlint --fix --type-aware && vitest run && tsdown && oxfmt --fix',
ready_env:
'NODE_ENV=test FOO=bar oxlint --fix --type-aware && NODE_ENV=test FOO=bar vitest run && NODE_ENV=test FOO=bar tsdown && NODE_ENV=test FOO=bar oxfmt --fix',
ready_new:
'vite install && vite fmt && vite lint --type-aware && vite test -r && vite build -r',
},
'lint-staged': {
'*.js': ['oxlint --fix --type-aware', 'oxfmt --fix'],
'*.ts': 'oxfmt --fix',
},
};
const extractedStagedConfig = rewritePackageJson(pkg, PackageManager.npm);
// lint-staged and vite-staged keys should be removed from pkg
expect(pkg).toMatchSnapshot();
// Extracted config should have rewritten commands
expect(extractedStagedConfig).toMatchSnapshot();
});
it('should rewrite devDependencies and dependencies on standalone project', async () => {
const pkg = {
devDependencies: {
oxlint: '1.0.0',
oxfmt: '1.0.0',
},
dependencies: {
foo: '1.0.0',
tsdown: '1.0.0',
},
};
rewritePackageJson(pkg, PackageManager.pnpm);
expect(pkg).toMatchSnapshot();
});
it('should rewrite devDependencies and dependencies on pnpm monorepo project', async () => {
const pkg = {
devDependencies: {
oxlint: '1.0.0',
oxfmt: '1.0.0',
},
dependencies: {
foo: '1.0.0',
tsdown: '1.0.0',
},
};
rewritePackageJson(pkg, PackageManager.pnpm, true);
expect(pkg).toMatchSnapshot();
});
it('should rewrite devDependencies and dependencies on npm monorepo project', async () => {
const pkg = {
devDependencies: {
oxlint: '1.0.0',
oxfmt: '1.0.0',
},
dependencies: {
foo: '1.0.0',
tsdown: '1.0.0',
},
};
rewritePackageJson(pkg, PackageManager.npm, true);
expect(pkg).toMatchSnapshot();
});
it('should rewrite devDependencies and dependencies on yarn monorepo project', async () => {
const pkg = {
devDependencies: {
oxlint: '1.0.0',
oxfmt: '1.0.0',
},
dependencies: {
foo: '1.0.0',
tsdown: '1.0.0',
},
};
rewritePackageJson(pkg, PackageManager.yarn, true);
expect(pkg).toMatchSnapshot();
});
it('preserves named catalog dependency specs in monorepo projects', async () => {
const pkg = {
devDependencies: {
vite: 'catalog:vite7',
vitest: 'catalog:',
},
dependencies: {
vitest: 'catalog:test',
},
};
rewritePackageJson(pkg, PackageManager.pnpm, true);
expect(pkg.devDependencies.vite).toBe('catalog:vite7');
expect(pkg.devDependencies.vitest).toBe('catalog:');
expect(pkg.dependencies.vitest).toBe('catalog:test');
expect((pkg.devDependencies as Record<string, string>)['vite-plus']).toBe('catalog:');
});
it('normalizes a pre-existing pinned vite-plus to `catalog:` in catalog-supporting monorepos', async () => {
const pkg = {
devDependencies: {
'vite-plus': '^0.1.20',
},
};
rewritePackageJson(pkg, PackageManager.pnpm, true);
expect(pkg.devDependencies['vite-plus']).toBe('catalog:');
});
it('leaves a pre-existing pinned vite-plus alone on npm monorepo projects', async () => {
const pkg = {
devDependencies: {
'vite-plus': '^0.1.20',
},
};
rewritePackageJson(pkg, PackageManager.npm, true);
expect(pkg.devDependencies['vite-plus']).toBe('^0.1.20');
});
it('normalizes a pre-existing pinned vite-plus on yarn/bun monorepo projects', async () => {
for (const pm of [PackageManager.yarn, PackageManager.bun]) {
const pkg = { devDependencies: { 'vite-plus': '^0.1.20' } };
rewritePackageJson(pkg, pm, true);
expect(pkg.devDependencies['vite-plus']).toBe('catalog:');
}
});
it('preserves protocol-prefixed vite-plus specs (catalog:named, workspace:, link:, github:) in catalog-supporting monorepos', async () => {
for (const existing of [
'catalog:next',
'workspace:*',
'link:../vite-plus',
'github:fork/vite-plus',
'npm:@scope/vite-plus@^1.0.0',
]) {
const pkg = { devDependencies: { 'vite-plus': existing } };
rewritePackageJson(pkg, PackageManager.pnpm, true);
expect(pkg.devDependencies['vite-plus']).toBe(existing);
}
});
it('adds a direct vitest for a vitest-adjacent dep even when vite-plus is already present', async () => {
// `vitest-browser-svelte` declares a NON-optional `vitest` peer. Even though
// `vite-plus` is already here (bundling vitest transitively), a strict pnpm /
// Yarn PnP layout won't expose that transitive vitest to the package root, so
// the peer can't resolve. The migrator must pin a direct `vitest` regardless of
// whether `vite-plus` is already present.
const pkg = {
devDependencies: {
'vite-plus': '^0.1.20',
'vitest-browser-svelte': '^1.0.0',
},
};
rewritePackageJson(pkg, PackageManager.pnpm, true);
expect(pkg.devDependencies['vite-plus']).toBe('catalog:');
expect((pkg.devDependencies as Record<string, string>).vitest).toBe('catalog:');
});
it('does not auto-add vitest on a genuine normalize pass (no browser mode, no vitest-adjacent dep)', async () => {
// vite-plus present, nothing vitest-adjacent, no browser mode -> nothing to
// pin. needDirectVitest stays false and the package is left untouched beyond
// the vite-plus spec normalization.
const pkg = {
devDependencies: {
'vite-plus': '^0.1.20',
'@scope/some-plugin': '^1.0.0',
},
};
rewritePackageJson(pkg, PackageManager.pnpm, true);
expect(pkg.devDependencies['vite-plus']).toBe('catalog:');
expect((pkg.devDependencies as Record<string, string>).vitest).toBeUndefined();
});
it('uses default catalog specs for non-catalog dependency specs in monorepo projects', async () => {
const pkg = {
devDependencies: {
vite: '^7.0.0',
},
dependencies: {
vitest: '^4.0.0',
},
};
rewritePackageJson(pkg, PackageManager.yarn, true);
expect(pkg.devDependencies.vite).toBe('catalog:');
// vitest is a managed override key — non-catalog specs are rewritten to
// `catalog:` so the override is resolved through the catalog.
expect(pkg.dependencies.vitest).toBe('catalog:');
expect((pkg.devDependencies as Record<string, string>)['vite-plus']).toBe('catalog:');
});
it('uses override specs for yarn optional dependencies in monorepo projects', async () => {
const pkg = {
devDependencies: {
vite: '^7.0.0',
},
optionalDependencies: {
vite: '^7.0.0',
vitest: 'catalog:test',
},
};
rewritePackageJson(pkg, PackageManager.yarn, true);
expect(pkg.devDependencies.vite).toBe('catalog:');
expect(pkg.optionalDependencies.vite).toBe('npm:@voidzero-dev/vite-plus-core@latest');
// vitest is now a managed override key — yarn optional deps receive the
// literal override version so the resolution doesn't depend on catalog
// lookup at the optionalDependency site.
expect(pkg.optionalDependencies.vitest).toBe('4.1.9');
expect((pkg.devDependencies as Record<string, string>)['vite-plus']).toBe('catalog:');
});
it('rewrites peer and optional dependency catalog specs in monorepo projects', async () => {
const pkg = {
peerDependencies: {
vite: 'catalog:vite7',
tsdown: 'catalog:build',
},
optionalDependencies: {
vitest: 'catalog:test',
oxlint: 'catalog:build',
},
};
rewritePackageJson(pkg, PackageManager.pnpm, true);
expect(pkg.peerDependencies.vite).toBe('*');
expect(pkg.peerDependencies).not.toHaveProperty('tsdown');
expect(pkg.optionalDependencies.vitest).toBe('catalog:test');
expect(pkg.optionalDependencies).not.toHaveProperty('oxlint');
expect(
(pkg as { devDependencies?: Record<string, string> }).devDependencies?.['vite-plus'],
).toBe('catalog:');
});
it('preserves peer dependency ranges', async () => {
const pkg = {
peerDependencies: {
vite: '^7.0.0',
vitest: '^4.0.0',
},
optionalDependencies: {
vite: '^7.0.0',
},
};
rewritePackageJson(pkg, PackageManager.pnpm, true);
expect(pkg.peerDependencies.vite).toBe('^7.0.0');
expect(pkg.peerDependencies.vitest).toBe('^4.0.0');
expect(pkg.optionalDependencies.vite).toBe('catalog:');
expect(
(pkg as { devDependencies?: Record<string, string> }).devDependencies?.['vite-plus'],
).toBe('catalog:');
const npmPkg = {
peerDependencies: {
vite: '^7.0.0',
},
optionalDependencies: {
vite: '^7.0.0',
},
};
rewritePackageJson(npmPkg, PackageManager.npm);
expect(npmPkg.peerDependencies.vite).toBe('^7.0.0');
expect(npmPkg.optionalDependencies.vite).toBe('npm:@voidzero-dev/vite-plus-core@latest');
});
it('adds local vitest when only a peer vitest exists for vitest-adjacent packages', async () => {
const pkg = {
dependencies: {
'vitest-browser-svelte': '^1.0.0',
},
peerDependencies: {
vitest: '^4.0.0',
},
};
rewritePackageJson(pkg, PackageManager.pnpm, true);
expect(pkg.peerDependencies.vitest).toBe('^4.0.0');
expect((pkg as { devDependencies?: Record<string, string> }).devDependencies?.vitest).toBe(
'catalog:',
);
expect(
(pkg as { devDependencies?: Record<string, string> }).devDependencies?.['vite-plus'],
).toBe('catalog:');
});
it('keeps and normalizes @vitest/browser-playwright and ensures the playwright peer', async () => {
// Playwright is opt-in: vite-plus no longer bundles the provider at runtime
// (its `playwright` peer is non-optional), so the migration KEEPS the user's
// declared `@vitest/browser-playwright` (version-normalized to the bundled
// vitest version) and ensures its runtime framework peer `playwright`.
// `@vitest/browser` stays in REMOVE_PACKAGES and is still stripped.
const pkg = {
devDependencies: {
'@vitest/browser': '^4.0.0',
'@vitest/browser-playwright': '^4.0.0',
vitest: '^4.0.0',
},
};
rewritePackageJson(pkg, PackageManager.pnpm);
// Standalone (supportCatalog=false) → concrete pinned spec.
expect(pkg.devDependencies).toHaveProperty('@vitest/browser-playwright', VITEST_VERSION);
expect(pkg.devDependencies).toHaveProperty('playwright', '*');
expect(pkg.devDependencies).not.toHaveProperty('@vitest/browser');
});
it('injects a direct vite devDependency for an npm project that uses an opt-in browser provider', async () => {
// npm's flat node_modules cannot dedupe the provider's own
// `@vitest/browser → @vitest/mocker` subtree against the one vite-plus
// bundles, leaving several nested `@vitest/mocker` copies. The `vite`
// override only lands inside the `vitest` subtree, so the nested mockers
// can't resolve their (optional) `vite` peer and `@vitest/mocker/dist/node.js`
// throws `ERR_MODULE_NOT_FOUND: Cannot find package 'vite'` at config load.
// A direct `vite` devDep (= the override target) forces npm to hoist a
// single top-level `node_modules/vite` every nested mocker resolves.
const pkg = {
devDependencies: {
'@vitest/browser-playwright': '^4.0.0',
playwright: '^1.60.0',
vitest: '^4.0.0',
},
};
rewritePackageJson(pkg, PackageManager.npm);
expect(pkg.devDependencies).toHaveProperty('vite', VITE_PLUS_OVERRIDE_PACKAGES.vite);
});
it('does not inject a direct vite devDependency for npm projects without a browser provider', async () => {
// Node-mode projects dedupe cleanly (a single hoisted `@vitest/mocker`
// next to a top-level `vite`), so the migration must not add a direct
// `vite` dep — leaving non-browser consumers untouched.
const pkg = {
devDependencies: {
vitest: '^4.0.0',
},
};
rewritePackageJson(pkg, PackageManager.npm);
expect(pkg.devDependencies).not.toHaveProperty('vite');
});
it('does not inject a direct vite devDependency for non-npm provider projects', async () => {
// pnpm/yarn use symlink/PnP layouts that already expose the `vite` override
// to the provider subtree, so the npm-only direct-`vite` workaround must not
// fire for them.
const pkg = {
devDependencies: {
'@vitest/browser-playwright': '^4.0.0',
playwright: '^1.60.0',
vitest: '^4.0.0',
},
};
rewritePackageJson(pkg, PackageManager.pnpm);
expect(pkg.devDependencies).not.toHaveProperty('vite');
});
it('normalizes a pre-existing direct vite dep to the override target for an npm provider project', async () => {
// A pre-existing direct `vite` is already normalized to the override target
// by the `VITE_PLUS_OVERRIDE_PACKAGES` loop (vite-plus replaces `vite` with
// its bundled core). The provider workaround must not duplicate or clobber
// it — the single direct `vite` stays pointed at the override target.
const pkg = {
devDependencies: {
'@vitest/browser-playwright': '^4.0.0',
playwright: '^1.60.0',
vite: '^7.0.0',
vitest: '^4.0.0',
},
};
rewritePackageJson(pkg, PackageManager.npm);
expect(pkg.devDependencies).toHaveProperty('vite', VITE_PLUS_OVERRIDE_PACKAGES.vite);
});
it('keeps and normalizes @vitest/browser-webdriverio and ensures the webdriverio peer', async () => {
// Webdriverio is opt-in: vite-plus no longer bundles the provider, so the
// migration KEEPS the user's declared `@vitest/browser-webdriverio`
// (version-normalized to the bundled vitest version) and ensures its
// runtime framework peer `webdriverio`. `@vitest/browser` stays in
// REMOVE_PACKAGES and is still stripped.
const pkg = {
devDependencies: {
'@vitest/browser': '^4.0.0',
'@vitest/browser-webdriverio': '^4.0.0',
vitest: '^4.0.0',
},
};
rewritePackageJson(pkg, PackageManager.pnpm);
// Standalone (supportCatalog=false) → concrete pinned spec.
expect(pkg.devDependencies).toHaveProperty('@vitest/browser-webdriverio', VITEST_VERSION);
expect(pkg.devDependencies).toHaveProperty('webdriverio', '*');
expect(pkg.devDependencies).not.toHaveProperty('@vitest/browser');
});
it('should not overwrite playwright if already in devDependencies', async () => {
const pkg = {
devDependencies: {
'@vitest/browser-playwright': '^4.0.0',
playwright: '^1.40.0',
vitest: '^4.0.0',
},
};
rewritePackageJson(pkg, PackageManager.pnpm);
expect(pkg.devDependencies).toHaveProperty('playwright', '^1.40.0');
});
it('should not add playwright if already in dependencies', async () => {
const pkg = {
dependencies: {
playwright: '^1.40.0',
},
devDependencies: {
'@vitest/browser-playwright': '^4.0.0',
vitest: '^4.0.0',
},
};
rewritePackageJson(pkg, PackageManager.pnpm);
expect(pkg.dependencies).toHaveProperty('playwright', '^1.40.0');
expect(pkg.devDependencies).not.toHaveProperty('playwright');
});
it('adds a direct vitest devDependency when the package uses browser mode', async () => {
// A package that drives vitest browser mode but has no direct vitest dep
// (e.g. it only imports `vite-plus/test/browser-playwright`). `@vitest/browser`
// needs `vitest` resolvable from the package root, so the migration must
// pin it as a direct devDependency.
const pkg = {
devDependencies: {
playwright: '^1.58.0',
},
};
rewritePackageJson(pkg, PackageManager.pnpm, true, undefined, undefined, true);
expect(pkg.devDependencies).toHaveProperty('vitest', 'catalog:');
expect(pkg.devDependencies).toHaveProperty('vite-plus', 'catalog:');
});
it('uses a concrete vitest version for browser mode in non-catalog package managers', async () => {
const pkg = {
devDependencies: {
playwright: '^1.58.0',
},
};
rewritePackageJson(pkg, PackageManager.npm, false, undefined, undefined, true);
expect((pkg as { devDependencies?: Record<string, string> }).devDependencies?.vitest).toBe(
VITEST_VERSION,
);
});
it('does not overwrite an existing direct vitest dep in browser mode', async () => {
const pkg = {
devDependencies: {
vitest: '^4.0.0',
},
};
rewritePackageJson(pkg, PackageManager.pnpm, true, undefined, undefined, true);
// existing direct dep is normalized through the override path, not replaced
expect(pkg.devDependencies.vitest).toBe('catalog:');
});
it('does not add vitest when browser mode is not detected', async () => {
const pkg = {
devDependencies: {
vite: '^7.0.0',
},
};
rewritePackageJson(pkg, PackageManager.pnpm, true, undefined, undefined, false);
expect(pkg.devDependencies).not.toHaveProperty('vitest');
});
it('adds a direct vitest dep when a browser provider is declared but not source-imported', async () => {
// Config-only browser mode: vitest is enabled via `vite.config.ts`
// (e.g. `test.browser.provider: 'playwright'`) and the provider package is
// declared in devDependencies, but no source file `import`s it. The
// source-scan signal (`usesVitestBrowserMode`) is therefore false; the
// dep declaration in the original package.json must still drive the
// direct-`vitest` injection so the browser optimizer can resolve `vitest`
// from the package root under pnpm strict / Yarn PnP.
const pkg = {
devDependencies: {
'@vitest/browser': '^4.1.7',
'@vitest/browser-playwright': '^4.1.7',
},
};
rewritePackageJson(pkg, PackageManager.pnpm, true, undefined, undefined, false);
expect(pkg.devDependencies).toHaveProperty('vitest', 'catalog:');
expect(pkg.devDependencies).toHaveProperty('vite-plus', 'catalog:');
// The base `@vitest/browser` is still stripped (bundled by vite-plus).
expect(pkg.devDependencies).not.toHaveProperty('@vitest/browser');
// Playwright is opt-in: vite-plus keeps it in the user's deps, normalized to
// the bundled vitest version, so the rewritten import resolves.
expect(pkg.devDependencies).toHaveProperty('@vitest/browser-playwright', VITEST_VERSION);
// The provider's runtime peer dep is preserved.
expect(pkg.devDependencies).toHaveProperty('playwright', '*');
});
});
describe('rewriteEslintPackageJson', () => {
let tmpDir: string;
beforeEach(() => {
tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'vp-test-eslint-cleanup-'));
});
afterEach(() => {
fs.rmSync(tmpDir, { recursive: true, force: true });
});
function writePkg(pkg: object): string {
const pkgPath = path.join(tmpDir, 'package.json');
fs.writeFileSync(pkgPath, JSON.stringify(pkg));
return pkgPath;
}
it('removes eslint, eslint-plugin-*, eslint-config-*, typescript-eslint, @typescript-eslint/*', () => {
const pkgPath = writePkg({
devDependencies: {
eslint: '^9.0.0',
'eslint-plugin-vue': '^10.0.0',
'eslint-plugin-react': '^7.0.0',
'eslint-config-airbnb': '^19.0.0',
'typescript-eslint': '^8.0.0',
'@typescript-eslint/parser': '^8.0.0',
'@typescript-eslint/eslint-plugin': '^8.0.0',
vite: '^7.0.0',
},
dependencies: {
'eslint-plugin-import': '^2.0.0',
vue: '^3.5.0',
},
});
rewriteEslintPackageJson(pkgPath);
const pkg = readJson(pkgPath);
expect(pkg.devDependencies).toEqual({ vite: '^7.0.0' });
expect(pkg.dependencies).toEqual({ vue: '^3.5.0' });
});
it('removes scoped ESLint plugin/config packages (e.g. @vue/eslint-config-typescript)', () => {
const pkgPath = writePkg({
devDependencies: {
'@vue/eslint-config-typescript': '^13.0.0',
'@nuxt/eslint-config': '^0.5.0',
'@stylistic/eslint-plugin': '^2.0.0',
'@stylistic/eslint-plugin-ts': '^2.0.0',
'@vitest/eslint-plugin': '^1.0.0',
keepme: '^1.0.0',
},
});
rewriteEslintPackageJson(pkgPath);
const pkg = readJson(pkgPath);
expect(pkg.devDependencies).toEqual({ keepme: '^1.0.0' });
});
it('removes @eslint/*, @eslint-community/*, and @angular-eslint/* scope packages', () => {
const pkgPath = writePkg({
devDependencies: {
eslint: '^9.0.0',
'@eslint/js': '^9.0.0',
'@eslint/eslintrc': '^3.0.0',
'@eslint/compat': '^1.0.0',
'@eslint-community/eslint-utils': '^4.0.0',
'@eslint-community/regexpp': '^4.0.0',
'@angular-eslint/template-parser': '^18.0.0',
'@angular-eslint/builder': '^18.0.0',
keepme: '^1.0.0',
},
});
rewriteEslintPackageJson(pkgPath);
const pkg = readJson(pkgPath);
expect(pkg.devDependencies).toEqual({ keepme: '^1.0.0' });
});
it('removes ESLint formatter and helper packages', () => {
const pkgPath = writePkg({
devDependencies: {
eslint: '^9.0.0',
'eslint-formatter-pretty': '^6.0.0',
'eslint-formatter-gitlab': '^5.0.0',
eslintrc: '^2.0.0',
'eslint-utils': '^3.0.0',
'eslint-visitor-keys': '^4.0.0',
'eslint-scope': '^8.0.0',
'eslint-define-config': '^2.0.0',
'eslint-doc-generator': '^2.0.0',
keepme: '^1.0.0',
},
});
rewriteEslintPackageJson(pkgPath);
const pkg = readJson(pkgPath);
expect(pkg.devDependencies).toEqual({ keepme: '^1.0.0' });
});
it('does NOT remove framework-ESLint integrations (e.g. @nuxt/eslint) — those short-circuit migration upstream', () => {
// The skip path in `bin.ts` prevents `rewriteEslintPackageJson` from
// being called when `@nuxt/eslint` is present, so this function
// doesn't need to (and shouldn't) know about it.
const pkgPath = writePkg({
devDependencies: {
eslint: '^9.0.0',
'@nuxt/eslint': '^1.0.0',
},
});
rewriteEslintPackageJson(pkgPath);
const pkg = readJson(pkgPath);
expect(pkg.devDependencies).toEqual({ '@nuxt/eslint': '^1.0.0' });
});
it('preserves reusable @typescript-eslint/* AST libraries (utils, typescript-estree, etc.)', () => {
const pkgPath = writePkg({
devDependencies: {
eslint: '^9.0.0',
'@typescript-eslint/parser': '^8.0.0',
'@typescript-eslint/eslint-plugin': '^8.0.0',
'@typescript-eslint/rule-tester': '^8.0.0',
'@typescript-eslint/utils': '^8.0.0',
'@typescript-eslint/typescript-estree': '^8.0.0',
'@typescript-eslint/scope-manager': '^8.0.0',
'@typescript-eslint/types': '^8.0.0',
vite: '^7.0.0',
},
});
rewriteEslintPackageJson(pkgPath);
const pkg = readJson(pkgPath);
expect(pkg.devDependencies).toEqual({
'@typescript-eslint/utils': '^8.0.0',
'@typescript-eslint/typescript-estree': '^8.0.0',
'@typescript-eslint/scope-manager': '^8.0.0',
'@typescript-eslint/types': '^8.0.0',
vite: '^7.0.0',
});
});
it('removes @types/<X> packages symmetrically with their runtime counterparts', () => {
const pkgPath = writePkg({
devDependencies: {
eslint: '^9.0.0',
'@types/eslint': '^9.0.0',
'@types/eslint-plugin-foo': '^1.0.0',
'@types/eslint-config-bar': '^1.0.0',
// Type-only counterpart of an ESLint plugin should also go.
'@types/eslint-scope': '^3.0.0',
// Unrelated @types should stay.
'@types/node': '^22.0.0',
},
});
rewriteEslintPackageJson(pkgPath);
const pkg = readJson(pkgPath);
expect(pkg.devDependencies).toEqual({ '@types/node': '^22.0.0' });
});
it('scrubs peerDependencies and optionalDependencies', () => {
const pkgPath = writePkg({
peerDependencies: {
eslint: '>=9',
'eslint-plugin-vue': '^10.0.0',
},
optionalDependencies: {
'@typescript-eslint/parser': '^8.0.0',
},
devDependencies: { vite: '^7.0.0' },
});
rewriteEslintPackageJson(pkgPath);
const pkg = readJson(pkgPath);
expect(pkg.peerDependencies).toBeUndefined();
expect(pkg.optionalDependencies).toBeUndefined();
expect(pkg.devDependencies).toEqual({ vite: '^7.0.0' });
});
it('deletes the dependency field entirely when our cleanup emptied it', () => {
const pkgPath = writePkg({
devDependencies: {
eslint: '^9.0.0',
'eslint-plugin-import': '^2.0.0',
},
dependencies: { 'eslint-config-airbnb': '^19.0.0' },
});
rewriteEslintPackageJson(pkgPath);
const pkg = readJson(pkgPath);
expect(pkg.devDependencies).toBeUndefined();
expect(pkg.dependencies).toBeUndefined();
});
it('preserves unrelated dependencies (e.g. @vitejs/plugin-vue, vue, vite, @nuxt/kit)', () => {
const pkgPath = writePkg({
devDependencies: {
eslint: '^9.0.0',
'@vitejs/plugin-vue': '^6.0.0',
'@vue/runtime-core': '^3.5.0',
'@nuxt/kit': '^3.13.0',
vite: '^7.0.0',
},
});
rewriteEslintPackageJson(pkgPath);
const pkg = readJson(pkgPath);
expect(pkg.devDependencies).toEqual({
'@vitejs/plugin-vue': '^6.0.0',
'@vue/runtime-core': '^3.5.0',
'@nuxt/kit': '^3.13.0',
vite: '^7.0.0',
});
});
it('no-ops when package.json has no eslint-ecosystem deps', () => {
const pkgPath = writePkg({
devDependencies: { vite: '^7.0.0' },
});
const before = fs.readFileSync(pkgPath, 'utf8');
rewriteEslintPackageJson(pkgPath);
const after = fs.readFileSync(pkgPath, 'utf8');
expect(after).toBe(before);
});
it('preserves packages referenced in lint.jsPlugins (so the generated config still loads)', () => {
// When @oxlint/migrate translates a real ESLint plugin into a
// lint.jsPlugins reference, Oxlint will `import()` the package at
// lint time. If we strip it from package.json the lint config we
// just generated is invalidated. The preserveJsPlugins set guards
// against that.
const pkgPath = writePkg({
devDependencies: {
eslint: '^9.0.0',
'eslint-plugin-vue': '^10.0.0',
'eslint-plugin-import-x': '^4.0.0',
'eslint-plugin-react': '^7.37.0',
'@stylistic/eslint-plugin': '^2.0.0',
'@typescript-eslint/parser': '^8.0.0',
vite: '^7.0.0',
},
});
rewriteEslintPackageJson(
pkgPath,
new Set(['eslint-plugin-vue', 'eslint-plugin-import-x', '@stylistic/eslint-plugin']),
);
const pkg = readJson(pkgPath);
expect(pkg.devDependencies).toEqual({
// Preserved (in jsPlugins set, so Oxlint will load them):
'eslint-plugin-vue': '^10.0.0',
'eslint-plugin-import-x': '^4.0.0',
'@stylistic/eslint-plugin': '^2.0.0',
// Removed (no jsPlugins reference, normal cleanup):
// 'eslint': stripped
// 'eslint-plugin-react': stripped
// '@typescript-eslint/parser': stripped
vite: '^7.0.0',
});
});
it('preserveJsPlugins overrides every cleanup pattern (named, prefix, scope, regex)', () => {
// Stress-test each branch of isEslintEcosystemDep against the
// preserve set so a future contributor adding a new cleanup branch
// can't accidentally bypass the carve-out.
const pkgPath = writePkg({
devDependencies: {
eslint: '^9.0.0', // named match in ESLINT_ECOSYSTEM_NAMES
'eslint-plugin-foo': '^1.0.0', // prefix match
'@eslint/js': '^9.0.0', // scope match
'@scope/eslint-plugin-bar': '^1.0.0', // scoped regex match
keepme: '^1.0.0',
},
});
rewriteEslintPackageJson(
pkgPath,
new Set(['eslint', 'eslint-plugin-foo', '@eslint/js', '@scope/eslint-plugin-bar']),
);
const pkg = readJson(pkgPath);
expect(pkg.devDependencies).toEqual({
eslint: '^9.0.0',
'eslint-plugin-foo': '^1.0.0',
'@eslint/js': '^9.0.0',
'@scope/eslint-plugin-bar': '^1.0.0',
keepme: '^1.0.0',
});
});
it('does not invent preserveJsPlugins entries — only what the caller asked for', () => {
// Sanity: an empty preserve set behaves identically to the default
// (no carve-out), so the new parameter can't accidentally weaken
// the cleanup for existing callers.
const pkgPath = writePkg({
devDependencies: {
eslint: '^9.0.0',
'eslint-plugin-foo': '^1.0.0',
vite: '^7.0.0',
},
});
rewriteEslintPackageJson(pkgPath, new Set());
const pkg = readJson(pkgPath);
expect(pkg.devDependencies).toEqual({ vite: '^7.0.0' });
});
});
function writePkgAt(dir: string, pkg: object): void {
fs.mkdirSync(dir, { recursive: true });
fs.writeFileSync(path.join(dir, 'package.json'), JSON.stringify(pkg));
}
describe('detectIncompatibleEslintIntegration', () => {
let tmpDir: string;
beforeEach(() => {
tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'vp-test-incompat-eslint-'));
});
afterEach(() => {
fs.rmSync(tmpDir, { recursive: true, force: true });
});
it('returns "@nuxt/eslint" when listed in devDependencies', () => {
writePkgAt(tmpDir, { devDependencies: { '@nuxt/eslint': '^1.0.0' } });
expect(detectIncompatibleEslintIntegration(tmpDir)).toBe('@nuxt/eslint');
});
it('returns "@nuxt/eslint" when listed in dependencies', () => {
writePkgAt(tmpDir, { dependencies: { '@nuxt/eslint': '^1.0.0' } });
expect(detectIncompatibleEslintIntegration(tmpDir)).toBe('@nuxt/eslint');
});
it('detects when @nuxt/eslint lives in a workspace package, not the root', () => {
writePkgAt(tmpDir, { name: 'root' });
writePkgAt(path.join(tmpDir, 'packages/app'), {
name: 'app',
devDependencies: { '@nuxt/eslint': '^1.0.0' },
});
expect(
detectIncompatibleEslintIntegration(tmpDir, [{ name: 'app', path: 'packages/app' }]),
).toBe('@nuxt/eslint');
});
it('returns undefined when @nuxt/eslint is absent', () => {
writePkgAt(tmpDir, {
devDependencies: { eslint: '^9.0.0', '@nuxt/kit': '^3.0.0' },
});
expect(detectIncompatibleEslintIntegration(tmpDir)).toBeUndefined();
});
it('returns undefined when package.json is missing', () => {
expect(detectIncompatibleEslintIntegration(tmpDir)).toBeUndefined();
});
});
describe('parseNvmrcVersion', () => {
it('strips v prefix', () => {
expect(parseNvmrcVersion('v20.5.0')).toBe('20.5.0');
});
it('passes through version without prefix', () => {
expect(parseNvmrcVersion('20.5.0')).toBe('20.5.0');
expect(parseNvmrcVersion('20')).toBe('20');
});
it('passes through lts aliases', () => {
expect(parseNvmrcVersion('lts/*')).toBe('lts/*');
expect(parseNvmrcVersion('lts/iron')).toBe('lts/iron');
expect(parseNvmrcVersion('lts/-1')).toBe('lts/-1');
});
it('converts node/stable aliases to lts/*', () => {
expect(parseNvmrcVersion('node')).toBe('lts/*');
expect(parseNvmrcVersion('stable')).toBe('lts/*');
});
it('returns null for untranslatable aliases', () => {
expect(parseNvmrcVersion('iojs')).toBeNull();
expect(parseNvmrcVersion('system')).toBeNull();
expect(parseNvmrcVersion('default')).toBeNull();
expect(parseNvmrcVersion('')).toBeNull();
});
it('returns null for invalid version strings', () => {
expect(parseNvmrcVersion('v')).toBeNull();
expect(parseNvmrcVersion('laetst')).toBeNull();
expect(parseNvmrcVersion('20.5.0.1')).toBeNull();
});
});
describe('setPackageManager', () => {
let tmpDir: string;
const downloadResult = {
name: 'pnpm',
installDir: '/tmp/install',
binPrefix: '/tmp/install/bin',
packageName: 'pnpm',
version: '11.5.1',
};
beforeEach(() => {
tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'vp-test-'));
});
afterEach(() => {
fs.rmSync(tmpDir, { recursive: true, force: true });
});
const readPkg = () =>
JSON.parse(fs.readFileSync(path.join(tmpDir, 'package.json'), 'utf8')) as Record<
string,
unknown
>;
it('writes devEngines.packageManager when neither field exists', () => {
fs.writeFileSync(path.join(tmpDir, 'package.json'), JSON.stringify({ name: 'x' }, null, 2));
setPackageManager(tmpDir, downloadResult);
expect(readPkg().devEngines).toEqual({
packageManager: { name: 'pnpm', version: '11.5.1', onFail: 'download' },
});
});
it('keeps an existing packageManager field untouched', () => {
fs.writeFileSync(
path.join(tmpDir, 'package.json'),
JSON.stringify({ name: 'x', packageManager: 'npm@10.5.0' }, null, 2),
);
setPackageManager(tmpDir, downloadResult);
const pkg = readPkg();
expect(pkg.packageManager).toBe('npm@10.5.0');