@rspack/test-tools 1.1.5 → 1.1.8

package/dist/helper/expect/placeholder.d.ts

@@ -1 +1 @@
-export declare const normalizePlaceholder: any;
+export declare const normalizePlaceholder: (val: any) => string;

package/dist/helper/expect/placeholder.js

@@ -5,17 +5,20 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.normalizePlaceholder = void 0;
 const node_path_1 = __importDefault(require("node:path"));
-const { createSnapshotSerializer } = require("path-serializer");
-const placeholderSerializer = createSnapshotSerializer({
-    workspace: node_path_1.default.resolve(__dirname, "../../../../../"),
+const path_serializer_1 = require("path-serializer");
+// 1. escapeEOL \r\n -> \n
+// 2. replace <RSPACK_ROOT> etc
+// 3. transform win32 sep
+const placeholderSerializer = (0, path_serializer_1.createSnapshotSerializer)({
+    root: node_path_1.default.resolve(__dirname, "../../../../../"),
     replace: [
         {
-            match: node_path_1.default.resolve(__dirname, "../../../rspack"),
-            mark: "rspack"
+            match: node_path_1.default.resolve(__dirname, "../../../"),
+            mark: "test_tools_root"
         },
         {
-            match: node_path_1.default.resolve(__dirname, "../../"),
-            mark: "test_tools"
+            match: node_path_1.default.resolve(__dirname, "../../../../rspack"),
+            mark: "rspack_root"
         },
         {
             match: /:\d+:\d+-\d+:\d+/g,
@@ -27,8 +30,9 @@ const placeholderSerializer = createSnapshotSerializer({
         }
     ],
     features: {
+        replaceWorkspace: false,
         addDoubleQuotes: false,
-        ansiDoubleQuotes: false
+        escapeDoubleQuotes: false
     }
 });
 exports.normalizePlaceholder = placeholderSerializer.serialize;

package/dist/helper/index.d.ts

@@ -3,5 +3,4 @@ export * from "./parse-modules";
 export * from "./read-config-file";
 export * from "./update-snapshot";
 export * from "./win";
-export * from "./replace-paths";
 export * from "./util/checkStats";

package/dist/helper/index.js

@@ -19,5 +19,4 @@ __exportStar(require("./parse-modules"), exports);
 __exportStar(require("./read-config-file"), exports);
 __exportStar(require("./update-snapshot"), exports);
 __exportStar(require("./win"), exports);
-__exportStar(require("./replace-paths"), exports);
 __exportStar(require("./util/checkStats"), exports);

package/dist/helper/setup-expect.js

@@ -1,6 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const char_1 = require("./expect/char");
 const diff_1 = require("./expect/diff");
 const error_1 = require("./expect/error");
 const placeholder_1 = require("./expect/placeholder");
@@ -8,7 +7,6 @@ const rspack_1 = require("./expect/rspack");
 const to_be_typeof_1 = require("./expect/to-be-typeof");
 const to_end_with_1 = require("./expect/to-end-with");
 const to_match_file_snapshot_1 = require("./expect/to-match-file-snapshot");
-const { normalizePaths } = require("jest-serializer-path");
 expect.extend({
     // CHANGE: new test matcher for `rspack-test-tools`
     // @ts-ignore
@@ -16,20 +14,12 @@ expect.extend({
     toBeTypeOf: to_be_typeof_1.toBeTypeOf,
     toEndWith: to_end_with_1.toEndWith
 });
-const pipes = [
-    char_1.normalizeSlash,
-    char_1.normalizeCLR,
-    char_1.normalizeCRLF,
-    placeholder_1.normalizePlaceholder,
-    normalizePaths
-];
-const serialize = (str, extra = []) => [...pipes, ...extra].reduce((res, transform) => transform(res), str);
 expect.addSnapshotSerializer({
     test(received) {
         return typeof received === "string";
     },
     print(received) {
-        return serialize(received.trim());
+        return (0, placeholder_1.normalizePlaceholder)(received.trim());
     }
 });
 // for diff

package/dist/helper/win.d.ts

@@ -1,2 +1 @@
 export declare function escapeSep(str: string): string;
-export declare function escapeEOL(str: string): string;

package/dist/helper/win.js

@@ -4,11 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.escapeSep = escapeSep;
-exports.escapeEOL = escapeEOL;
 const node_path_1 = __importDefault(require("node:path"));
 function escapeSep(str) {
     return str.split(node_path_1.default.win32.sep).join(node_path_1.default.posix.sep);
 }
-function escapeEOL(str) {
-    return str.split("\r\n").join("\n").trim();
-}

package/dist/processor/diagnostic.js

@@ -6,8 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.DiagnosticProcessor = void 0;
 const node_assert_1 = __importDefault(require("node:assert"));
 const node_path_1 = __importDefault(require("node:path"));
-const helper_1 = require("../helper");
-const replace_paths_1 = require("../helper/replace-paths");
+const placeholder_1 = require("../helper/expect/placeholder");
 const basic_1 = require("./basic");
 class DiagnosticProcessor extends basic_1.BasicProcessor {
     constructor(_diagnosticOptions) {
@@ -25,16 +24,16 @@ class DiagnosticProcessor extends basic_1.BasicProcessor {
             throw new Error("Stats should exists");
         }
         (0, node_assert_1.default)(stats.hasErrors() || stats.hasWarnings());
-        let output = (0, replace_paths_1.replacePaths)(stats.toString({
+        let output = (0, placeholder_1.normalizePlaceholder)(stats.toString({
             all: false,
             errors: true,
             warnings: true
-        }));
+        })).replaceAll("\\", "/"); // stats has some win32 paths that path-serializer can not handle
         if (typeof this._diagnosticOptions.format === "function") {
             output = this._diagnosticOptions.format(output);
         }
         const errorOutputPath = node_path_1.default.resolve(context.getSource(this._diagnosticOptions.snapshot));
-        env.expect((0, helper_1.escapeEOL)(output)).toMatchFileSnapshot(errorOutputPath);
+        env.expect(output).toMatchFileSnapshot(errorOutputPath);
     }
     static defaultOptions(context) {
         return {

package/dist/processor/hook.js

@@ -8,10 +8,9 @@ const node_path_1 = __importDefault(require("node:path"));
 const core_1 = require("@rspack/core");
 const jest_snapshot_1 = require("jest-snapshot");
 const pretty_format_1 = require("pretty-format");
+const path_serializer_1 = require("path-serializer");
 const context_1 = require("../test/context");
 const snapshot_1 = require("./snapshot");
-const pathSerializer = require("jest-serializer-path");
-const normalizePaths = pathSerializer.normalizePaths;
 const srcDir = node_path_1.default.resolve(__dirname, "../../tests/fixtures");
 const distDir = node_path_1.default.resolve(__dirname, "../../tests/js/hook");
 const sourceSerializer = {
@@ -30,20 +29,18 @@ const internalSerializer = {
         return JSON.stringify(`${val.constructor.name}(internal ignored)`);
     }
 };
-const testPathSerializer = {
-    test(val) {
-        return typeof val === "string";
-    },
-    print(val) {
-        return JSON.stringify(normalizePaths(
-        // @ts-ignore
-        val
-            .split(srcDir)
-            .join("<HOOK_SRC_DIR>")
-            .split(distDir)
-            .join("<HOOK_DIST_DIR>")));
-    }
-};
+const testPathSerializer = (0, path_serializer_1.createSnapshotSerializer)({
+    replace: [
+        {
+            match: srcDir,
+            mark: "<HOOK_SRC_DIR>"
+        },
+        {
+            match: distDir,
+            mark: "<HOOK_DIST_DIR>"
+        }
+    ]
+});
 const escapeRegex = true;
 const printFunctionName = false;
 const normalizeNewlines = (str) => str.replace(/\r\n|\r/g, "\n");

package/dist/processor/hot-step.js

@@ -6,7 +6,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.HotSnapshotProcessor = void 0;
 const node_path_1 = __importDefault(require("node:path"));
 const fs_extra_1 = __importDefault(require("fs-extra"));
-const helper_1 = require("../helper");
+const placeholder_1 = require("../helper/expect/placeholder");
+const win_1 = require("../helper/win");
 const hot_1 = require("./hot");
 const NOOP_SET = new Set();
 const escapeLocalName = (str) => str.split(/[-<>:"/|?*.]/).join("_");
@@ -110,7 +111,7 @@ class HotSnapshotProcessor extends hot_1.HotProcessor {
         const title = `Case ${node_path_1.default.basename(this._options.name)}: Step ${step}`;
         const hotUpdateFile = [];
         const hotUpdateManifest = [];
-        const changedFiles = this.updateOptions.changedFiles.map((i) => (0, helper_1.escapeSep)(node_path_1.default.relative(context.getSource(), i)));
+        const changedFiles = this.updateOptions.changedFiles.map((i) => (0, win_1.escapeSep)(node_path_1.default.relative(context.getSource(), i)));
         changedFiles.sort();
         const hashes = {
             [lastHash || "LAST_HASH"]: "LAST_HASH",
@@ -134,7 +135,7 @@ class HotSnapshotProcessor extends hot_1.HotProcessor {
             }
         }
         const replaceContent = (str) => {
-            return (0, helper_1.replacePaths)(Object.entries(hashes)
+            return (0, placeholder_1.normalizePlaceholder)(Object.entries(hashes)
                 .reduce((str, [raw, replacement]) => {
                 return str.split(raw).join(replacement);
             }, str)
@@ -286,7 +287,7 @@ ${runtime.javascript.disposedModules.map(i => `- ${i}`).join("\n")}
             : ""}
 
 				`.trim();
-        env.expect((0, helper_1.escapeEOL)(content)).toMatchFileSnapshot(snapshotPath);
+        env.expect(content).toMatchFileSnapshot(snapshotPath);
     }
 }
 exports.HotSnapshotProcessor = HotSnapshotProcessor;

package/dist/processor/snapshot.d.ts

@@ -8,4 +8,5 @@ export declare class SnapshotProcessor<T extends ECompilerType> extends BasicPro
     protected _snapshotOptions: ISnapshotProcessorOptions<T>;
     constructor(_snapshotOptions: ISnapshotProcessorOptions<T>);
     check(env: ITestEnv, context: ITestContext): Promise<void>;
+    serializeEachFile(content: string): string;
 }

package/dist/processor/snapshot.js

@@ -5,7 +5,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SnapshotProcessor = void 0;
 const node_path_1 = __importDefault(require("node:path"));
-const helper_1 = require("../helper");
 const basic_1 = require("./basic");
 class SnapshotProcessor extends basic_1.BasicProcessor {
     constructor(_snapshotOptions) {
@@ -35,16 +34,18 @@ class SnapshotProcessor extends basic_1.BasicProcessor {
             .filter(([file]) => snapshotFileFilter(file))
             .map(([file, source]) => {
             const tag = node_path_1.default.extname(file).slice(1) || "txt";
-            return `\`\`\`${tag} title=${file}\n${source
-                .source()
-                .toString()}\n\`\`\``;
+            const content = this.serializeEachFile(source.source().toString());
+            return `\`\`\`${tag} title=${file}\n${content}\n\`\`\``;
         });
         fileContents.sort();
-        const content = (0, helper_1.escapeEOL)(fileContents.join("\n\n"));
+        const content = fileContents.join("\n\n");
         const snapshotPath = node_path_1.default.isAbsolute(this._snapshotOptions.snapshot)
             ? this._snapshotOptions.snapshot
             : node_path_1.default.resolve(context.getSource(), `./__snapshots__/${this._snapshotOptions.snapshot}`);
         env.expect(content).toMatchFileSnapshot(snapshotPath);
     }
+    serializeEachFile(content) {
+        return content;
+    }
 }
 exports.SnapshotProcessor = SnapshotProcessor;

package/dist/processor/stats.js

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.StatsProcessor = void 0;
 const node_fs_1 = __importDefault(require("node:fs"));
 const node_path_1 = __importDefault(require("node:path"));
-const helper_1 = require("../helper");
+const placeholder_1 = require("../helper/expect/placeholder");
 const captureStdio_1 = __importDefault(require("../helper/legacy/captureStdio"));
 const multi_1 = require("./multi");
 const REG_ERROR_CASE = /error$/;
@@ -51,7 +51,7 @@ class StatsProcessor extends multi_1.MultiTaskProcessor {
                             return callback(err);
                         if (!/\.(js|json|txt)$/.test(args[0]))
                             return callback(null, result);
-                        callback(null, (0, helper_1.escapeEOL)(result.toString("utf-8")));
+                        callback(null, (0, placeholder_1.normalizePlaceholder)(result.toString("utf-8")));
                     }
                 ]));
             };

package/dist/processor/treeshaking.d.ts

@@ -6,4 +6,5 @@ export declare class TreeShakingProcessor<T extends ECompilerType> extends Snaps
     protected _treeShakingOptions: ITreeShakingProcessorOptions<T>;
     constructor(_treeShakingOptions: ITreeShakingProcessorOptions<T>);
     static overrideOptions<T extends ECompilerType>(context: ITestContext, options: TCompilerOptions<T>): void;
+    serializeEachFile(content: string): string;
 }

package/dist/processor/treeshaking.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TreeShakingProcessor = void 0;
+const placeholder_1 = require("../helper/expect/placeholder");
 const builtin_1 = require("./builtin");
 const snapshot_1 = require("./snapshot");
 class TreeShakingProcessor extends snapshot_1.SnapshotProcessor {
@@ -20,5 +21,8 @@ class TreeShakingProcessor extends snapshot_1.SnapshotProcessor {
         options.optimization.innerGraph = true;
         options.optimization.usedExports = true;
     }
+    serializeEachFile(content) {
+        return (0, placeholder_1.normalizePlaceholder)(content);
+    }
 }
 exports.TreeShakingProcessor = TreeShakingProcessor;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rspack/test-tools",
-  "version": "1.1.5",
+  "version": "1.1.8",
   "license": "MIT",
   "description": "Test tools for rspack",
   "main": "dist/index.js",
@@ -37,18 +37,18 @@
     "@babel/template": "7.22.15",
     "@babel/traverse": "7.23.2",
     "@babel/types": "7.23.0",
+    "cross-env": "^7.0.3",
     "csv-to-markdown-table": "^1.3.0",
     "deepmerge": "^4.3.1",
     "filenamify": "4.3.0",
     "fs-extra": "^11.2.0",
     "glob": "^10.3.10",
     "jest-diff": "^29.7.0",
-    "jest-serializer-path": "^0.1.15",
     "jest-snapshot": "29.7.0",
     "jsdom": "^25.0.0",
     "memfs": "4.14.0",
     "mkdirp": "0.5.6",
-    "path-serializer": "0.1.2",
+    "path-serializer": "0.3.4",
     "pretty-format": "29.7.0",
     "rimraf": "3.0.2",
     "webpack": "^5.94.0",
@@ -102,8 +102,8 @@
     "typescript": "^5.6.3",
     "wast-loader": "^1.12.1",
     "worker-rspack-loader": "^3.1.2",
-    "@rspack/cli": "1.1.5",
-    "@rspack/core": "1.1.5"
+    "@rspack/cli": "1.1.8",
+    "@rspack/core": "1.1.8"
   },
   "peerDependencies": {
     "@rspack/core": ">=1.0.0"

package/dist/helper/expect/char.d.ts

@@ -1,4 +0,0 @@
-export declare const normalizeCRLF: (str: string) => string;
-export declare const normalizeCLR: (str: string) => string;
-export declare const normalizeColor: (str: string) => string;
-export declare const normalizeSlash: (str: string) => string;

package/dist/helper/expect/char.js

@@ -1,25 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.normalizeSlash = exports.normalizeColor = exports.normalizeCLR = exports.normalizeCRLF = void 0;
-const normalizeCRLF = (str) => {
-    return str.replace(/\r\n?/g, "\n");
-};
-exports.normalizeCRLF = normalizeCRLF;
-const normalizeCLR = (str) => {
-    return (str
-        .replace(/\u001b\[1m\u001b\[([0-9;]*)m/g, "<CLR=$1,BOLD>")
-        .replace(/\u001b\[1m/g, "<CLR=BOLD>")
-        .replace(/\u001b\[39m\u001b\[22m/g, "</CLR>")
-        .replace(/\u001b\[([0-9;]*)m/g, "<CLR=$1>")
-        // CHANGE: The time unit display in Rspack is second
-        .replace(/[.0-9]+(<\/CLR>)?(\s?s)/g, "X$1$2"));
-};
-exports.normalizeCLR = normalizeCLR;
-const normalizeColor = (str) => {
-    return str.replace(/\u001b\[[0-9;]*m/g, "");
-};
-exports.normalizeColor = normalizeColor;
-const normalizeSlash = (str) => {
-    return str.replace(/(\\)+/g, "/");
-};
-exports.normalizeSlash = normalizeSlash;

package/dist/helper/replace-paths.d.ts

@@ -1 +0,0 @@
-export declare function replacePaths(input: string): any;

package/dist/helper/replace-paths.js

@@ -1,24 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.replacePaths = replacePaths;
-const node_os_1 = __importDefault(require("node:os"));
-const node_path_1 = __importDefault(require("node:path"));
-const serializer = require("jest-serializer-path");
-const normalizePaths = serializer.normalizePaths;
-const rspackPath = node_path_1.default.resolve(__dirname, "../../../rspack");
-function replacePaths(input) {
-    const paths = input.split("\\\\").join("\\");
-    const rspackRoot = normalizePaths(rspackPath);
-    if (node_os_1.default.platform() === "win32") {
-        const winRspackRoot = rspackRoot.split("\\\\").join(node_path_1.default.win32.sep);
-        return normalizePaths(paths)
-            .split(rspackRoot)
-            .join("<RSPACK_ROOT>")
-            .split(winRspackRoot)
-            .join("<RSPACK_ROOT>");
-    }
-    return normalizePaths(paths).split(rspackRoot).join("<RSPACK_ROOT>");
-}