@rstest/core 0.1.2 → 0.2.0

package/dist-types/node.d.ts

@@ -1,450 +0,0 @@
-import type { RsbuildConfig } from '@rsbuild/core';
-
-declare type BuiltInReporterNames = keyof typeof reportersMap;
-
-declare type BuiltinReporterOptions = {
-    default: DefaultReporterOptions;
-};
-
-declare interface DecodedSourceMap extends SourceMapV3 {
-    mappings: SourceMapSegment[][];
-}
-
-declare type DecodedSourceMapXInput = DecodedSourceMap & XInput;
-
-declare class DefaultReporter implements Reporter {
-    protected rootPath: string;
-    protected config: NormalizedConfig;
-    private options;
-    protected statusRenderer: StatusRenderer | undefined;
-    constructor({ rootPath, options, config, }: {
-        rootPath: string;
-        config: NormalizedConfig;
-        options: DefaultReporterOptions;
-    });
-    onTestFileStart(test: TestFileInfo): void;
-    onTestFileResult(test: TestFileResult): void;
-    onTestCaseResult(_result: TestResult): void;
-    onUserConsoleLog(log: UserConsoleLog): void;
-    onExit(): Promise<void>;
-    onTestRunEnd({ results, testResults, duration, getSourcemap, snapshotSummary, }: {
-        results: TestFileResult[];
-        testResults: TestResult[];
-        duration: Duration;
-        snapshotSummary: SnapshotSummary;
-        getSourcemap: GetSourcemap;
-    }): Promise<void>;
-}
-
-declare type DefaultReporterOptions = {
-    /**
-     * prints out summary of all tests
-     * @default true
-     */
-    summary?: boolean;
-};
-
-declare type Duration = {
-    totalTime: number;
-    buildTime: number;
-    testTime: number;
-};
-
-declare interface EncodedSourceMap extends SourceMapV3 {
-    mappings: string;
-}
-
-declare type EncodedSourceMapXInput = EncodedSourceMap & XInput;
-
-declare type FormattedError = {
-    fullStack?: boolean;
-    message: string;
-    name?: string;
-    stack?: string;
-    diff?: string;
-};
-
-declare type GeneratedColumn = number;
-
-declare type GetSourcemap = (sourcePath: string) => SourceMapInput | null;
-
-declare class GithubActionsReporter {
-    private onWritePath;
-    private rootPath;
-    constructor({ options, rootPath, }: {
-        rootPath: string;
-        options: {
-            onWritePath: (path: string) => string;
-        };
-    });
-    onTestRunEnd({ results, testResults, getSourcemap, }: {
-        results: TestFileResult[];
-        testResults: TestResult[];
-        duration: Duration;
-        snapshotSummary: SnapshotSummary;
-        getSourcemap: GetSourcemap;
-    }): Promise<void>;
-}
-
-declare type MaybePromise<T> = T | Promise<T>;
-
-declare type NamesIndex = number;
-
-declare type NormalizedConfig = Required<Omit<RstestConfig, OptionalKeys | 'pool'>> & {
-    [key in OptionalKeys]?: RstestConfig[key];
-} & {
-    pool: RstestPoolOptions;
-};
-
-declare type OptionalKeys = 'setupFiles' | 'testNamePattern' | 'plugins' | 'source' | 'resolve' | 'output' | 'performance' | 'tools' | 'dev' | 'onConsoleLog';
-
-export declare interface Reporter {
-    /**
-     * Called before test file run.
-     */
-    onTestFileStart?: (test: TestFileInfo) => void;
-    /**
-     * Called when the test file has finished running.
-     */
-    onTestFileResult?: (test: TestFileResult) => void;
-    /**
-     * Called when the test has finished running or was just skipped.
-     */
-    onTestCaseResult?: (result: TestResult) => void;
-    /**
-     * Called after all tests have finished running.
-     */
-    onTestRunEnd?: ({ results, testResults, duration, getSourcemap, snapshotSummary, }: {
-        results: TestFileResult[];
-        testResults: TestResult[];
-        duration: Duration;
-        getSourcemap: GetSourcemap;
-        snapshotSummary: SnapshotSummary;
-    }) => MaybePromise<void>;
-    /**
-     * Called when console log is calling.
-     */
-    onUserConsoleLog?: (log: UserConsoleLog) => void;
-    /**
-     * Called when rstest exit abnormally
-     */
-    onExit?: () => void;
-}
-
-declare const reportersMap: {
-    default: typeof DefaultReporter;
-    verbose: typeof VerboseReporter;
-    'github-actions': typeof GithubActionsReporter;
-};
-
-declare type ReporterWithOptions<Name extends BuiltInReporterNames = BuiltInReporterNames> = Name extends keyof BuiltinReporterOptions ? [Name, Partial<BuiltinReporterOptions[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>[];
-
-declare type RoObject<T> = {
-    [K in keyof T]: T[K] | Ro<T[K]>;
-};
-
-export declare type RstestCommand = 'watch' | 'run' | 'list';
-
-export declare interface RstestConfig {
-    /**
-     * Project root
-     *
-     * @default process.cwd()
-     */
-    root?: string;
-    /**
-     * Project name
-     *
-     * @default rstest
-     */
-    name?: string;
-    /**
-     * A list of glob patterns that match your test files.
-     *
-     * @default ['**\/*.{test,spec}.?(c|m)[jt]s?(x)']
-     */
-    include?: string[];
-    /**
-     * A list of glob patterns that should be excluded from your test files.
-     *
-     * @default ['**\/node_modules/**', '**\/dist/**']
-     */
-    exclude?: string[];
-    /**
-     * A list of glob patterns that match your in-source test files
-     *
-     * @default []
-     */
-    includeSource?: string[];
-    /**
-     * Path to setup files. They will be run before each test file.
-     */
-    setupFiles?: string[] | string;
-    /**
-     * Retry the test specific number of times if it fails.
-     * @default 0
-     */
-    retry?: number;
-    /**
-     * Pass when no tests are found.
-     *
-     * @default false
-     */
-    passWithNoTests?: boolean;
-    /**
-     * Pool used to run tests in.
-     */
-    pool?: RstestPoolType | RstestPoolOptions;
-    /**
-     * Run tests in an isolated environment
-     *
-     * @default true
-     */
-    isolate?: boolean;
-    /**
-     * Provide global APIs
-     *
-     * @default false
-     */
-    globals?: boolean;
-    /**
-     * The environment that will be used for testing
-     *
-     * @default 'node'
-     */
-    testEnvironment?: 'node' | 'jsdom' | 'happy-dom';
-    /**
-     * print console traces when calling any console method.
-     *
-     * @default false
-     */
-    printConsoleTrace?: boolean;
-    /**
-     * Disable console intercept. `onConsoleLog` & `printConsoleTrace` configuration will not take effect.
-     *
-     * @default false
-     */
-    disableConsoleIntercept?: boolean;
-    /**
-     * Update snapshot files. Will update all changed snapshots and delete obsolete ones.
-     *
-     * @default false
-     */
-    update?: boolean;
-    /**
-     * Custom reporter for output.
-     * @default ['default']
-     */
-    reporters?: Reporter | BuiltInReporterNames | (Reporter | BuiltInReporterNames | [BuiltInReporterNames] | ReporterWithOptions)[];
-    /**
-     * Run only tests with a name that matches the regex.
-     */
-    testNamePattern?: string | RegExp;
-    /**
-     * Timeout of a test in milliseconds.
-     * @default 5000
-     */
-    testTimeout?: number;
-    /**
-     * Timeout of hook in milliseconds.
-     * @default 10000
-     */
-    hookTimeout?: number;
-    /**
-     * Automatically clear mock calls, instances, contexts and results before every test.
-     * @default false
-     */
-    clearMocks?: boolean;
-    /**
-     * Automatically reset mock state before every test.
-     * @default false
-     */
-    resetMocks?: boolean;
-    /**
-     * Automatically restore mock state and implementation before every test.
-     * @default false
-     */
-    restoreMocks?: boolean;
-    /**
-     * The number of milliseconds after which a test or suite is considered slow and reported as such in the results.
-     * @default 300
-     */
-    slowTestThreshold?: number;
-    /**
-     * Restores all global variables that were changed with `rstest.stubGlobal` before every test.
-     * @default false
-     */
-    unstubGlobals?: boolean;
-    /**
-     * Restores all `process.env` values that were changed with `rstest.stubEnv` before every test.
-     * @default false
-     */
-    unstubEnvs?: boolean;
-    /**
-     * Maximum number of concurrent tests
-     * @default 5
-     */
-    maxConcurrency?: number;
-    /**
-     * Custom handler for console log in tests
-     */
-    onConsoleLog?: (content: string) => boolean | void;
-    plugins?: RsbuildConfig['plugins'];
-    source?: Pick<NonNullable<RsbuildConfig['source']>, 'define' | 'tsconfigPath' | 'decorators' | 'include' | 'exclude'>;
-    performance?: Pick<NonNullable<RsbuildConfig['performance']>, 'bundleAnalyze'>;
-    dev?: Pick<NonNullable<RsbuildConfig['dev']>, 'writeToDisk'>;
-    output?: Pick<NonNullable<RsbuildConfig['output']>, 'cssModules' | 'externals' | 'cleanDistPath'>;
-    resolve?: RsbuildConfig['resolve'];
-    tools?: Pick<NonNullable<RsbuildConfig['tools']>, 'rspack' | 'swc' | 'bundlerChain'>;
-}
-
-declare type RstestPoolOptions = {
-    /** Pool used to run tests in. */
-    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. */
-    minWorkers?: number | string;
-    /** Pass additional arguments to node process in the child processes. */
-    execArgv?: string[];
-};
-
-declare type RstestPoolType = 'forks';
-
-declare interface SnapshotResult {
-    	filepath: string;
-    	added: number;
-    	fileDeleted: boolean;
-    	matched: number;
-    	unchecked: number;
-    	uncheckedKeys: Array<string>;
-    	unmatched: number;
-    	updated: number;
-}
-
-declare interface SnapshotSummary {
-    	added: number;
-    	didUpdate: boolean;
-    	failure: boolean;
-    	filesAdded: number;
-    	filesRemoved: number;
-    	filesRemovedList: Array<string>;
-    	filesUnmatched: number;
-    	filesUpdated: number;
-    	matched: number;
-    	total: number;
-    	unchecked: number;
-    	uncheckedKeysByFile: Array<UncheckedSnapshot>;
-    	unmatched: number;
-    	updated: number;
-}
-
-declare type SourceColumn = number;
-
-declare type SourceLine = number;
-
-declare abstract class SourceMap {
-    version: SourceMapV3['version'];
-    file: SourceMapV3['file'];
-    names: SourceMapV3['names'];
-    sourceRoot: SourceMapV3['sourceRoot'];
-    sources: SourceMapV3['sources'];
-    sourcesContent: SourceMapV3['sourcesContent'];
-    resolvedSources: SourceMapV3['sources'];
-    ignoreList: SourceMapV3['ignoreList'];
-}
-
-declare type SourceMapInput = string | EncodedSourceMapXInput | DecodedSourceMapXInput | TraceMap;
-
-declare type SourceMapSegment = [GeneratedColumn] | [GeneratedColumn, SourcesIndex, SourceLine, SourceColumn] | [GeneratedColumn, SourcesIndex, SourceLine, SourceColumn, NamesIndex];
-
-declare interface SourceMapV3 {
-    file?: string | null;
-    names: string[];
-    sourceRoot?: string;
-    sources: (string | null)[];
-    sourcesContent?: (string | null)[];
-    version: 3;
-    ignoreList?: number[];
-}
-
-declare type SourcesIndex = number;
-
-declare class StatusRenderer {
-    private rootPath;
-    private renderer;
-    private runningModules;
-    constructor(rootPath: string);
-    getContent(): string[];
-    addRunningModule(testPath: string): void;
-    removeRunningModule(testPath: string): void;
-    clear(): void;
-}
-
-export declare type TestFileInfo = {
-    testPath: TestPath;
-};
-
-export declare type TestFileResult = TestResult & {
-    results: TestResult[];
-    snapshotResult?: SnapshotResult;
-};
-
-/** The test file original path */
-declare type TestPath = string;
-
-export declare type TestResult = {
-    status: TestResultStatus;
-    name: string;
-    testPath: TestPath;
-    parentNames?: string[];
-    duration?: number;
-    errors?: FormattedError[];
-    retryCount?: number;
-};
-
-declare type TestResultStatus = 'skip' | 'pass' | 'fail' | 'todo';
-
-declare class TraceMap implements SourceMap {
-    version: SourceMapV3['version'];
-    file: SourceMapV3['file'];
-    names: SourceMapV3['names'];
-    sourceRoot: SourceMapV3['sourceRoot'];
-    sources: SourceMapV3['sources'];
-    sourcesContent: SourceMapV3['sourcesContent'];
-    ignoreList: SourceMapV3['ignoreList'];
-    resolvedSources: string[];
-    private _encoded;
-    private _decoded;
-    private _decodedMemo;
-    private _bySources;
-    private _bySourceMemos;
-    constructor(map: Ro<SourceMapInput>, mapUrl?: string | null);
-}
-
-declare interface UncheckedSnapshot {
-    	filePath: string;
-    	keys: Array<string>;
-}
-
-declare interface UserConsoleLog {
-    content: string;
-    name: string;
-    trace?: string;
-    testPath: TestPath;
-    type: 'stdout' | 'stderr';
-}
-
-declare class VerboseReporter extends DefaultReporter {
-    onTestFileResult(test: TestFileResult): void;
-}
-
-declare type XInput = {
-    x_google_ignoreList?: SourceMapV3['ignoreList'];
-};
-
-export { }