@nikovirtala/projen-constructs
    Preparing search index...

    Interface VitestConfigOptions

    Vitest Config.

    https://vitest.dev/config/

    interface VitestConfigOptions {
        bail?: number;
        coverageDirectory?: string;
        coverageEnabled?: boolean;
        coverageProvider?: CoverageProvider;
        coverageReporters?: CoverageReporter[];
        environment?: Environment;
        exclude?: string[];
        globals?: boolean;
        include?: string[];
        isolate?: boolean;
        passWithNoTests?: boolean;
        pool?: Pool;
        printConsoleTrace?: boolean;
        slowTestThreshold?: number;
        typecheckChecker?: string;
        typecheckEnabled?: boolean;
        typecheckTsconfig?: string;
        updateSnapshots?: boolean;
    }
    Index

    Properties

    bail? coverageDirectory? coverageEnabled? coverageProvider? coverageReporters? environment? exclude? globals? include? isolate? passWithNoTests? pool? printConsoleTrace? slowTestThreshold? typecheckChecker? typecheckEnabled? typecheckTsconfig? updateSnapshots?

    Properties

    bail?: number

    Stop running tests after certain number of failures.

    0

    https://vitest.dev/config/#bail

    coverageDirectory?: string

    Coverage output directory.

    "coverage"
    coverageEnabled?: boolean

    Coverage enabled.

    true

    https://vitest.dev/config/#coverage-enabled

    coverageProvider?: CoverageProvider

    Coverage provider type.

    "v8"

    https://vitest.dev/config/#coverage-provider

    coverageReporters?: CoverageReporter[]

    Coverage reporters.

    '["text", "lcov"]'

    https://vitest.dev/config/#coverage-reporter

    environment?: Environment

    The environment that will be used for testing.

    "node"

    https://vitest.dev/config/#environment

    exclude?: string[]

    A list of glob patterns that should be excluded from your test files.

    • Vitest's configDefaults.exclude

    https://vitest.dev/config/#exclude

    globals?: boolean

    Register apis globally. If you prefer to use the APIs globally like Jest, set to true.

    false

    https://vitest.dev/config/#globals

    include?: string[]

    A list of glob patterns that match your test files.

    • Vitest's configDefaults.include

    https://vitest.dev/config/#include

    isolate?: boolean

    Run tests in an isolated environment. This option has no effect on vmThreads pool.

    Disabling this option might improve performance if your code doesn't rely on side effects.

    true

    https://vitest.dev/config/#isolate

    passWithNoTests?: boolean

    Vitest will not fail, if no tests will be found.

    true

    https://vitest.dev/config/#passwithnotests

    pool?: Pool

    Pool used to run tests in.

    "forks"

    https://vitest.dev/config/#pool

    printConsoleTrace?: boolean

    Always print console traces when calling any console method.

    true

    https://vitest.dev/config/#consoletrace

    slowTestThreshold?: number

    The number of milliseconds after which a test or suite is considered slow.

    300

    https://vitest.dev/config/#slowtestthreshold

    typecheckChecker?: string

    Tool to use for type checking. Checker should implement the same output format as tsc.

    "tsc --noEmit"

    https://vitest.dev/config/#typecheck-checker

    typecheckEnabled?: boolean

    Enable typechecking alongside your regular tests.

    true (for TypeScript projects)

    https://vitest.dev/config/#typecheck-enabled

    typecheckTsconfig?: string

    Path to custom tsconfig, relative to the project root.

    "tsconfig.dev.json"

    https://vitest.dev/config/#typecheck-tsconfig

    updateSnapshots?: boolean

    Update snapshot files. This will update all changed snapshots and delete obsolete ones.

    true

    https://vitest.dev/guide/snapshot.html#updating-snapshots

    Settings

    Member Visibility

    On This Page

    Properties