@rstest/core 0.4.1 → 0.5.1

package/dist-types/index.d.ts

@@ -1,8 +1,6 @@
 import type { assert as assert_2 } from 'chai';
-import type { CoverageMap } from 'istanbul-lib-coverage';
-import type { ReportOptions } from 'istanbul-reports';
 import type { RsbuildConfig } from '@rsbuild/core';
-import { RsbuildPlugin } from '@rsbuild/core';
+import type { RsbuildPlugin } from '@rsbuild/core';
 
 /**
  * Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved.
@@ -260,12 +258,23 @@ export declare const beforeEach: Rstest['beforeEach'];
 
 declare type BeforeEachListener = () => MaybePromise<void | AfterEachListener>;
 
+declare interface BranchMapping {
+    loc: Range_2;
+    type: string;
+    locations: Range_2[];
+    line: number;
+}
+
 declare type BuiltInReporterNames = keyof typeof reportersMap;
 
 declare type BuiltinReporterOptions = {
     default: DefaultReporterOptions;
 };
 
+declare interface CloverOptions extends FileOptions, ProjectOptions {}
+
+declare interface CoberturaOptions extends FileOptions, ProjectOptions {}
+
 /**
  * Copyright (c) Meta Platforms, Inc. and affiliates.
  *
@@ -331,12 +340,41 @@ declare class CounterMap<K> extends DefaultMap<K, number> {
     	total(): number;
 }
 
+declare interface Coverage {
+    covered: number;
+    total: number;
+    coverage: number;
+}
+
+declare class CoverageMap {
+    constructor(data: CoverageMapData | CoverageMap);
+    addFileCoverage(pathOrObject: string | FileCoverage | FileCoverageData): void;
+    files(): string[];
+    fileCoverageFor(filename: string): FileCoverage;
+    filter(callback: (key: string) => boolean): void;
+    getCoverageSummary(): CoverageSummary;
+    merge(data: CoverageMapData | CoverageMap): void;
+    toJSON(): CoverageMapData;
+    data: CoverageMapData;
+}
+
+declare interface CoverageMapData {
+    [key: string]: FileCoverage | FileCoverageData;
+}
+
 export declare type CoverageOptions = {
     /**
      * Enable coverage collection.
      * @default false
      */
     enabled?: boolean;
+    /**
+     * A list of glob patterns that should be included for coverage collection.
+     * Only collect coverage for tested files by default.
+     *
+     * @default undefined
+     */
+    include?: string[];
     /**
      * A list of glob patterns that should be excluded from coverage collection.
      *
@@ -377,6 +415,11 @@ export declare type CoverageOptions = {
      * @default undefined
      */
     thresholds?: CoverageThresholds;
