@rstest/core 0.2.2 → 0.3.1

package/dist-types/worker.d.ts

@@ -11,7 +11,11 @@ declare function addSerializer(plugin: Plugin_2): void;
 
 declare type AfterAllListener = (ctx: SuiteContext) => MaybePromise<void>;
 
-declare type AfterEachListener = () => MaybePromise<void>;
+declare type AfterEachListener = (params: {
+    task: {
+        result: Readonly<TestResult>;
+    };
+}) => MaybePromise<void>;
 
 declare interface Assertion<T = any> extends VitestAssertion<Chai.Assertion, T>, JestAssertion<T>, Matchers<T> {
     	/**
@@ -375,12 +379,13 @@ declare class DefaultReporter implements Reporter {
     onTestCaseResult(_result: TestResult): void;
     onUserConsoleLog(log: UserConsoleLog): void;
     onExit(): Promise<void>;
-    onTestRunEnd({ results, testResults, duration, getSourcemap, snapshotSummary, }: {
+    onTestRunEnd({ results, testResults, duration, getSourcemap, snapshotSummary, filterRerunTestPaths, }: {
         results: TestFileResult[];
         testResults: TestResult[];
         duration: Duration;
         snapshotSummary: SnapshotSummary;
         getSourcemap: GetSourcemap;
+        filterRerunTestPaths?: string[];
     }): Promise<void>;
 }
 
@@ -392,6 +397,27 @@ declare type DefaultReporterOptions = {
     summary?: boolean;
 };
 
+declare type DescribeAPI = DescribeFn & {
+    each: DescribeEachFn;
+    for: DescribeForFn;
+    only: DescribeAPI;
+    skip: DescribeAPI;
+    runIf: (condition: boolean) => DescribeAPI;
+    skipIf: (condition: boolean) => DescribeAPI;
+    todo: DescribeAPI;
+    concurrent: DescribeAPI;
+    sequential: DescribeAPI;
+};
+
+declare interface DescribeEachFn {
+    <T extends Record<string, unknown>>(cases: readonly T[]): (description: string, fn?: (param: T) => MaybePromise<void>) => void;
+    <T extends readonly [unknown, ...unknown[]]>(cases: readonly T[]): (description: string, fn: (...args: [...T]) => MaybePromise<void>) => void;
+}
+
+declare type DescribeFn = (description: string, fn?: () => void) => void;
+
+declare type DescribeForFn = <T>(cases: readonly T[]) => (description: string, fn?: (param: T) => MaybePromise<void>) => void;
+
 /**
  * @param a Expected value
  * @param b Received value
@@ -452,6 +478,7 @@ declare type EncodedSourceMapXInput = EncodedSourceMap & XInput;
 
 declare type EntryInfo = {
     distPath: DistPath;
+    chunks: (string | number)[];
     testPath: TestPath;
     files?: string[];
 };
@@ -493,6 +520,8 @@ declare interface ExpectStatic_2 extends Chai.ExpectStatic, Matchers, Asymmetric
     	not: AsymmetricMatchersContaining;
 }
 
+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>;
 
 declare interface FixtureOptions {
@@ -502,6 +531,10 @@ declare interface FixtureOptions {
     auto?: boolean;
 }
 
+declare type Fixtures<T extends Record<string, any> = object, ExtraContext = object> = {
+    [K in keyof T]: Fixture<T, K, ExtraContext & TestContext> | [Fixture<T, K, ExtraContext & TestContext>, FixtureOptions?];
+};
+
 declare type FormattedError = {
     fullStack?: boolean;
     message: string;
@@ -550,6 +583,7 @@ declare class GithubActionsReporter {
         duration: Duration;
         snapshotSummary: SnapshotSummary;
         getSourcemap: GetSourcemap;
+        filterRerunTestPaths?: string[];
     }): Promise<void>;
 }
 
@@ -1307,7 +1341,7 @@ declare interface NewPlugin {
     	test: Test;
 }
 
-declare type NormalizedConfig = Required<Omit<RstestConfig, OptionalKeys | 'pool'>> & {
+declare type NormalizedConfig = Required<Omit<RstestConfig, OptionalKeys | 'pool' | 'projects'>> & {
     [key in OptionalKeys]?: RstestConfig[key];
 } & {
     pool: RstestPoolOptions;
@@ -1324,11 +1358,27 @@ declare type NormalizedFixtures = Record<string, NormalizedFixture>;
 
 declare type NormalizedProcedure<T extends Procedure> = (...args: Parameters<T>) => ReturnType<T>;
 
+declare type NormalizedProjectConfig = Required<Omit<RstestConfig, OptionalKeys | 'projects' | 'reporters' | 'pool'>> & {
+    [key in OptionalKeys]?: RstestConfig[key];
+};
+
 declare interface OldPlugin {
     	print: (val: unknown, print: Print, indent: Indent, options: PluginOptions, colors: Colors) => string;
     	test: Test;
 }
 
+declare type OnTestFailedHandler = (params: {
+    task: {
+        result: Readonly<TestResult>;
+    };
+}) => MaybePromise<void>;
+
+declare type OnTestFinishedHandler = (params: {
+    task: {
+        result: Readonly<TestResult>;
+    };
+}) => MaybePromise<void>;
+
 declare type OptionalKeys = 'setupFiles' | 'testNamePattern' | 'plugins' | 'source' | 'resolve' | 'output' | 'performance' | 'tools' | 'dev' | 'onConsoleLog';
 
 declare type OptionsReceived = PrettyFormatOptions;
@@ -1379,6 +1429,16 @@ declare function printWithType<T>(name: string, value: T, print: (value: T) => s
 
 declare type Procedure = (...args: any[]) => any;
 
+declare type ProjectConfig = Omit<RstestConfig, 'projects' | 'reporters' | 'pool' | 'isolate'>;
+
+declare type ProjectContext = {
+    name: string;
+    environmentName: string;
+    rootPath: string;
+    configFilePath?: string;
+    normalizedConfig: NormalizedProjectConfig;
+};
+
 declare type Promisify<O> = { [K in keyof O] : O[K] extends (...args: infer A) => infer R ? Promisify<O[K]> & ((...args: A) => Promise<R>) : O[K] };
 
 declare type Promisify_2<O> = {
@@ -1426,6 +1486,7 @@ declare interface Reporter {
         duration: Duration;
         getSourcemap: GetSourcemap;
         snapshotSummary: SnapshotSummary;
+        filterRerunTestPaths?: string[];
     }) => MaybePromise<void>;
     /**
      * Called when console log is calling.
@@ -1462,6 +1523,10 @@ declare interface RstestConfig {
      * @default process.cwd()
      */
     root?: string;
+    /**
+     * Run tests from one or more projects.
+     */
+    projects?: TestProject[];
     /**
      * Project name
      *
@@ -1621,6 +1686,10 @@ declare type RstestContext = {
     fileFilters?: string[];
     /** The config file path. */
     configFilePath?: string;
+    /**
+     * Run tests from one or more projects.
+     */
+    projects: ProjectContext[];
     /**
      * The command type.
      *
@@ -1653,6 +1722,18 @@ declare const runInPool: (options: RunWorkerOptions["options"]) => Promise<{
 } | TestFileResult>;
 export default runInPool;
 
+declare type RunnerAPI = {
+    describe: DescribeAPI;
+    it: TestAPIs;
+    test: TestAPIs;
+    beforeAll: (fn: BeforeAllListener, timeout?: number) => MaybePromise<void>;
+    afterAll: (fn: AfterAllListener, timeout?: number) => MaybePromise<void>;
+    beforeEach: (fn: BeforeEachListener, timeout?: number) => MaybePromise<void>;
+    afterEach: (fn: AfterEachListener, timeout?: number) => MaybePromise<void>;
+    onTestFinished: (fn: OnTestFinishedHandler, timeout?: number) => void;
+    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'>;
 
 /** Runtime to Server */
@@ -1893,6 +1974,27 @@ declare type Test = (arg0: any) => boolean;
 
 declare type Test_2 = TestSuite | TestCase;
 
+declare type TestAPI<ExtraContext = object> = TestFn<ExtraContext> & {
+    each: TestEachFn;
+    for: TestForFn<ExtraContext>;
+    fails: TestAPI<ExtraContext>;
+    concurrent: TestAPI<ExtraContext>;
+    sequential: TestAPI<ExtraContext>;
+    only: TestAPI<ExtraContext>;
+    skip: TestAPI<ExtraContext>;
+    todo: TestAPI<ExtraContext>;
+    runIf: (condition: boolean) => TestAPI<ExtraContext>;
+    skipIf: (condition: boolean) => TestAPI<ExtraContext>;
+};
+
+declare type TestAPIs<ExtraContext = object> = TestAPI<ExtraContext> & {
+    extend: <T extends Record<string, any> = object>(fixtures: Fixtures<T, ExtraContext>) => TestAPIs<{
+        [K in keyof T | keyof ExtraContext]: K extends keyof T ? T[K] : K extends keyof ExtraContext ? ExtraContext[K] : never;
+    }>;
+};
+
+declare type TestCallbackFn<ExtraContext = object> = (context: TestContext & ExtraContext) => MaybePromise<void>;
+
 declare type TestCase = {
     testPath: TestPath;
     name: string;
@@ -1908,7 +2010,8 @@ declare type TestCase = {
     inTestEach?: boolean;
     context: TestContext;
     only?: boolean;
-    onFinished?: any[];
+    onFinished: OnTestFinishedHandler[];
+    onFailed: OnTestFailedHandler[];
     type: 'case';
     parentNames?: string[];
     /**
@@ -1919,12 +2022,20 @@ declare type TestCase = {
      * Result of the task. if `expect.soft()` failed multiple times or `retry` was triggered.
      */
     result?: TaskResult;
+    project: string;
 };
 
 declare type TestContext = {
     expect: RstestExpect;
+    onTestFinished: RunnerAPI['onTestFinished'];
+    onTestFailed: RunnerAPI['onTestFailed'];
 };
 
+declare interface TestEachFn {
+    <T extends Record<string, unknown>>(cases: readonly T[]): (description: string, fn?: (param: T) => MaybePromise<void>, timeout?: number) => void;
+    <T extends readonly [unknown, ...unknown[]]>(cases: readonly T[]): (description: string, fn: (...args: [...T]) => MaybePromise<void>, timeout?: number) => void;
+}
+
 declare type Tester = (this: TesterContext, a: any, b: any, customTesters: Array<Tester>) => boolean | undefined;
 
 declare interface TesterContext {
@@ -1940,9 +2051,20 @@ declare type TestFileResult = TestResult & {
     snapshotResult?: SnapshotResult;
 };
 
+declare type TestFn<ExtraContext = object> = (description: string, fn?: TestCallbackFn<ExtraContext>, timeout?: number) => void;
+
+declare type TestForFn<ExtraContext = object> = <T>(cases: readonly T[]) => (description: string, fn?: (param: T, context: TestContext & ExtraContext) => MaybePromise<void>, timeout?: number) => void;
+
 /** The test file original path */
 declare type TestPath = string;
 
+/**
+ * A list of glob patterns or files that match your test projects.
+ *
+ * eg. ['packages/*', 'examples/node/rstest.config.ts']
+ */
+declare type TestProject = string | ProjectConfig;
+
 declare type TestResult = {
     status: TestResultStatus;
     name: string;
@@ -1951,6 +2073,7 @@ declare type TestResult = {
     duration?: number;
     errors?: FormattedError[];
     retryCount?: number;
+    project: string;
 };
 
 declare type TestResultStatus = 'skip' | 'pass' | 'fail' | 'todo';
@@ -1966,6 +2089,7 @@ declare type TestSuite = {
     concurrent?: boolean;
     sequential?: boolean;
     testPath: TestPath;
+    project: string;
     /** nested cases and suite could in a suite */
     tests: (TestSuite | TestCase)[];
     type: 'suite';
@@ -2020,6 +2144,7 @@ declare type WithAsymmetricMatcher<T> = T | AsymmetricMatcher<unknown>;
 
 declare type WorkerContext = {
     rootPath: RstestContext['rootPath'];
+    project: string;
     runtimeConfig: RuntimeConfig;
 };
 

package/globals.d.ts

@@ -8,6 +8,8 @@ declare global {
   const afterAll: typeof import('@rstest/core')['afterAll'];
   const beforeEach: typeof import('@rstest/core')['beforeEach'];
   const afterEach: typeof import('@rstest/core')['afterEach'];
+  const onTestFinished: typeof import('@rstest/core')['onTestFinished'];
+  const onTestFailed: typeof import('@rstest/core')['onTestFailed'];
   const rstest: typeof import('@rstest/core')['rstest'];
 }
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rstest/core",
-  "version": "0.2.2",
+  "version": "0.3.1",
   "description": "The Rsbuild-based test tool.",
   "bugs": {
     "url": "https://github.com/web-infra-dev/rstest/issues"
@@ -44,9 +44,9 @@
     "importMeta.d.ts"
   ],
   "dependencies": {
-    "chai": "^5.2.1",
+    "chai": "^5.3.3",
     "@types/chai": "^5.2.2",
-    "@rsbuild/core": "1.5.0-beta.4",
+    "@rsbuild/core": "1.5.0",
     "birpc": "2.5.0",
     "pathe": "^2.0.3",
     "std-env": "^3.9.0",
@@ -57,7 +57,7 @@
     "@vitest/snapshot": "^3.2.4",
     "@babel/code-frame": "^7.27.1",
     "@jridgewell/trace-mapping": "0.3.30",
-    "@microsoft/api-extractor": "^7.52.10",
+    "@microsoft/api-extractor": "^7.52.11",
     "@rslib/core": "0.12.2",
     "@sinonjs/fake-timers": "^14.0.0",
     "@types/babel__code-frame": "^7.0.6",