renamed,nit fixed,added tests

Author: 0xTaneja

README.md

@@ -45,7 +45,7 @@ specify it in the options like in the following:
 | Name | Type | Default | Description |
 |------|------|---------|-------------|
 | `projectRoot` | `string` | `config.root` | Absolute path that will be reported to DevTools. Useful for monorepos or when the Vite root is not the desired folder. |
-| `normalizeForChrome` | `boolean` | `true` | Convert Linux paths to UNC form so Chrome on Windows (WSL / Docker Desktop) can mount them. Pass `false` to disable. |
+| `normalizeForWindowsContainer` | `boolean` | `true` | Convert Linux paths to UNC form so Chrome on Windows (WSL / Docker Desktop) can mount them (e.g. via WSL or Docker Desktop). Pass `false` to disable. <br/>_Alias:_ `normalizeForChrome` (deprecated)_ |
 | `uuid` | `string` | auto-generated | Fixed UUID if you prefer to control it yourself. |
 
 Example with all options:
@@ -58,7 +58,7 @@ export default defineConfig({
   plugins: [
     devtoolsJson({
       projectRoot: '/absolute/path/to/project',
-      normalizeForChrome: true,
+      normalizeForWindowsContainer: true,
       uuid: '6ec0bd7f-11c0-43da-975e-2a8ad9ebae0b'
     })
   ]

src/index.ts

@@ -13,17 +13,19 @@ interface DevToolsJsonOptions {
 
   /**
    * Absolute (or relative) path that should be reported as the project root
-   * in DevTools.  When omitted we fall back to Vite's `config.root` logic
-   * – identical to the original implementation.
+   * in DevTools. When omitted, we fall back to Vite’s `config.root` logic.
    */
   projectRoot?: string;
 
   /**
-   * Whether to rewrite Linux paths to UNC form so Chrome running on Windows
-   * (WSL or Docker Desktop) can mount them as a workspace.  Enabled by
-   * default to preserve the original behaviour; pass `false` to opt-out.
+   * @deprecated Use `normalizeForWindowsContainer` instead. Will be removed in a future major version.
    */
   normalizeForChrome?: boolean;
+  /**
+   * Whether to rewrite Linux paths to UNC form so Chrome running on Windows
+   * (WSL or Docker Desktop) can mount them as a workspace. Enabled by default.
+   */
+  normalizeForWindowsContainer?: boolean;
 }
 
 interface DevToolsJSON {
@@ -80,22 +82,37 @@ const plugin = (options: DevToolsJsonOptions = {}): Plugin => ({
       return uuid;
     };
 
+    // Determine effective normalisation flag once so we can reuse it.
+    const normalizePaths =
+      options.normalizeForWindowsContainer ??
+      (options.normalizeForChrome ?? true);
+
+    // Emit deprecation warning if old option is used in isolation.
+    if (
+      Object.prototype.hasOwnProperty.call(options, 'normalizeForChrome') &&
+      options.normalizeForWindowsContainer === undefined
+    ) {
+      logger.warn(
+        '[vite-plugin-devtools-json] "normalizeForChrome" is deprecated – please rename to "normalizeForWindowsContainer".'
+      );
+    }
+
     server.middlewares.use(ENDPOINT, async (_req, res) => {
       // Determine the project root that will be reported to DevTools.
       const resolveProjectRoot = (): string => {
         if (options.projectRoot) {
           return path.resolve(options.projectRoot);
         }
         // Fall back to Vite's root handling (original behaviour)
-        let {root} = config;
-        if (!path.isAbsolute(root)) {
-          root = path.resolve(process.cwd(), root);
-        }
+      let {root} = config;
+      if (!path.isAbsolute(root)) {
+        root = path.resolve(process.cwd(), root);
+      }
         return root;
       };
 
-      const maybeNormalizeForChrome = (absRoot: string): string => {
-        if (options.normalizeForChrome === false) return absRoot;
+      const maybeNormalizePath = (absRoot: string): string => {
+        if (!normalizePaths) return absRoot;
 
         // WSL path rewrite
         if (process.env.WSL_DISTRO_NAME) {
@@ -112,12 +129,12 @@ const plugin = (options: DevToolsJsonOptions = {}): Plugin => ({
           return path
             .join('\\\\wsl.localhost', 'docker-desktop-data', withoutLeadingSlash)
             .replace(/\//g, '\\');
-        }
+      }
 
         return absRoot;
       };
 
-      let root = maybeNormalizeForChrome(resolveProjectRoot());
+      let root = maybeNormalizePath(resolveProjectRoot());
       const uuid = getOrCreateUUID();
       const devtoolsJson: DevToolsJSON = {
         workspace: {

test/index.test.ts

@@ -102,10 +102,10 @@ describe('#VitePluginDevToolsJson', () => {
       await server.close();
     });
 
-    it('should skip path normalization when `normalizeForChrome` is false', async () => {
+    it('should skip path normalization when `normalizeForWindowsContainer` is false', async () => {
       process.env.WSL_DISTRO_NAME = 'fake-distro';
       const server = await createServer({
-        plugins: [VitePluginDevToolsJson({ normalizeForChrome: false })],
+        plugins: [VitePluginDevToolsJson({ normalizeForWindowsContainer: false })],
         server: { port, host: true },
       });
       await server.listen();
@@ -118,5 +118,25 @@ describe('#VitePluginDevToolsJson', () => {
       await server.close();
       delete process.env.WSL_DISTRO_NAME;
     });
+
+    it('should convert path when running inside Docker Desktop on Windows', async () => {
+      delete process.env.WSL_DISTRO_NAME;
+      process.env.DOCKER_DESKTOP = 'true';
+
+      const server = await createServer({
+        plugins: [VitePluginDevToolsJson()],
+        server: { port, host: true },
+      });
+
+      await server.listen();
+
+      const response = await request(server.httpServer!)
+        .get('/.well-known/appspecific/com.chrome.devtools.json');
+      const json = JSON.parse(response.text);
+      expect(json.workspace.root).to.include('docker-desktop-data');
+
+      await server.close();
+      delete process.env.DOCKER_DESKTOP;
+    });
   });
 });