@rstest/core 0.3.4 → 0.4.1

package/dist-types/worker.d.ts

@@ -1,3 +1,4 @@
+import type { ReportOptions } from 'istanbul-reports';
 import type { RsbuildConfig } from '@rsbuild/core';
 
 /**
@@ -317,6 +318,56 @@ declare class CounterMap<K> extends DefaultMap<K, number> {
     	total(): number;
 }
 
+declare type CoverageOptions = {
+    /**
+     * Enable coverage collection.
+     * @default false
+     */
+    enabled?: boolean;
+    /**
+     * A list of glob patterns that should be excluded from coverage collection.
+     *
+     * This option accepts an array of wax(https://crates.io/crates/wax)-compatible glob patterns
+     *
+     * @default ['**\/node_modules/**',
+     *           '**\/dist/**',
+     *           '**\/test/**',
+     *           '**\/__tests__/**',
+     *           '**\/*.{test,spec}.?(c|m)[jt]s?(x)',
+     *           '**\/__mocks__/**'
+     * ]
+     */
+    exclude?: string[];
+    /**
+     * The provider to use for coverage collection.
+     * @default 'istanbul'
+     */
+    provider?: 'istanbul';
+    /**
+     * The reporters to use for coverage collection.
+     * @default ['text', 'html', 'clover', 'json']
+     */
+    reporters?: (keyof ReportOptions | ReportWithOptions)[];
+    /**
+     * The directory to store coverage reports.
+     * @default './coverage'
+     */
+    reportsDirectory?: string;
+    /**
+     * Whether to clean the coverage directory before running tests.
+     * @default true
+     */
+    clean?: boolean;
+    /**
+     * Coverage thresholds
+     *
+     * @default undefined
+     */
+    thresholds?: CoverageThresholds;
+};
+
+declare type CoverageThresholds = Thresholds;
+
 declare interface CustomMatcher {
     	/**
      	* Checks that a value satisfies a custom matcher function.
@@ -1363,10 +1414,15 @@ declare interface NewPlugin {
     	test: Test;
 }
 
-declare type NormalizedConfig = Required<Omit<RstestConfig, OptionalKeys | 'pool' | 'projects'>> & {
+declare type NormalizedConfig = Required<Omit<RstestConfig, OptionalKeys | 'pool' | 'projects' | 'coverage'>> & {
     [key in OptionalKeys]?: RstestConfig[key];
 } & {
     pool: RstestPoolOptions;
+    coverage: NormalizedCoverageOptions;
+};
+
+declare type NormalizedCoverageOptions = Required<Omit<CoverageOptions, 'thresholds'>> & {
+    thresholds?: CoverageThresholds;
 };
 
 declare type NormalizedFixture = {
@@ -1380,8 +1436,8 @@ 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 type NormalizedProjectConfig = Required<Omit<NormalizedConfig, OptionalKeys | 'projects' | 'reporters' | 'pool'>> & {
+    [key in OptionalKeys]?: NormalizedConfig[key];
 };
 
 declare interface OldPlugin {
@@ -1451,11 +1507,12 @@ 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 ProjectConfig = Omit<RstestConfig, 'projects' | 'reporters' | 'pool' | 'isolate' | 'coverage'>;
 
 declare type ProjectContext = {
     name: string;
     environmentName: string;
+    /** The root path of current project. */
     rootPath: string;
     configFilePath?: string;
     normalizedConfig: NormalizedProjectConfig;
@@ -1529,6 +1586,8 @@ declare const reportersMap: {
 
 declare type ReporterWithOptions<Name extends BuiltInReporterNames = BuiltInReporterNames> = Name extends keyof BuiltinReporterOptions ? [Name, Partial<BuiltinReporterOptions[Name]>] : [Name, Record<string, unknown>];
 
+declare type ReportWithOptions<Name extends keyof ReportOptions = keyof ReportOptions> = Name extends keyof ReportOptions ? [Name, Partial<ReportOptions[Name]>] : [Name, Record<string, unknown>];
+
 declare type Ro<T> = T extends Array<infer V> ? V[] | Readonly<V[]> | RoArray<V> | Readonly<RoArray<V>> : T extends object ? T | Readonly<T> | RoObject<T> | Readonly<RoObject<T>> : T;
 
 declare type RoArray<T> = Ro<T>[];
@@ -1687,6 +1746,10 @@ declare interface RstestConfig {
      * Custom handler for console log in tests
      */
     onConsoleLog?: (content: string) => boolean | void;
+    /**
+     * Coverage options
+     */
+    coverage?: CoverageOptions;
     plugins?: RsbuildConfig['plugins'];
     source?: Pick<NonNullable<RsbuildConfig['source']>, 'define' | 'tsconfigPath' | 'decorators' | 'include' | 'exclude'>;
     performance?: Pick<NonNullable<RsbuildConfig['performance']>, 'bundleAnalyze'>;
@@ -1699,7 +1762,7 @@ declare interface RstestConfig {
 declare type RstestContext = {
     /** The Rstest core version. */
     version: string;
-    /** The root path of current project. */
+    /** The root path of rstest. */
     rootPath: string;
     /** The original Rstest config passed from the createRstest method. */
     originalConfig: Readonly<RstestConfig>;
@@ -1716,8 +1779,9 @@ declare type RstestContext = {
     /**
      * The command type.
      *
-     * - dev: `rstest dev`
-     * - run: `rstest run`
+     * - run: `rstest`
+     * - dev: `rstest dev` or watch mode
+     * - list: `rstest list`
      */
     command: RstestCommand;
     reporters: Reporter[];
@@ -1728,7 +1792,7 @@ declare type RstestExpect = ExpectStatic;
 
 declare type RstestPoolOptions = {
     /** Pool used to run tests in. */
-    type: RstestPoolType;
+    type?: RstestPoolType;
     /** Maximum number or percentage of workers to run tests in. */
     maxWorkers?: number | string;
     /** Minimum number or percentage of workers to run tests in. */
@@ -1757,7 +1821,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'>;
+declare type RuntimeConfig = Pick<RstestContext['normalizedConfig'], 'testTimeout' | 'testNamePattern' | 'globals' | 'passWithNoTests' | 'retry' | 'clearMocks' | 'resetMocks' | 'restoreMocks' | 'unstubEnvs' | 'unstubGlobals' | 'maxConcurrency' | 'printConsoleTrace' | 'disableConsoleIntercept' | 'testEnvironment' | 'isolate' | 'hookTimeout' | 'coverage'>;
 
 /** Runtime to Server */
 declare type RuntimeRPC = {
@@ -2122,6 +2186,17 @@ declare type TestSuite = {
     beforeEachListeners?: BeforeEachListener[];
 };
 
+declare type Thresholds = {
+    /** Thresholds for statements */
+    statements?: number;
+    /** Thresholds for functions */
+    functions?: number;
+    /** Thresholds for branches */
+    branches?: number;
+    /** Thresholds for lines */
+    lines?: number;
+};
+
 declare class TraceMap implements SourceMap {
     version: SourceMapV3['version'];
     file: SourceMapV3['file'];
@@ -2167,6 +2242,7 @@ declare type WithAsymmetricMatcher<T> = T | AsymmetricMatcher<unknown>;
 
 declare type WorkerContext = {
     rootPath: RstestContext['rootPath'];
+    projectRoot: ProjectContext['rootPath'];
     project: string;
     runtimeConfig: RuntimeConfig;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rstest/core",
-  "version": "0.3.4",
+  "version": "0.4.1",
   "description": "The Rsbuild-based test tool.",
   "bugs": {
     "url": "https://github.com/web-infra-dev/rstest/issues"
@@ -56,26 +56,28 @@
     "@vitest/expect": "^3.2.4",
     "@vitest/snapshot": "^3.2.4",
     "@babel/code-frame": "^7.27.1",
-    "@jridgewell/trace-mapping": "0.3.30",
-    "@microsoft/api-extractor": "^7.52.11",
-    "@rslib/core": "0.12.2",
+    "@jridgewell/trace-mapping": "0.3.31",
+    "@microsoft/api-extractor": "^7.52.13",
+    "@rslib/core": "0.13.3",
     "@sinonjs/fake-timers": "^14.0.0",
     "@types/babel__code-frame": "^7.0.6",
+    "@types/istanbul-reports": "^3.0.4",
+    "@types/istanbul-lib-coverage": "^2.0.6",
     "@types/jsdom": "^21.1.7",
     "@types/sinonjs__fake-timers": "^8.1.5",
     "@types/source-map-support": "^0.5.10",
     "cac": "^6.7.14",
     "chokidar": "^4.0.3",
     "happy-dom": "^18.0.1",
-    "jest-diff": "^30.0.5",
+    "jest-diff": "^30.1.2",
     "jsdom": "^26.1.0",
     "license-webpack-plugin": "^4.0.2",
     "picocolors": "^1.1.1",
     "rslog": "^1.2.11",
     "source-map-support": "^0.5.21",
     "stacktrace-parser": "0.1.11",
-    "strip-ansi": "^7.1.0",
-    "tinyglobby": "^0.2.14",
+    "strip-ansi": "^7.1.2",
+    "tinyglobby": "^0.2.15",
     "tinyspy": "^4.0.3",
     "@rstest/tsconfig": "0.0.1"
   },