@rspack-debug/test-tools 1.3.14

package/dist/type.d.ts

@@ -0,0 +1,168 @@
+import type EventEmitter from "node:events";
+import type { Compiler as RspackCompiler, MultiStats as RspackMultiStats, RspackOptions, Stats as RspackStats, StatsCompilation as RspackStatsCompilation } from "@rspack/core";
+import type { Compiler as WebpackCompiler, MultiStats as WebpackMultiStats, Configuration as WebpackOptions, Stats as WebpackStats, StatsCompilation as WebpackStatsCompilation } from "webpack";
+import type { IBasicModuleScope, TRunnerRequirer } from "./runner/type";
+export interface ITestContext {
+    getSource(sub?: string): string;
+    getDist(sub?: string): string;
+    getTemp(sub?: string): string | null;
+    getCompiler<T extends ECompilerType>(name: string, type: T | void): ITestCompilerManager<T>;
+    getTestConfig<T extends ECompilerType>(): TTestConfig<T>;
+    getRunnerFactory<T extends ECompilerType>(name: string): TRunnerFactory<T> | null;
+    getRunner(key: string): ITestRunner | null;
+    setRunner(key: string, runner: ITestRunner): void;
+    setValue<T>(name: string, key: string, value: T): void;
+    getValue<T>(name: string, key: string): T | void;
+    getNames(): string[];
+    hasError(name?: string): boolean;
+    emitError(name: string, err: Error | string): void;
+    getError(name?: string): Error[];
+    clearError(name?: string): void;
+}
+export declare enum ECompilerType {
+    Rspack = "rspack",
+    Webpack = "webpack"
+}
+export type TCompilerOptions<T> = T extends ECompilerType.Rspack ? RspackOptions : WebpackOptions;
+export type TCompiler<T> = T extends ECompilerType.Rspack ? RspackCompiler : WebpackCompiler;
+export type TCompilerStats<T> = T extends ECompilerType.Rspack ? RspackStats : WebpackStats;
+export type TCompilerMultiStats<T> = T extends ECompilerType.Rspack ? RspackMultiStats : WebpackMultiStats;
+export type TCompilerStatsCompilation<T> = T extends ECompilerType.Rspack ? RspackStatsCompilation : WebpackStatsCompilation;
+export interface ITestCompilerManager<T extends ECompilerType> {
+    getOptions(): TCompilerOptions<T>;
+    setOptions(newOptions: TCompilerOptions<T>): TCompilerOptions<T>;
+    mergeOptions(newOptions: TCompilerOptions<T>): TCompilerOptions<T>;
+    getCompiler(): TCompiler<T> | null;
+    createCompiler(): TCompiler<T>;
+    build(): Promise<TCompilerStats<T>>;
+    watch(timeout?: number): void;
+    getStats(): TCompilerStats<T> | TCompilerMultiStats<T> | null;
+    getEmitter(): EventEmitter;
+    close(): Promise<void>;
+}
+export interface ITestLoader {
+    walk(): Promise<void>;
+}
+export type TTestRunResult = Record<string, any>;
+export interface ITesterConfig {
+    name: string;
+    src: string;
+    dist: string;
+    temp?: string;
+    steps?: ITestProcessor[];
+    testConfig?: TTestConfig<ECompilerType>;
+    compilerFactories?: TCompilerFactories;
+    contextValue?: Record<string, unknown>;
+    runnerFactory?: new (name: string, context: ITestContext) => TRunnerFactory<ECompilerType>;
+}
+export interface ITester {
+    step: number;
+    total: number;
+    getContext(): ITestContext;
+    prepare(): Promise<void>;
+    compile(): Promise<void>;
+    check(env: ITestEnv): Promise<void>;
+    next(): boolean;
+    resume(): Promise<void>;
+}
+export interface ITestProcessor {
+    beforeAll?(context: ITestContext): Promise<void>;
+    afterAll?(context: ITestContext): Promise<void>;
+    before?(context: ITestContext): Promise<void>;
+    after?(context: ITestContext): Promise<void>;
+    config?(context: ITestContext): Promise<void>;
+    compiler?(context: ITestContext): Promise<void>;
+    build?(context: ITestContext): Promise<void>;
+    run?(env: ITestEnv, context: ITestContext): Promise<void>;
+    check?(env: ITestEnv, context: ITestContext): Promise<unknown>;
+}
+export interface ITestReporter<T> {
+    init(data?: T): Promise<void>;
+    increment(id: string, data: T): Promise<void>;
+    failure(id: string): Promise<void>;
+    output(): Promise<void>;
+}
+export declare enum ECompareResultType {
+    Same = "same",
+    Missing = "missing",
+    OnlyDist = "only-dist",
+    OnlySource = "only-source",
+    Different = "different"
+}
+export type TCompareModules = string[] | true;
+export type TCompareResult = {
+    type: ECompareResultType;
+    detail?: unknown;
+    source?: string;
+    dist?: string;
+    lines?: {
+        common: number;
+        source: number;
+        dist: number;
+    };
+};
+export type TModuleCompareResult = TCompareResult & {
+    name: string;
+};
+export type TFileCompareResult = TCompareResult & {
+    file: {
+        source: string;
+        dist: string;
+    };
+    modules: Partial<Record<"modules" | "runtimeModules", TModuleCompareResult[]>>;
+};
+export type TDiffStatsItem = {
+    name: string;
+    source: string;
+    dist: string;
+    type: ECompareResultType;
+};
+export type TDiffStats = {
+    root: string;
+    data: Array<TDiffStatsItem>;
+};
+export interface ITestEnv {
+    expect: jest.Expect;
+    it: (...args: any[]) => void;
+    beforeEach: (...args: any[]) => void;
+    afterEach: (...args: any[]) => void;
+    [key: string]: unknown;
+}
+export declare enum EDocumentType {
+    Fake = "fake",
+    JSDOM = "jsdom"
+}
+export type TTestConfig<T extends ECompilerType> = {
+    documentType?: EDocumentType;
+    validate?: (stats: TCompilerStats<T> | TCompilerMultiStats<T>, stderr?: string) => void;
+    noTest?: boolean;
+    writeStatsOuptut?: boolean;
+    writeStatsJson?: boolean;
+    beforeExecute?: () => void;
+    afterExecute?: () => void;
+    moduleScope?: (ms: IBasicModuleScope, stats?: TCompilerStatsCompilation<T>) => IBasicModuleScope;
+    checkStats?: (stepName: string, jsonStats: TCompilerStatsCompilation<T> | undefined, stringStats: String) => boolean;
+    findBundle?: (index: number, options: TCompilerOptions<T>, stepName?: string) => string | string[];
+    bundlePath?: string[];
+    nonEsmThis?: (p: string | string[]) => Object;
+    modules?: Record<string, Object>;
+    timeout?: number;
+    concurrent?: boolean;
+    checkSteps?: boolean;
+};
+export type TTestFilter<T extends ECompilerType> = (creatorConfig: Record<string, unknown>, testConfig: TTestConfig<T>) => boolean | string;
+export interface ITestRunner {
+    run(file: string): Promise<unknown>;
+    getRequire(): TRunnerRequirer;
+    getGlobal(name: string): unknown;
+}
+export type TCompilerFactory<T extends ECompilerType> = (options: TCompilerOptions<T> | TCompilerOptions<T>[]) => TCompiler<T>;
+export interface TRunnerFactory<T extends ECompilerType> {
+    create(file: string, compilerOptions: TCompilerOptions<T>, env: ITestEnv): ITestRunner;
+}
+export type TUpdateOptions = {
+    updateIndex: number;
+    totalUpdates: number;
+    changedFiles: string[];
+};
+export type TCompilerFactories = Record<ECompilerType, TCompilerFactory<ECompilerType>>;

