@barney-media/crap-typescript-vitest
Vitest adapter for crap-typescript. Enables Istanbul JSON coverage output and reports CRAP scores after test runs.
Install
npm install --save-dev @barney-media/crap-typescript-vitest [email protected] @vitest/[email protected] vite@^8.3.4
Vitest 4 and 5 are supported. Install the same version of vitest and @vitest/coverage-v8; the clean-consumer
matrix exercises 4.1.12 and 5.0.5. For Vitest 4, replace both 5.0.5 versions above with 4.1.12.
Install Vite explicitly, particularly with Yarn, because Vitest 5 declares it as a required peer.
Node.js 22/24/26 are fully supported on Windows, macOS, and Linux; use current security patches.
Setup
import { withCrapTypescriptVitest } from "@barney-media/crap-typescript-vitest";
export default withCrapTypescriptVitest({
test: {
include: ["test/**/*.test.ts"]
}
});
withCrapTypescriptVitest wraps your Vitest config to enable coverage collection and register the CRAP reporter. The test run fails when any function exceeds the CRAP threshold.
If test.coverage.enabled is explicitly false, the helper preserves that value and does not register the CRAP reporter. Coverage provider, reporter, and directory settings are still normalized, but threshold enforcement resumes only when coverage is enabled again.
When test.reporters is omitted, the helper keeps the default reporter and adds the CRAP reporter. An explicit
reporter value or array replaces that default; the helper preserves the configured entries and adds only the CRAP
reporter. When coverage.reporter is omitted, it defaults to json and text. An explicit coverage reporter value is
preserved and augmented only with the required json reporter when needed. Set both reporter options to empty arrays to
keep only the CRAP and JSON reporters and suppress Vitest's test and coverage terminal reports.
The reporter defaults primary format to none, so it emits no primary stdout report unless configured. It enables junit by default and writes a full sidecar for CI test-report UIs. With the default coverage report path, the sidecar is coverage/crap-typescript-junit.xml; custom coverage paths derive a matching sidecar path. Pass format, agent, failuresOnly, omitRedundancy, output, junit, junitReport, threshold, excludes, excludePathRegexes, excludeGeneratedMarkers, or useDefaultExclusions in the adapter options to customize analysis and reporting. Set junit: false to disable the JUnit artifact.
agent: true defaults primary output to format: "toon", failuresOnly: true, and omitRedundancy: true. Explicit format, failuresOnly: false, or omitRedundancy: false options override those defaults. JUnit sidecars are full reports and are not affected by agent, failuresOnly, or omitRedundancy.
Baseline analyzability exclusions always skip declarations, test/spec files, __tests__/, dist/, coverage/, and node_modules/. Generated-code defaults exclude generated directory segments, exact gen directory segments, common generated filename suffixes, protobuf outputs, Angular generated artifacts, and leading generated-header markers. User exclusions compose with defaults unless useDefaultExclusions: false; full reports and JUnit sidecars include exclusion audit counts when files were excluded.
The default threshold is 6.0; values below 4.0 or above 8.0 print the same threshold guidance warnings as the CLI.
Exit code 2 means the CRAP threshold was exceeded. Reporter errors such as invalid options, missing coverage, or report-write failures use exit code 1.
See the main documentation for full details.