@rstest/core 0.0.1 → 0.0.2

package/dist-types/node.d.ts

@@ -187,10 +187,9 @@ export declare interface RstestConfig {
     /**
      * The environment that will be used for testing
      *
-     * TODO: support more test environments
      * @default 'node'
      */
-    testEnvironment?: 'node';
+    testEnvironment?: 'node' | 'jsdom';
     /**
      * print console traces when calling any console method.
      *

package/dist-types/public.d.ts

@@ -197,6 +197,62 @@ declare interface ExpectStatic extends ExpectStatic_2 {
     setState: (state: Partial<MatcherState>) => void;
 }
 
+/**
+ * Names of clock methods that may be faked by install.
+ */
+declare type FakeMethod =
+| "setTimeout"
+| "clearTimeout"
+| "setImmediate"
+| "clearImmediate"
+| "setInterval"
+| "clearInterval"
+| "Date"
+| "nextTick"
+| "hrtime"
+| "requestAnimationFrame"
+| "cancelAnimationFrame"
+| "requestIdleCallback"
+| "cancelIdleCallback"
+| "performance"
+| "queueMicrotask";
+
+declare interface FakeTimerInstallOpts {
+    /**
+     * Installs fake timers with the specified unix epoch (default: 0)
+     */
+    now?: number | Date | undefined;
+
+    /**
+     * An array with names of global methods and APIs to fake. By default, `@sinonjs/fake-timers` does not replace `nextTick()` and `queueMicrotask()`.
+     * For instance, `FakeTimers.install({ toFake: ['setTimeout', 'nextTick'] })` will fake only `setTimeout()` and `nextTick()`
+     */
+    toFake?: FakeMethod[] | undefined;
+
+    /**
+     * The maximum number of timers that will be run when calling runAll() (default: 1000)
+     */
+    loopLimit?: number | undefined;
+
+    /**
+     * Tells @sinonjs/fake-timers to increment mocked time automatically based on the real system time shift (e.g. the mocked time will be incremented by
+     * 20ms for every 20ms change in the real system time) (default: false)
+     */
+    shouldAdvanceTime?: boolean | undefined;
+
+    /**
+     * Relevant only when using with shouldAdvanceTime: true. increment mocked time by advanceTimeDelta ms every advanceTimeDelta ms change
+     * in the real system time (default: 20)
+     */
+    advanceTimeDelta?: number | undefined;
+
+    /**
+     * Tells FakeTimers to clear 'native' (i.e. not fake) timers by delegating to their respective handlers. These are not cleared by
+     * default, leading to potentially unexpected behavior if timers existed prior to installing FakeTimers. (default: false)
+     */
+    shouldClearNativeTimers?: boolean | undefined;
+}
+
 declare type Fixture<T, K extends keyof T, ExtraContext = object> = ((...args: any) => any) extends T[K] ? T[K] extends any ? FixtureFn<T, K, Omit<ExtraContext, Exclude<keyof T, K>>> : never : T[K] | (T[K] extends any ? FixtureFn<T, K, Omit<ExtraContext, Exclude<keyof T, K>>> : never);
 
 declare type FixtureFn<T, K extends keyof T, ExtraContext> = (context: Omit<T, K> & ExtraContext, use: Use<T[K]>) => Promise<void>;
@@ -451,10 +507,13 @@ declare const reportersMap: {
 
 declare type ReporterWithOptions<Name extends BuiltInReporterNames = BuiltInReporterNames> = Name extends keyof BuiltinReporterOptions ? [Name, Partial<BuiltinReporterOptions[Name]>] : [Name, Record<string, unknown>];
 
+export declare const rs: RstestUtilities;
+
 declare type Rstest = RunnerAPI & {
     expect: RstestExpect;
     assert: typeof assert_2;
     rstest: RstestUtilities;
+    rs: RstestUtilities;
 };
 
 export declare const rstest: RstestUtilities;
@@ -524,10 +583,9 @@ export declare interface RstestConfig {
     /**
      * The environment that will be used for testing
      *
-     * TODO: support more test environments
      * @default 'node'
      */
-    testEnvironment?: 'node';
+    testEnvironment?: 'node' | 'jsdom';
     /**
      * print console traces when calling any console method.
      *
@@ -679,9 +737,14 @@ declare type RstestUtilities = {
     importMock: <T = Record<string, unknown>>(path: string) => Promise<T>;
     /**
      * @todo
-     * Returns the actual module instead of a mock, bypassing all checks on whether the module should receive a mock implementation or not.
+     * Import and return the actual module instead of a mock, bypassing all checks on whether the module should receive a mock implementation or not.
      */
     importActual: <T = Record<string, unknown>>(path: string) => Promise<T>;
+    /**
+     * @todo
+     * Require and return the actual module instead of a mock, bypassing all checks on whether the module should receive a mock implementation or not.
+     */
+    requireActual: <T = Record<string, unknown>>(path: string) => T;
     /**
      * @todo
      * Resets modules registry by clearing the cache of all modules.
@@ -703,6 +766,35 @@ declare type RstestUtilities = {
      * Restores all global variables that were changed with `rstest.stubGlobal`.
      */
     unstubAllGlobals: () => RstestUtilities;
+    /**
+     * Mocks timers using `@sinonjs/fake-timers`.
+     */
+    useFakeTimers: (config?: FakeTimerInstallOpts) => RstestUtilities;
+    useRealTimers: () => RstestUtilities;
+    isFakeTimers: () => boolean;
+    /**
+     * Set the current system time used by fake timers.
+     */
+    setSystemTime: (now?: number | Date) => RstestUtilities;
+    getRealSystemTime: () => number;
+    runAllTicks: () => RstestUtilities;
+    runAllTimers: () => RstestUtilities;
+    runAllTimersAsync: () => Promise<RstestUtilities>;
+    runOnlyPendingTimers: () => RstestUtilities;
+    runOnlyPendingTimersAsync: () => Promise<RstestUtilities>;
+    advanceTimersByTime: (ms: number) => RstestUtilities;
+    advanceTimersByTimeAsync: (ms: number) => Promise<RstestUtilities>;
+    advanceTimersToNextTimer: (steps?: number) => RstestUtilities;
+    advanceTimersToNextTimerAsync: (steps?: number) => Promise<RstestUtilities>;
+    advanceTimersToNextFrame: () => RstestUtilities;
+    /**
+     * Returns the number of fake timers still left to run.
+     */
+    getTimerCount: () => number;
+    /**
+     * Removes all timers that are scheduled to run.
+     */
+    clearAllTimers: () => RstestUtilities;
 };
 
 declare type RunnerAPI = {

package/dist-types/worker.d.ts

@@ -325,10 +325,9 @@ declare interface RstestConfig {
     /**
      * The environment that will be used for testing
      *
-     * TODO: support more test environments
      * @default 'node'
      */
-    testEnvironment?: 'node';
+    testEnvironment?: 'node' | 'jsdom';
     /**
      * print console traces when calling any console method.
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rstest/core",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "The Rsbuild-based test tool.",
   "bugs": {
     "url": "https://github.com/web-infra-dev/rstest/issues"
@@ -10,10 +10,16 @@
     "url": "https://github.com/web-infra-dev/rstest",
     "directory": "packages/core"
   },
+  "keywords": [
+    "rstest",
+    "test",
+    "rstack",
+    "rspack"
+  ],
   "license": "MIT",
   "type": "module",
-  "main": "./dist/index.js",
-  "types": "./dist-types/index.d.ts",
+  "main": "./dist/public.js",
+  "types": "./dist-types/public.d.ts",
   "bin": {
     "rstest": "./bin/rstest.js"
   },
@@ -42,33 +48,46 @@
     "importMeta.d.ts"
   ],
   "dependencies": {
-    "@rsbuild/core": "^1.4.0-beta.2",
-    "@vitest/expect": "^3.2.3",
-    "@vitest/snapshot": "^3.2.3",
+    "@rsbuild/core": "^1.4.0-beta.5",
     "@types/chai": "^5.2.2",
-    "birpc": "2.3.0",
+    "@vitest/expect": "^3.2.4",
+    "@vitest/snapshot": "^3.2.4",
+    "birpc": "2.4.0",
     "chai": "^5.2.0",
     "pathe": "^2.0.3",
     "std-env": "^3.9.0",
-    "tinypool": "^1.1.0"
+    "tinypool": "^1.1.1"
   },
   "devDependencies": {
+    "@sinonjs/fake-timers": "^14.0.0",
     "@babel/code-frame": "^7.27.1",
     "@jridgewell/trace-mapping": "0.3.25",
     "@microsoft/api-extractor": "^7.52.8",
-    "@rslib/core": "0.9.2",
+    "@rslib/core": "0.10.2",
     "@types/babel__code-frame": "^7.0.6",
+    "@types/sinonjs__fake-timers": "^8.1.5",
+    "@types/jsdom": "^21.1.7",
+    "jsdom": "^26.1.0",
     "@types/source-map-support": "^0.5.10",
     "cac": "^6.7.14",
-    "jest-diff": "^30.0.0",
+    "jest-diff": "^30.0.2",
+    "license-webpack-plugin": "^4.0.2",
     "picocolors": "^1.1.1",
-    "rslog": "^1.2.3",
+    "rslog": "^1.2.7",
     "source-map-support": "^0.5.21",
     "stacktrace-parser": "0.1.11",
     "tinyglobby": "^0.2.14",
     "tinyspy": "^4.0.3",
     "@rstest/tsconfig": "0.0.1"
   },
+  "peerDependencies": {
+    "jsdom": "*"
+  },
+  "peerDependenciesMeta": {
+    "jsdom": {
+      "optional": true
+    }
+  },
   "engines": {
     "node": ">=18.0.0"
   },