+    /**
+     * Whether to report coverage when tests fail.
+     * @default false
+     */
+    reportOnFailure?: boolean;
 };
 
 export declare class CoverageProvider {
@@ -393,6 +436,13 @@ export declare class CoverageProvider {
      * Create a new coverage map
      */
     createCoverageMap(): CoverageMap;
+    /**
+     * Generate coverage for untested files
+     */
+    generateCoverageForUntestedFiles(params: {
+        environmentName: string;
+        files: string[];
+    }): Promise<FileCoverageData[]>;
     /**
      * Generate coverage reports
      */
@@ -403,7 +453,46 @@ export declare class CoverageProvider {
     cleanup(): void;
 }
 
-declare type CoverageThresholds = Thresholds;
+declare class CoverageSummary {
+    constructor(data: CoverageSummary | CoverageSummaryData);
+    merge(obj: CoverageSummary): CoverageSummary;
+    toJSON(): CoverageSummaryData;
+    isEmpty(): boolean;
+    data: CoverageSummaryData;
+    lines: Totals;
+    statements: Totals;
+    branches: Totals;
+    functions: Totals;
+}
+
+declare interface CoverageSummaryData {
+    lines: Totals;
+    statements: Totals;
+    branches: Totals;
+    functions: Totals;
+}
+
+declare type CoverageThreshold = {
+    /** Threshold for statements */
+    statements?: number;
+    /** Threshold for functions */
+    functions?: number;
+    /** Threshold for branches */
+    branches?: number;
+    /** Threshold for lines */
+    lines?: number;
+};
+
+declare type CoverageThresholds = CoverageThreshold | (CoverageThreshold & {
+    /** check thresholds for matched files */
+    [glob: string]: CoverageThreshold & {
+        /**
+         * check thresholds per file
+         * @default false
+         */
+        perFile?: boolean;
+    };
+});
 
 declare interface CustomMatcher {
     	/**
@@ -670,6 +759,42 @@ declare interface FakeTimerInstallOpts {
     shouldClearNativeTimers?: boolean | undefined;
 }
 
+declare class FileCoverage implements FileCoverageData {
+    constructor(data: string | FileCoverage | FileCoverageData);
+    merge(other: FileCoverageData): void;
+    getBranchCoverageByLine(): { [line: number]: Coverage };
+    getLineCoverage(): { [line: number]: number };
+    getUncoveredLines(): number[];
+    resetHits(): void;
+    computeBranchTotals(): Totals;
+    computeSimpleTotals(): Totals;
+    toSummary(): CoverageSummary;
+    toJSON(): object;
+
+    data: FileCoverageData;
+    path: string;
+    statementMap: { [key: string]: Range_2 };
+    fnMap: { [key: string]: FunctionMapping };
+    branchMap: { [key: string]: BranchMapping };
+    s: { [key: string]: number };
+    f: { [key: string]: number };
+    b: { [key: string]: number[] };
+}
+
+declare interface FileCoverageData {
+    path: string;
+    statementMap: { [key: string]: Range_2 };
+    fnMap: { [key: string]: FunctionMapping };
+    branchMap: { [key: string]: BranchMapping };
+    s: { [key: string]: number };
+    f: { [key: string]: number };
+    b: { [key: string]: number[] };
+}
+
+declare interface FileOptions {
+    file: string;
+}
+
 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>;
@@ -701,6 +826,13 @@ declare interface Formatter {
 
 declare type FunctionLike = (...args: any) => any;
 
+declare interface FunctionMapping {
+    name: string;
+    decl: Range_2;
+    loc: Range_2;
+    line: number;
+}
+
 declare type GeneratedColumn = number;
 
 declare function getMatcherUtils(): {
@@ -739,6 +871,17 @@ declare class GithubActionsReporter {
     }): Promise<void>;
 }
 
+declare interface HtmlOptions {
+    verbose: boolean;
+    skipEmpty: boolean;
+    subdir: string;
+    linkMapper: LinkMapper;
+}
+
+declare interface HtmlSpaOptions extends HtmlOptions {
+    metricsToShow: Array<"lines" | "branches" | "functions" | "statements">;
+}
+
 declare type Indent = (arg0: string) => string;
 
 declare interface InlineSnapshotMatcher<T> {
@@ -1139,6 +1282,10 @@ declare interface JestAssertion<T = any> extends jest.Matchers<void, T>, CustomM
     	nthReturnedWith: <E>(nthCall: number, value: E) => void;
 }
 
+declare type JsonOptions = FileOptions;
+
+declare type JsonSummaryOptions = FileOptions;
+
 declare class JUnitReporter implements Reporter {
     private rootPath;
     private outputPath?;
@@ -1161,6 +1308,21 @@ declare class JUnitReporter implements Reporter {
     }): Promise<void>;
 }
 
+declare interface LcovOnlyOptions extends FileOptions, ProjectOptions {}
+
+declare interface LcovOptions extends FileOptions, ProjectOptions {}
+
+declare interface LinkMapper {
+    getPath(node: string | Node_2): string;
+    relativePath(source: string | Node_2, target: string | Node_2): string;
+    assetPath(node: Node_2, name: string): string;
+}
+
+declare interface Location_2 {
+    line: number;
+    column: number;
+}
+
 declare function matcherHint(matcherName: string, received?: string, expected?: string, options?: MatcherHintOptions): string;
 
 declare interface MatcherHintOptions {
@@ -1666,23 +1828,36 @@ declare interface NewPlugin {
     	test: Test;
 }
 
-declare type NormalizedConfig = Required<Omit<RstestConfig, OptionalKeys | 'pool' | 'projects' | 'coverage'>> & {
+declare interface Node_2 {
+    isRoot(): boolean;
+    visit(visitor: Visitor, state: any): void;
+}
+
+declare type NormalizedConfig = Required<Omit<RstestConfig, OptionalKeys | 'pool' | 'projects' | 'coverage' | 'setupFiles' | 'exclude'>> & {
     [key in OptionalKeys]?: RstestConfig[key];
 } & {
     pool: RstestPoolOptions;
     coverage: NormalizedCoverageOptions;
+    setupFiles: string[];
+    exclude: {
+        patterns: string[];
+        override?: boolean;
+    };
 };
 
-export declare type NormalizedCoverageOptions = Required<Omit<CoverageOptions, 'thresholds'>> & {
+export declare type NormalizedCoverageOptions = Required<Omit<CoverageOptions, 'thresholds' | 'include'>> & {
     thresholds?: CoverageThresholds;
+    include?: string[];
 };
 
 declare type NormalizedProcedure<T extends Procedure> = (...args: Parameters<T>) => ReturnType<T>;
 
 declare type NormalizedProcedure_2<T extends Procedure_2> = (...args: Parameters<T>) => ReturnType<T>;
 
-declare type NormalizedProjectConfig = Required<Omit<NormalizedConfig, OptionalKeys | 'projects' | 'reporters' | 'pool'>> & {
+declare type NormalizedProjectConfig = Required<Omit<NormalizedConfig, OptionalKeys | 'projects' | 'reporters' | 'pool' | 'setupFiles'>> & {
     [key in OptionalKeys]?: NormalizedConfig[key];
+} & {
+    setupFiles: string[];
 };
 
 declare interface OldPlugin {
@@ -1706,7 +1881,7 @@ declare type OnTestFinishedHandler = (params: {
     };
 }) => MaybePromise<void>;
 
-declare type OptionalKeys = 'setupFiles' | 'testNamePattern' | 'plugins' | 'source' | 'resolve' | 'output' | 'performance' | 'tools' | 'dev' | 'onConsoleLog';
+declare type OptionalKeys = 'testNamePattern' | 'plugins' | 'source' | 'resolve' | 'output' | 'performance' | 'tools' | 'dev' | 'onConsoleLog';
 
 declare type OptionsReceived = PrettyFormatOptions;
 
@@ -1769,6 +1944,10 @@ declare type ProjectContext = {
     normalizedConfig: NormalizedProjectConfig;
 };
 
+declare interface ProjectOptions {
+    projectRoot: string;
+}
+
 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> = {
@@ -1779,6 +1958,11 @@ declare type PromisifyAssertion<T> = Promisify<Assertion_2<T>>;
 
 declare type PromisifyAssertion_2<T> = Promisify_2<Assertion<T>>;
 
+declare interface Range_2 {
+    start: Location_2;
+    end: Location_2;
+}
+
 declare interface RawMatcherFn<
 	T extends MatcherState = MatcherState,
 	E extends Array<any> = Array<any>
@@ -1837,6 +2021,22 @@ declare const reportersMap: {
 
 declare type ReporterWithOptions<Name extends BuiltInReporterNames = BuiltInReporterNames> = Name extends keyof BuiltinReporterOptions ? [Name, Partial<BuiltinReporterOptions[Name]>] : [Name, Record<string, unknown>];
 
+declare interface ReportOptions {
+    clover: CloverOptions;
+    cobertura: CoberturaOptions;
+    "html-spa": HtmlSpaOptions;
+    html: HtmlOptions;
+    json: JsonOptions;
+    "json-summary": JsonSummaryOptions;
+    lcov: LcovOptions;
+    lcovonly: LcovOnlyOptions;
+    none: never;
+    teamcity: TeamcityOptions;
+    text: TextOptions;
+    "text-lcov": TextLcovOptions;
+    "text-summary": TextSummaryOptions;
+}
+
 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;
@@ -1890,7 +2090,14 @@ export declare interface RstestConfig {
      *
      * @default ['**\/node_modules/**', '**\/dist/**']
      */
-    exclude?: string[];
+    exclude?: string[] | {
+        patterns: string[];
+        /**
+         * override default exclude patterns
+         * @default false
+         */
+        override?: boolean;
+    };
     /**
      * A list of glob patterns that match your in-source test files
      *
@@ -2010,6 +2217,8 @@ export declare interface RstestConfig {
      * Custom handler for console log in tests
      */
     onConsoleLog?: (content: string) => boolean | void;
+    /** Format snapshot output */
+    snapshotFormat?: SnapshotFormat;
     /**
      * Coverage options
      */
@@ -2211,7 +2420,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'>;
 
 declare type RuntimeOptions = Partial<Pick<RuntimeConfig, 'testTimeout' | 'hookTimeout' | 'clearMocks' | 'resetMocks' | 'restoreMocks' | 'maxConcurrency' | 'retry'>>;
 
@@ -2231,6 +2440,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;
@@ -2411,6 +2622,10 @@ declare interface SyncExpectationResult {
     	expected?: any;
 }
 
+declare interface TeamcityOptions extends FileOptions {
+    blockName: string;
+}
+
 declare type Test = (arg0: any) => boolean;
 
 export declare const test: Rstest['test'];
@@ -2460,6 +2675,7 @@ export declare type TestFileInfo = {
 export declare type TestFileResult = TestResult & {
     results: TestResult[];
     snapshotResult?: SnapshotResult;
+    coverage?: CoverageMapData;
 };
 
 declare type TestFn<ExtraContext = object> = (description: string, fn?: TestCallbackFn<ExtraContext>, timeout?: number) => void;
@@ -2489,16 +2705,22 @@ export declare type TestResult = {
 
 declare type TestResultStatus = 'skip' | 'pass' | 'fail' | 'todo';
 
-declare type Thresholds = {
-    /** Thresholds for statements */
-    statements?: number;
-    /** Thresholds for functions */
-    functions?: number;
-    /** Thresholds for branches */
-    branches?: number;
-    /** Thresholds for lines */
-    lines?: number;
-};
+declare type TextLcovOptions = ProjectOptions;
+
+declare interface TextOptions extends FileOptions {
+    maxCols: number;
+    skipEmpty: boolean;
+    skipFull: boolean;
+}
+
+declare type TextSummaryOptions = FileOptions;
+
+declare interface Totals {
+    total: number;
+    covered: number;
+    skipped: number;
+    pct: number;
+}
 
 declare class TraceMap implements SourceMap {
     version: SourceMapV3['version'];
@@ -2536,6 +2758,14 @@ declare class VerboseReporter extends DefaultReporter {
     onTestFileResult(test: TestFileResult): void;
 }
 
+declare interface Visitor<N extends Node_2 = Node_2> {
+    onStart(root: N, state: any): void;
+    onSummary(root: N, state: any): void;
+    onDetail(root: N, state: any): void;
+    onSummaryEnd(root: N, state: any): void;
+    onEnd(root: N, state: any): void;
+}
+
 declare type VitestAssertion<
 	A,
 	T