fix: rewrite vitest browser imports to exported paths

Author: Han5991

packages/cli/snap-tests/lint-vite-plus-imports/snap.txt

@@ -1,5 +1,60 @@
 [1]> vp lint src/index.ts src/types.ts # should fail before fix
 
+  × vite-plus(prefer-vite-plus-imports): Use 'vite-plus/test' instead of 'vitest' in Vite+ projects.
+   ╭─[src/types.ts:1:30]
+ 1 │ type TestFn = (typeof import('vitest'))['test'];
+   ·                              ────────
+ 2 │ type BrowserContext = typeof import('@vitest/browser/context');
+   ╰────
+
+  × vite-plus(prefer-vite-plus-imports): Use 'vite-plus/test/browser/context' instead of '@vitest/browser/context' in Vite+ projects.
+   ╭─[src/types.ts:2:37]
+ 1 │ type TestFn = (typeof import('vitest'))['test'];
+ 2 │ type BrowserContext = typeof import('@vitest/browser/context');
+   ·                                     ─────────────────────────
+ 3 │ type BrowserClient = typeof import('@vitest/browser/client');
+   ╰────
+
+  × vite-plus(prefer-vite-plus-imports): Use 'vite-plus/test/client' instead of '@vitest/browser/client' in Vite+ projects.
+   ╭─[src/types.ts:3:36]
+ 2 │ type BrowserContext = typeof import('@vitest/browser/context');
+ 3 │ type BrowserClient = typeof import('@vitest/browser/client');
+   ·                                    ────────────────────────
+ 4 │ type PlaywrightProvider = typeof import('@vitest/browser-playwright/provider');
+   ╰────
+
+  × vite-plus(prefer-vite-plus-imports): Use 'vite-plus/test/browser/providers/playwright' instead of '@vitest/browser-playwright/provider' in Vite+ projects.
+   ╭─[src/types.ts:4:41]
+ 3 │ type BrowserClient = typeof import('@vitest/browser/client');
+ 4 │ type PlaywrightProvider = typeof import('@vitest/browser-playwright/provider');
+   ·                                         ─────────────────────────────────────
+ 5 │ 
+   ╰────
+
+  × vite-plus(prefer-vite-plus-imports): Use 'vite-plus/test/browser-playwright' instead of '@vitest/browser-playwright' in Vite+ projects.
+   ╭─[src/types.ts:6:16]
+ 5 │ 
+ 6 │ declare module '@vitest/browser-playwright' {}
+   ·                ────────────────────────────
+ 7 │ declare module '@vitest/browser-playwright/context' {}
+   ╰────
+
+  × vite-plus(prefer-vite-plus-imports): Use 'vite-plus/test/browser/context' instead of '@vitest/browser-playwright/context' in Vite+ projects.
+   ╭─[src/types.ts:7:16]
+ 6 │ declare module '@vitest/browser-playwright' {}
+ 7 │ declare module '@vitest/browser-playwright/context' {}
+   ·                ────────────────────────────────────
+ 8 │ 
+   ╰────
+
+  × vite-plus(prefer-vite-plus-imports): Use 'vite-plus/client' instead of 'vite/client' in Vite+ projects.
+    ╭─[src/types.ts:9:25]
+  8 │ 
+  9 │ import client = require('vite/client');
+    ·                         ─────────────
+ 10 │ 
+    ╰────
+
   × vite-plus(prefer-vite-plus-imports): Use 'vite-plus' instead of 'vite' in Vite+ projects.
    ╭─[src/index.ts:1:30]
  1 │ import { defineConfig } from 'vite';
@@ -23,30 +78,7 @@
  6 │ 
    ╰────
 
-  × vite-plus(prefer-vite-plus-imports): Use 'vite-plus/test' instead of 'vitest' in Vite+ projects.
-   ╭─[src/types.ts:1:30]
- 1 │ type TestFn = (typeof import('vitest'))['test'];
-   ·                              ────────
- 2 │ 
-   ╰────
-
-  × vite-plus(prefer-vite-plus-imports): Use 'vite-plus/test/browser-playwright' instead of '@vitest/browser-playwright' in Vite+ projects.
-   ╭─[src/types.ts:3:16]
- 2 │ 
- 3 │ declare module '@vitest/browser-playwright' {}
-   ·                ────────────────────────────
- 4 │ 
-   ╰────
-
-  × vite-plus(prefer-vite-plus-imports): Use 'vite-plus/client' instead of 'vite/client' in Vite+ projects.
-   ╭─[src/types.ts:5:25]
- 4 │ 
- 5 │ import client = require('vite/client');
-   ·                         ─────────────
- 6 │ 
-   ╰────
-
-Found 0 warnings and 6 errors.
+Found 0 warnings and 10 errors.
 Finished in <variable>ms on 2 files with <variable> rules using <variable> threads.
 
 > vp lint --fix src/index.ts src/types.ts # rewrite vite and vitest imports via the vite-plus oxlint plugin
@@ -65,12 +97,16 @@ void configPromise;
 
 > cat src/types.ts
 type TestFn = (typeof import('vite-plus/test'))['test'];
+type BrowserContext = typeof import('vite-plus/test/browser/context');
+type BrowserClient = typeof import('vite-plus/test/client');
+type PlaywrightProvider = typeof import('vite-plus/test/browser/providers/playwright');
 
 declare module 'vite-plus/test/browser-playwright' {}
+declare module 'vite-plus/test/browser/context' {}
 
 import client = require('vite-plus/client');
 
-export type { TestFn };
+export type { BrowserClient, BrowserContext, PlaywrightProvider, TestFn };
 
 void client;
 

packages/cli/snap-tests/lint-vite-plus-imports/src/types.ts