package/dist/type.js

@@ -0,0 +1,22 @@
+"use strict";
+/// <reference types="../jest.d.ts" />
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EDocumentType = exports.ECompareResultType = exports.ECompilerType = void 0;
+var ECompilerType;
+(function (ECompilerType) {
+    ECompilerType["Rspack"] = "rspack";
+    ECompilerType["Webpack"] = "webpack";
+})(ECompilerType || (exports.ECompilerType = ECompilerType = {}));
+var ECompareResultType;
+(function (ECompareResultType) {
+    ECompareResultType["Same"] = "same";
+    ECompareResultType["Missing"] = "missing";
+    ECompareResultType["OnlyDist"] = "only-dist";
+    ECompareResultType["OnlySource"] = "only-source";
+    ECompareResultType["Different"] = "different";
+})(ECompareResultType || (exports.ECompareResultType = ECompareResultType = {}));
+var EDocumentType;
+(function (EDocumentType) {
+    EDocumentType["Fake"] = "fake";
+    EDocumentType["JSDOM"] = "jsdom";
+})(EDocumentType || (exports.EDocumentType = EDocumentType = {}));

package/jest.d.ts

@@ -0,0 +1,25 @@
+/// <reference types="jest" />
+
+import type { DiffOptions } from "jest-diff";
+
+declare interface FileMatcherOptions {
+	diff?: DiffOptions;
+}
+
+declare global {
+	namespace jest {
+		interface Matchers<R, T> {
+			toMatchFileSnapshot: (
+				filename?: string,
+				options?: FileMatcherOptions
+			) => void;
+		}
+
+		interface Expect {
+			toMatchFileSnapshot: (
+				filename?: string,
+				options?: FileMatcherOptions
+			) => void;
+		}
+	}
+}

package/package.json

