feat: add transformWin32RelativePath

Author: SoonIter

e2e/features.test.ts

@@ -1,7 +1,7 @@
 import path from 'node:path';
-import { expect } from 'vitest';
-import { test } from 'vitest';
 import { createSnapshotSerializer } from 'path-serializer';
+import { describe, expect } from 'vitest';
+import { test } from 'vitest';
 
 expect.addSnapshotSerializer(
   createSnapshotSerializer({
@@ -13,44 +13,39 @@ expect.addSnapshotSerializer(
   }),
 );
 
-test('should serialize file content without escaping \\"', () => {
-  const fileContent = `"use strict";
-const a = "${require.resolve('@rslib/core')}";
-`;
+test('transformWin32Path', () => {
+  const fileContent = `{
+      loader: 'D:\\Users\\user\\Documents\\code\\user\\fe-dev-scripts\\src\\utils.ts',
+  }`;
 
   expect(fileContent).toMatchInlineSnapshot(`
-    "use strict";
-    const a = "<ROOT>/node_modules/<PNPM_INNER>/@rslib/core/dist/index.js";
+    {
+          loader: '/d/Users/user/Documents/code/user/fe-dev-scripts/src/utils.ts',
+      }
   `);
 });
 
-test('should serialize webpack output content', () => {
-  const fileContent = `;// CONCATENATED MODULE: ../../../../node_modules/.pnpm/@[email protected]/node_modules/@swc/helpers/esm/_class_private_method_get.js
-function _class_private_method_get(receiver, privateSet, fn) {
-    if (!privateSet.has(receiver)) throw new TypeError("attempted to get private field on non-instance");
+test('transformWin32RelativePath', () => {
+  const case1 = `Cannot find file "..\\..\\getting-started\\next"`;
 
-    return fn;
-}
-`;
-
-  expect(fileContent).toMatchInlineSnapshot(`
-    ;// CONCATENATED MODULE: ../../../../node_modules/<PNPM_INNER>/@swc/helpers/esm/_class_private_method_get.js
-    function _class_private_method_get(receiver, privateSet, fn) {
-        if (!privateSet.has(receiver)) throw new TypeError("attempted to get private field on non-instance");
+  expect(case1).toMatchInlineSnapshot(
+    `Cannot find file "../../getting-started/next"`,
+  );
 
-        return fn;
-    }
-  `);
+  const case2 = `Cannot find file "..\\getting-started\\next"`;
+  expect(case2).toMatchInlineSnapshot(
+    `Cannot find file "../getting-started/next"`,
+  );
 });
 
-test('should serialize the Win32 path', () => {
-  const fileContent = `{
-      loader: 'D:\\Users\\user\\Documents\\code\\user\\fe-dev-scripts\\src\\utils.ts',
-  }`;
+describe('transformCLR', () => {
+  test('should transform the color', () => {
+    const input = '\u001b[1mBold Text\u001b[0m';
+    expect(input).toMatchInlineSnapshot('<CLR=BOLD>Bold Text<CLR=0>');
+  });
 
-  expect(fileContent).toMatchInlineSnapshot(`
-    {
-          loader: '/d/Users/user/Documents/code/user/fe-dev-scripts/src/utils.ts',
-      }
-  `);
+  test('bad case 1', () => {
+    const input = 'static/react.svg'; // bad case: 'static/reactXsvg'
+    expect(input).toMatchInlineSnapshot('static/react.svg');
+  });
 });

e2e/realworld.test.ts

@@ -0,0 +1,44 @@
+import path from 'node:path';
+import { createSnapshotSerializer } from 'path-serializer';
+import { expect } from 'vitest';
+import { test } from 'vitest';
+
+expect.addSnapshotSerializer(
+  createSnapshotSerializer({
+    root: path.resolve(__dirname, '..'),
+    features: {
+      escapeDoubleQuotes: false,
+      addDoubleQuotes: false,
+    },
+  }),
+);
+
+test('should serialize file content without escaping \\"', () => {
+  const fileContent = `"use strict";
+const a = "${require.resolve('@rslib/core')}";
+`;
+
+  expect(fileContent).toMatchInlineSnapshot(`
+    "use strict";
+    const a = "<ROOT>/node_modules/<PNPM_INNER>/@rslib/core/dist/index.js";
+  `);
+});
+
+test('should serialize webpack output content', () => {
+  const fileContent = `;// CONCATENATED MODULE: ../../../../node_modules/.pnpm/@[email protected]/node_modules/@swc/helpers/esm/_class_private_method_get.js
+function _class_private_method_get(receiver, privateSet, fn) {
+    if (!privateSet.has(receiver)) throw new TypeError("attempted to get private field on non-instance");
+
+    return fn;
+}
+`;
+
+  expect(fileContent).toMatchInlineSnapshot(`
+    ;// CONCATENATED MODULE: ../../../../node_modules/<PNPM_INNER>/@swc/helpers/esm/_class_private_method_get.js
+    function _class_private_method_get(receiver, privateSet, fn) {
+        if (!privateSet.has(receiver)) throw new TypeError("attempted to get private field on non-instance");
+
+        return fn;
+    }
+  `);
+});

e2e/transformCLR.test.ts

@@ -8,6 +8,7 @@ import {
   normalizeCLR,
   normalizeCodeToPosix,
   normalizePathToPosix,
+  normalizeWin32RelativePath,
 } from './normalize';
 import type { PathMatcher, SnapshotSerializerOptions } from './types';
 
@@ -37,6 +38,7 @@ export function createSnapshotSerializer(
     replaceHomeDir = true,
     addDoubleQuotes = true,
     transformWin32Path = true,
+    transformWin32RelativePath = true,
     escapeDoubleQuotes = true,
     escapeEOL = true,
     transformCLR = true,
@@ -87,6 +89,10 @@ export function createSnapshotSerializer(
         replaced = normalizeCodeToPosix(replaced);
       }
 
+      if (transformWin32RelativePath) {
+        replaced = normalizeWin32RelativePath(replaced);
+      }
+
       replaced = applyMatcherReplacement(pathMatchers, replaced);
 
       if (transformCLR) {

src/createSnapshotSerializer.ts

@@ -19,12 +19,25 @@ export const normalizeCodeToPosix = (code: string): string => {
   );
 };
 
+export function normalizeWin32RelativePath(p: string): string {
+  return p.replace(
+    /(['"`])(\.\.([\\/]))+([\w-]+\3)+[^\\/]*\1/g,
+    (match: string) => {
+      return match.replace(/\\/g, '/');
+    },
+  );
+}
+
 export const normalizeCLR = (str: string): string => {
   return (
     str
+      // biome-ignore lint/suspicious/noControlCharactersInRegex: copied code
       .replace(/\u001b\[1m\u001b\[([0-9;]*)m/g, '<CLR=$1,BOLD>')
+      // biome-ignore lint/suspicious/noControlCharactersInRegex: copied code
       .replace(/\u001b\[1m/g, '<CLR=BOLD>')
+      // biome-ignore lint/suspicious/noControlCharactersInRegex: copied code
       .replace(/\u001b\[39m\u001b\[22m/g, '</CLR>')
+      // biome-ignore lint/suspicious/noControlCharactersInRegex: copied code
       .replace(/\u001b\[([0-9;]*)m/g, '<CLR=$1>')
       // CHANGE: The time unit display in Rspack is second
       // CHANGE2: avoid a bad case "./react/assets.svg" -> "./react/assetsXsvg"

src/normalize.ts

@@ -43,6 +43,12 @@ export interface Features {
    * @default true
    */
   transformWin32Path?: boolean;
+  /**
+   * `..\..\getting-started\next`
+   * -> `../../getting-started/next`
+   * @default true
+   */
+  transformWin32RelativePath?: boolean;
   /**
    * "" -> \"\"
    * @default true