@rstest/core 0.5.0 → 0.5.2

package/dist-types/index.d.ts

@@ -1,4 +1,5 @@
 import type { assert as assert_2 } from 'chai';
+import { LoadConfigOptions } from '@rsbuild/core';
 import type { RsbuildConfig } from '@rsbuild/core';
 import type { RsbuildPlugin } from '@rsbuild/core';
 
@@ -304,6 +305,35 @@ declare interface Colors {
         	};
 }
 
+declare type CommonOptions = {
+    root?: string;
+    config?: string;
+    configLoader?: LoadConfigOptions['loader'];
+    globals?: boolean;
+    isolate?: boolean;
+    include?: string[];
+    exclude?: string[];
+    reporter?: string[];
+    project?: string[];
+    coverage?: boolean;
+    passWithNoTests?: boolean;
+    printConsoleTrace?: boolean;
+    disableConsoleIntercept?: boolean;
+    update?: boolean;
+    testNamePattern?: RegExp | string;
+    testTimeout?: number;
+    hookTimeout?: number;
+    testEnvironment?: string;
+    clearMocks?: boolean;
+    resetMocks?: boolean;
+    restoreMocks?: boolean;
+    unstubGlobals?: boolean;
+    unstubEnvs?: boolean;
+    retry?: number;
+    maxConcurrency?: number;
+    slowTestThreshold?: number;
+};
+
 declare type CompareKeys = ((a: string, b: string) => number) | null | undefined;
 
 declare interface Config {
@@ -415,6 +445,11 @@ export declare type CoverageOptions = {
      * @default undefined
      */
     thresholds?: CoverageThresholds;
+    /**
+     * Whether to report coverage when tests fail.
+     * @default false
+     */
+    reportOnFailure?: boolean;
 };
 
 export declare class CoverageProvider {
@@ -489,6 +524,12 @@ declare type CoverageThresholds = CoverageThreshold | (CoverageThreshold & {
     };
 });
 
+export declare function createRstest({ config, projects, configFilePath, }: {
+    config: RstestConfig;
+    configFilePath?: string;
+    projects: Project[];
+}, command: RstestCommand, fileFilters: string[]): RstestInstance;
+
 declare interface CustomMatcher {
     	/**
      	* Checks that a value satisfies a custom matcher function.
@@ -844,7 +885,7 @@ declare function getMatcherUtils(): {
     	printWithType: typeof printWithType
 };
 
-declare type GetSourcemap = (sourcePath: string) => SourceMapInput | null;
+declare type GetSourcemap = (sourcePath: string) => Promise<SourceMapInput | null>;
 
 declare class GithubActionsReporter {
     private onWritePath;
@@ -879,6 +920,12 @@ declare interface HtmlSpaOptions extends HtmlOptions {
 
 declare type Indent = (arg0: string) => string;
 
+export declare function initCli(options: CommonOptions): Promise<{
+    config: RstestConfig;
+    configFilePath?: string;
+    projects: Project[];
+}>;
+
 declare interface InlineSnapshotMatcher<T> {
     <U extends {
         [P in keyof T]: any;
@@ -1313,6 +1360,21 @@ declare interface LinkMapper {
     assetPath(node: Node_2, name: string): string;
 }
 
+declare type ListCommandOptions = {
+    filesOnly?: boolean;
+    json?: boolean | string;
+};
+
+export declare function loadConfig({ cwd, path, envMode, configLoader, }: {
+    cwd?: string;
+    path?: string;
+    envMode?: string;
+    configLoader?: LoadConfigOptions['loader'];
+}): Promise<{
+    content: RstestConfig;
+    filePath: string | null;
+}>;
+
 declare interface Location_2 {
     line: number;
     column: number;
@@ -1928,6 +1990,11 @@ declare type Procedure = (...args: any[]) => any;
 
 declare type Procedure_2 = (...args: any[]) => any;
 
+declare type Project = {
+    config: RstestConfig;
+    configFilePath?: string;
+};
+
 export declare type ProjectConfig = Omit<RstestConfig, 'projects' | 'reporters' | 'pool' | 'isolate' | 'coverage'>;
 
 declare type ProjectContext = {
@@ -2212,6 +2279,12 @@ export declare interface RstestConfig {
      * Custom handler for console log in tests
      */
     onConsoleLog?: (content: string) => boolean | void;
+    /** Format snapshot output */
+    snapshotFormat?: SnapshotFormat;
+    /**
+     * Custom environment variables available on `process.env` during tests.
+     */
+    env?: Partial<NodeJS.ProcessEnv>;
     /**
      * Coverage options
      */
@@ -2262,6 +2335,12 @@ declare type RstestContext = {
 
 declare type RstestExpect = ExpectStatic;
 
+declare type RstestInstance = {
+    context: RstestContext;
+    runTests: () => Promise<void>;
+    listTests: (options: ListCommandOptions) => Promise<void>;
+};
+
 declare type RstestPoolOptions = {
     /** Pool used to run tests in. */
     type?: RstestPoolType;
@@ -2413,7 +2492,7 @@ declare type RunnerAPI = {
     onTestFailed: (fn: OnTestFailedHandler, timeout?: number) => void;
 };
 
-declare type RuntimeConfig = Pick<RstestContext['normalizedConfig'], 'testTimeout' | 'testNamePattern' | 'globals' | 'passWithNoTests' | 'retry' | 'clearMocks' | 'resetMocks' | 'restoreMocks' | 'unstubEnvs' | 'unstubGlobals' | 'maxConcurrency' | 'printConsoleTrace' | 'disableConsoleIntercept' | 'testEnvironment' | 'isolate' | 'hookTimeout' | 'coverage'>;
+declare type RuntimeConfig = Pick<RstestContext['normalizedConfig'], 'testTimeout' | 'testNamePattern' | 'globals' | 'passWithNoTests' | 'retry' | 'clearMocks' | 'resetMocks' | 'restoreMocks' | 'unstubEnvs' | 'unstubGlobals' | 'maxConcurrency' | 'printConsoleTrace' | 'disableConsoleIntercept' | 'testEnvironment' | 'isolate' | 'hookTimeout' | 'coverage' | 'snapshotFormat' | 'env'>;
 
 declare type RuntimeOptions = Partial<Pick<RuntimeConfig, 'testTimeout' | 'hookTimeout' | 'clearMocks' | 'resetMocks' | 'restoreMocks' | 'maxConcurrency' | 'retry'>>;
 
@@ -2433,6 +2512,8 @@ declare interface SnapshotEnvironment {
     	processStackTrace?: (stack: ParsedStack) => ParsedStack;
 }
 
+declare type SnapshotFormat = Omit<NonNullable<SnapshotStateOptions['snapshotFormat']>, 'plugins' | 'compareKeys'>;
+
 declare class SnapshotManager {
     	options: Omit<SnapshotStateOptions, "snapshotEnvironment">;
     	summary: SnapshotSummary;

package/dist-types/worker.d.ts

@@ -391,6 +391,11 @@ declare type CoverageOptions = {
      * @default undefined
      */
     thresholds?: CoverageThresholds;
+    /**
+     * Whether to report coverage when tests fail.
+     * @default false
+     */
+    reportOnFailure?: boolean;
 };
 
 declare class CoverageSummary {
@@ -725,7 +730,7 @@ declare function getMatcherUtils(): {
     	printWithType: typeof printWithType
 };
 
-declare type GetSourcemap = (sourcePath: string) => SourceMapInput | null;
+declare type GetSourcemap = (sourcePath: string) => Promise<SourceMapInput | null>;
 
 declare class GithubActionsReporter {
     private onWritePath;
@@ -1930,6 +1935,12 @@ declare interface RstestConfig {
      * Custom handler for console log in tests
      */
     onConsoleLog?: (content: string) => boolean | void;
+    /** Format snapshot output */
+    snapshotFormat?: SnapshotFormat;
+    /**
+     * Custom environment variables available on `process.env` during tests.
+     */
+    env?: Partial<NodeJS.ProcessEnv>;
     /**
      * Coverage options
      */
@@ -2005,12 +2016,15 @@ declare type RunnerAPI = {
     onTestFailed: (fn: OnTestFailedHandler, timeout?: number) => void;
 };
 
-declare type RuntimeConfig = Pick<RstestContext['normalizedConfig'], 'testTimeout' | 'testNamePattern' | 'globals' | 'passWithNoTests' | 'retry' | 'clearMocks' | 'resetMocks' | 'restoreMocks' | 'unstubEnvs' | 'unstubGlobals' | 'maxConcurrency' | 'printConsoleTrace' | 'disableConsoleIntercept' | 'testEnvironment' | 'isolate' | 'hookTimeout' | 'coverage'>;
+declare type RuntimeConfig = Pick<RstestContext['normalizedConfig'], 'testTimeout' | 'testNamePattern' | 'globals' | 'passWithNoTests' | 'retry' | 'clearMocks' | 'resetMocks' | 'restoreMocks' | 'unstubEnvs' | 'unstubGlobals' | 'maxConcurrency' | 'printConsoleTrace' | 'disableConsoleIntercept' | 'testEnvironment' | 'isolate' | 'hookTimeout' | 'coverage' | 'snapshotFormat' | 'env'>;
 
 /** Runtime to Server */
 declare type RuntimeRPC = {
     onTestFileStart: (test: TestFileInfo) => Promise<void>;
-    onTestFileResult: (test: TestFileResult) => Promise<void>;
+    getAssetsByEntry: () => Promise<{
+        assetFiles: Record<string, string>;
+        sourceMaps: Record<string, string>;
+    }>;
     onTestCaseResult: (result: TestResult) => Promise<void>;
     onConsoleLog: (log: UserConsoleLog) => void;
 };
@@ -2019,11 +2033,14 @@ declare type RunWorkerOptions = {
     options: {
         entryInfo: EntryInfo;
         setupEntries: EntryInfo[];
-        assetFiles: Record<string, string>;
-        sourceMaps: Record<string, SourceMapInput>;
         context: WorkerContext;
         updateSnapshot: SnapshotUpdateState;
         type: 'run' | 'collect';
+        /** assets is only defined when memory is sufficient, otherwise we should get them via rpc getAssetsByEntry method */
+        assets?: {
+            assetFiles: Record<string, string>;
+            sourceMaps: Record<string, string>;
+        };
     };
     rpcMethods: RuntimeRPC;
 };
@@ -2044,6 +2061,8 @@ declare interface SnapshotEnvironment {
     	processStackTrace?: (stack: ParsedStack) => ParsedStack;
 }
 
+declare type SnapshotFormat = Omit<NonNullable<SnapshotStateOptions['snapshotFormat']>, 'plugins' | 'compareKeys'>;
+
 declare class SnapshotManager {
     	options: Omit<SnapshotStateOptions, "snapshotEnvironment">;
     	summary: SnapshotSummary;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rstest/core",
-  "version": "0.5.0",
+  "version": "0.5.2",
   "description": "The Rsbuild-based test tool.",
   "bugs": {
     "url": "https://github.com/web-infra-dev/rstest/issues"
@@ -28,6 +28,9 @@
       "types": "./dist-types/index.d.ts",
       "default": "./dist/index.js"
     },
+    "./package.json": {
+      "default": "./package.json"
+    },
     "./globals": {
       "types": "./globals.d.ts"
     },
@@ -68,10 +71,10 @@
     "@types/picomatch": "^4.0.2",
     "cac": "^6.7.14",
     "chokidar": "^4.0.3",
-    "happy-dom": "^18.0.1",
+    "happy-dom": "^20.0.0",
     "jest-diff": "^30.1.2",
     "jsdom": "^26.1.0",
-    "license-webpack-plugin": "^4.0.2",
+    "webpack-license-plugin": "^4.5.1",
     "picocolors": "^1.1.1",
     "rslog": "^1.2.11",
     "source-map-support": "^0.5.21",

package/dist/0~223.js

@@ -1,158 +0,0 @@
-import 'module';
-/*#__PURE__*/ import.meta.url;
-export const __webpack_id__ = "223";
-export const __webpack_ids__ = [
-    "223"
-];
-export const __webpack_modules__ = {
-    "./src/cli/init.ts": function(__unused_webpack_module, __webpack_exports__, __webpack_require__) {
-        __webpack_require__.d(__webpack_exports__, {
-            initCli: ()=>initCli
-        });
-        var node_fs__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__("node:fs");
-        var pathe__WEBPACK_IMPORTED_MODULE_3__ = __webpack_require__("../../node_modules/.pnpm/pathe@2.0.3/node_modules/pathe/dist/shared/pathe.M-eThtNZ.mjs");
-        var tinyglobby__WEBPACK_IMPORTED_MODULE_4__ = __webpack_require__("../../node_modules/.pnpm/tinyglobby@0.2.15/node_modules/tinyglobby/dist/index.mjs");
-        var _config__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__("./src/config.ts");
-        var _utils__WEBPACK_IMPORTED_MODULE_2__ = __webpack_require__("./src/utils/index.ts");
-        async function resolveConfig(options) {
-            const { content: config, filePath: configFilePath } = await (0, _config__WEBPACK_IMPORTED_MODULE_1__.Z9)({
-                cwd: options.root,
-                path: options.config,
-                configLoader: options.configLoader
-            });
-            const keys = [
-                'root',
-                'globals',
-                'isolate',
-                'passWithNoTests',
-                'update',
-                'testNamePattern',
-                'testTimeout',
-                'hookTimeout',
-                'clearMocks',
-                'resetMocks',
-                'restoreMocks',
-                'unstubEnvs',
-                'unstubGlobals',
-                'retry',
-                'slowTestThreshold',
-                'maxConcurrency',
-                'printConsoleTrace',
-                'disableConsoleIntercept',
-                'testEnvironment'
-            ];
-            for (const key of keys)if (void 0 !== options[key]) config[key] = options[key];
-            if (options.reporter) config.reporters = (0, _utils__WEBPACK_IMPORTED_MODULE_2__.bg)(options.reporter);
-            if (void 0 !== options.coverage) {
-                config.coverage ??= {};
-                config.coverage.enabled = options.coverage;
-            }
-            if (options.exclude) config.exclude = (0, _utils__WEBPACK_IMPORTED_MODULE_2__.bg)(options.exclude);
-            if (options.include) config.include = (0, _utils__WEBPACK_IMPORTED_MODULE_2__.bg)(options.include);
-            return {
-                config,
-                configFilePath: configFilePath ?? void 0
-            };
-        }
-        async function resolveProjects({ config, root, options }) {
-            if (!config.projects) return [];
-            const getDefaultProjectName = (dir)=>{
-                const pkgJsonPath = (0, pathe__WEBPACK_IMPORTED_MODULE_3__.r)(dir, 'package.json');
-                const name = (0, node_fs__WEBPACK_IMPORTED_MODULE_0__.existsSync)(pkgJsonPath) ? JSON.parse((0, node_fs__WEBPACK_IMPORTED_MODULE_0__.readFileSync)(pkgJsonPath, 'utf-8')).name : '';
-                if ('string' != typeof name || !name) return (0, pathe__WEBPACK_IMPORTED_MODULE_3__.c)(dir);
-                return name;
-            };
-            const globProjects = async (patterns)=>{
-                const globOptions = {
-                    absolute: true,
-                    dot: true,
-                    onlyFiles: false,
-                    cwd: root,
-                    expandDirectories: false,
-                    ignore: [
-                        '**/node_modules/**',
-                        '**/.DS_Store'
-                    ]
-                };
-                return (0, tinyglobby__WEBPACK_IMPORTED_MODULE_4__.glob)(patterns, globOptions);
-            };
-            const { projectPaths, projectPatterns, projectConfigs } = (config.projects || []).reduce((total, p)=>{
-                if ('object' == typeof p) {
-                    const projectRoot = p.root ? (0, _utils__WEBPACK_IMPORTED_MODULE_2__.tS)(p.root, root) : root;
-                    total.projectConfigs.push({
-                        config: {
-                            root: projectRoot,
-                            name: p.name ? p.name : getDefaultProjectName(projectRoot),
-                            ...p
-                        },
-                        configFilePath: void 0
-                    });
-                    return total;
-                }
-                const projectStr = (0, _utils__WEBPACK_IMPORTED_MODULE_2__.tS)(p, root);
-                if ((0, tinyglobby__WEBPACK_IMPORTED_MODULE_4__.ey)(projectStr)) total.projectPatterns.push(projectStr);
-                else {
-                    const absolutePath = (0, _utils__WEBPACK_IMPORTED_MODULE_2__.FI)(root, projectStr);
-                    if (!(0, node_fs__WEBPACK_IMPORTED_MODULE_0__.existsSync)(absolutePath)) throw `Can't resolve project "${p}", please make sure "${p}" is a existing file or a directory.`;
-                    total.projectPaths.push(absolutePath);
-                }
-                return total;
-            }, {
-                projectPaths: [],
-                projectPatterns: [],
-                projectConfigs: []
-            });
-            projectPaths.push(...await globProjects(projectPatterns));
-            const projects = await Promise.all(projectPaths.map(async (project)=>{
-                const isDirectory = (0, node_fs__WEBPACK_IMPORTED_MODULE_0__.statSync)(project).isDirectory();
-                const { config, configFilePath } = await resolveConfig({
-                    ...options,
-                    config: isDirectory ? void 0 : project,
-                    root: isDirectory ? project : (0, pathe__WEBPACK_IMPORTED_MODULE_3__.d)(project)
-                });
-                config.name ??= getDefaultProjectName(project);
-                if (config.projects?.length && config.root !== root) _utils__WEBPACK_IMPORTED_MODULE_2__.vF.warn(`Projects cannot have nested projects, the "projects" field in project "${config.name}" will be ignored.`);
-                return {
-                    config,
-                    configFilePath
-                };
-            })).then((projects)=>(0, _utils__WEBPACK_IMPORTED_MODULE_2__.zz)(projects.concat(projectConfigs), options));
-            if (!projects.length) {
-                let errorMsg = `No projects found, please make sure you have at least one valid project.
-${_utils__WEBPACK_IMPORTED_MODULE_2__.yW.gray('projects:')} ${JSON.stringify(config.projects, null, 2)}`;
-                if (options.project) errorMsg += `\n${_utils__WEBPACK_IMPORTED_MODULE_2__.yW.gray('projectName filter:')} ${JSON.stringify(options.project, null, 2)}`;
-                throw errorMsg;
-            }
-            const names = new Set();
-            projects.forEach((project)=>{
-                if (names.has(project.config.name)) {
-                    const conflictProjects = projects.filter((p)=>p.config.name === project.config.name);
-                    throw `Project name "${project.config.name}" is already used. Please ensure all projects have unique names.
-Conflicting projects:
-${conflictProjects.map((p)=>`- ${p.configFilePath || p.config.root}`).join('\n')}
-        `;
-                }
-                names.add(project.config.name);
-            });
-            return projects;
-        }
-        async function initCli(options) {
-            const cwd = process.cwd();
-            const root = options.root ? (0, _utils__WEBPACK_IMPORTED_MODULE_2__.FI)(cwd, options.root) : cwd;
-            const { config, configFilePath } = await resolveConfig({
-                ...options,
-                root
-            });
-            const projects = await resolveProjects({
-                config,
-                root,
-                options
-            });
-            return {
-                config,
-                configFilePath,
-                projects
-            };
-        }
-    }
-};