@@ -0,0 +1,116 @@
+{
+  "name": "@rspack-debug/test-tools",
+  "version": "1.3.14",
+  "license": "MIT",
+  "description": "Test tools for rspack",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "default": "./dist/index.js"
+    },
+    "./setup-expect": "./dist/helper/setup-expect.js",
+    "./setup-env": "./dist/helper/setup-env.js",
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "client",
+    "dist",
+    "template",
+    "jest.d.ts"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "homepage": "https://rspack.rs",
+  "bugs": "https://github.com/web-infra-dev/rspack/issues",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/web-infra-dev/rspack",
+    "directory": "packages/rspack-test-tools"
+  },
+  "dependencies": {
+    "@babel/generator": "7.27.5",
+    "@babel/parser": "7.27.5",
+    "@babel/traverse": "7.27.4",
+    "@babel/types": "7.27.3",
+    "cross-env": "^7.0.3",
+    "csv-to-markdown-table": "^1.5.0",
+    "deepmerge": "^4.3.1",
+    "filenamify": "4.3.0",
+    "fs-extra": "^11.3.0",
+    "glob": "^11.0.2",
+    "graceful-fs": "^4.2.11",
+    "iconv-lite": "^0.6.3",
+    "jest-diff": "^29.7.0",
+    "jest-snapshot": "29.7.0",
+    "jsdom": "^26.1.0",
+    "memfs": "4.17.2",
+    "loader-utils": "^2.0.4",
+    "path-serializer": "0.4.0",
+    "pretty-format": "29.7.0",
+    "rimraf": "^5.0.10",
+    "source-map": "^0.7.4",
+    "terser-webpack-plugin": "^5.3.14",
+    "webpack": "5.99.9",
+    "webpack-merge": "6.0.1",
+    "webpack-sources": "3.3.0"
+  },
+  "devDependencies": {
+    "@rspack/plugin-preact-refresh": "1.1.2",
+    "@rspack/plugin-react-refresh": "^1.4.3",
+    "@swc/helpers": "0.5.17",
+    "@swc/plugin-remove-console": "^7.0.4",
+    "@types/babel__generator": "7.27.0",
+    "@types/babel__traverse": "7.20.7",
+    "@types/fs-extra": "11.0.4",
+    "@types/jsdom": "^21.1.7",
+    "@types/react": "^19.1.6",
+    "@types/react-dom": "^19.1.5",
+    "@webdiscus/pug-loader": "^2.11.1",
+    "acorn": "^8.14.1",
+    "babel-loader": "^10.0.0",
+    "babel-plugin-import": "^1.13.8",
+    "chalk": "^4.1.2",
+    "core-js": "3.42.0",
+    "css-loader": "^7.1.2",
+    "file-loader": "^6.2.0",
+    "graceful-fs": "^4.2.11",
+    "html-loader": "^5.1.0",
+    "html-webpack-plugin": "^5.6.3",
+    "less-loader": "^12.3.0",
+    "lodash": "^4.17.21",
+    "postcss-loader": "^8.1.1",
+    "postcss-pxtorem": "^6.1.0",
+    "raw-loader": "^4.0.2",
+    "react": "^19.1.0",
+    "react-dom": "^19.1.0",
+    "react-refresh": "^0.17.0",
+    "sass-loader": "^16.0.5",
+    "source-map": "^0.7.4",
+    "source-map-loader": "^5.0.0",
+    "style-loader": "^4.0.0",
+    "terser": "5.40.0",
+    "typescript": "^5.8.3",
+    "wast-loader": "^1.14.1",
+    "worker-rspack-loader": "^3.1.2",
+    "@rspack/cli": "npm:@rspack-debug/cli@1.3.14",
+    "@rspack/core": "npm:@rspack-debug/core@1.3.14",
+    "@rspack/test-tools": "npm:@rspack-debug/test-tools@1.3.14"
+  },
+  "peerDependencies": {
+    "@rspack/core": ">=1.0.0"
+  },
+  "scripts": {
+    "build": "tsc -b ./tsconfig.build.json",
+    "dev": "tsc -b -w",
+    "test": "cross-env RUST_BACKTRACE=full pnpm run --stream /^test:.*/",
+    "testu": "pnpm run --stream /^test:.*/ -u",
+    "test:base": "cross-env node --no-warnings --expose-gc --max-old-space-size=8192 --experimental-vm-modules ../../node_modules/jest-cli/bin/jest --logHeapUsage --colors --config ./jest.config.js --passWithNoTests",
+    "test:hot": "cross-env RSPACK_HOT_TEST=true node --no-warnings --expose-gc --max-old-space-size=8192 --experimental-vm-modules ../../node_modules/jest-cli/bin/jest --logHeapUsage --colors --config ./jest.config.hot.js --passWithNoTests",
+    "test:diff": "cross-env RSPACK_DIFF=true node --no-warnings --expose-gc --max-old-space-size=8192 --experimental-vm-modules ../../node_modules/jest-cli/bin/jest --logHeapUsage --colors --config ./jest.config.diff.js --passWithNoTests",
+    "api-extractor": "api-extractor run --verbose",
+    "api-extractor:ci": "api-extractor run --verbose || diff temp/test-tools.api.md etc/test-tools.api.md"
+  }
+}