@@ -1,9 +1,13 @@
 type TestFn = (typeof import('vitest'))['test'];
+type BrowserContext = typeof import('@vitest/browser/context');
+type BrowserClient = typeof import('@vitest/browser/client');
+type PlaywrightProvider = typeof import('@vitest/browser-playwright/provider');
 
 declare module '@vitest/browser-playwright' {}
+declare module '@vitest/browser-playwright/context' {}
 
 import client = require('vite/client');
 
-export type { TestFn };
+export type { BrowserClient, BrowserContext, PlaywrightProvider, TestFn };
 
 void client;

packages/cli/src/__tests__/oxlint-plugin.spec.ts

@@ -61,9 +61,26 @@ describe('rewriteVitePlusImportSpecifier', () => {
     expect(rewriteVitePlusImportSpecifier('vitest')).toBe('vite-plus/test');
     expect(rewriteVitePlusImportSpecifier('vitest/config')).toBe('vite-plus');
     expect(rewriteVitePlusImportSpecifier('@vitest/browser')).toBe('vite-plus/test/browser');
+    expect(rewriteVitePlusImportSpecifier('@vitest/browser/context')).toBe(
+      'vite-plus/test/browser/context',
+    );
+    expect(rewriteVitePlusImportSpecifier('@vitest/browser/client')).toBe('vite-plus/test/client');
+    expect(rewriteVitePlusImportSpecifier('@vitest/browser/locators')).toBe(
+      'vite-plus/test/locators',
+    );
+    expect(rewriteVitePlusImportSpecifier('@vitest/browser-playwright/context')).toBe(
+      'vite-plus/test/browser/context',
+    );
     expect(rewriteVitePlusImportSpecifier('@vitest/browser-playwright/provider')).toBe(
-      'vite-plus/test/browser-playwright/provider',
+      'vite-plus/test/browser/providers/playwright',
     );
+    expect(rewriteVitePlusImportSpecifier('@vitest/browser-preview/provider')).toBe(
+      'vite-plus/test/browser/providers/preview',
+    );
+    expect(rewriteVitePlusImportSpecifier('@vitest/browser-webdriverio/provider')).toBe(
+      'vite-plus/test/browser/providers/webdriverio',
+    );
+    expect(rewriteVitePlusImportSpecifier('@vitest/browser-playwright/locators')).toBeNull();
     expect(rewriteVitePlusImportSpecifier('tsx')).toBeNull();
   });
 });
@@ -80,6 +97,14 @@ new RuleTester({
       code: `declare module 'vite-plus/test/browser' {}`,
       filename: 'types.ts',
     },
+    {
+      code: `type BrowserClient = typeof import('vite-plus/test/client')`,
+      filename: 'types.ts',
+    },
+    {
+      code: `type PlaywrightProvider = typeof import('vite-plus/test/browser/providers/playwright')`,
+      filename: 'types.ts',
+    },
     {
       code: `type TestFn = typeof import('vite-plus/test')['test']`,
       filename: 'types.ts',
@@ -113,6 +138,24 @@ new RuleTester({
       filename: 'types.ts',
       output: `declare module 'vite-plus/test/browser-playwright' {}`,
     },
+    {
+      code: `declare module '@vitest/browser-playwright/context' {}`,
+      errors: 1,
+      filename: 'types.ts',
+      output: `declare module 'vite-plus/test/browser/context' {}`,
+    },
+    {
+      code: `type BrowserClient = typeof import('@vitest/browser/client')`,
+      errors: 1,
+      filename: 'types.ts',
+      output: `type BrowserClient = typeof import('vite-plus/test/client')`,
+    },
+    {
+      code: `type PlaywrightProvider = typeof import('@vitest/browser-playwright/provider')`,
+      errors: 1,
+      filename: 'types.ts',
+      output: `type PlaywrightProvider = typeof import('vite-plus/test/browser/providers/playwright')`,
+    },
     {
       code: `import foo = require('vite/client')`,
       errors: 1,

packages/cli/src/oxlint-plugin.ts

@@ -54,18 +54,34 @@ function rewriteVitePlusImportSpecifier(specifier: string): string | null {
     return `vite-plus/test/${specifier.slice('vitest/'.length)}`;
   }
 
-  for (const prefix of [
-    '@vitest/browser-playwright',
-    '@vitest/browser-preview',
-    '@vitest/browser-webdriverio',
-    '@vitest/browser',
-  ]) {
+  if (specifier === '@vitest/browser') {
+    return 'vite-plus/test/browser';
+  }
+
+  const browserSubpathRewrites: Record<string, string> = {
+    '@vitest/browser/context': 'vite-plus/test/browser/context',
+    '@vitest/browser/client': 'vite-plus/test/client',
+    '@vitest/browser/locators': 'vite-plus/test/locators',
+  };
+  if (specifier in browserSubpathRewrites) {
+    return browserSubpathRewrites[specifier];
+  }
+
+  for (const [prefix, provider] of [
+    ['@vitest/browser-playwright', 'playwright'],
+    ['@vitest/browser-preview', 'preview'],
+    ['@vitest/browser-webdriverio', 'webdriverio'],
+  ] as const) {
     if (specifier === prefix) {
       return `vite-plus/test/${prefix.slice('@vitest/'.length)}`;
     }
 
-    if (specifier.startsWith(`${prefix}/`)) {
-      return `vite-plus/test/${specifier.slice('@vitest/'.length)}`;
+    if (specifier === `${prefix}/context`) {
+      return 'vite-plus/test/browser/context';
+    }
+
+    if (specifier === `${prefix}/provider`) {
+      return `vite-plus/test/browser/providers/${provider}`;
     }
   }