@systemfsoftware/stryker-js-vitest-runner 5.0.0 → 7.0.0

package/CHANGELOG.md

@@ -1,5 +1,69 @@
 # @systemfsoftware/stryker-js-vitest-runner
 
+## 7.0.0
+
+### Major Changes
+
+- The runner now requires vitest 4.1 or later, and the peer dependency says so:
+  `vitest >=4.1.0`.
+
+  Upgrade vitest to 4.1 or later before upgrading this package. Projects that must
+  stay below 4.1 should stay on the previous release.
+
+  The published bundle now also inlines `oxc-parser` and `@eslint-community/regexpp`
+  so they ship inside the runner's install. Consumers that previously resolved those
+  packages as transitive dependencies from another tool should now take them from
+  the runner's published bundle.
+
+## 6.0.0
+
+### Major Changes
+
+- `testRunner`, `checkers`, and `ignorers` now carry the plugin and its options together.
+
+  - `testRunner` is `'command'`, `'vm'`, or `{ plugin, options?, nodeArgs? }`.
+  - `checkers` is `{ plugin, options?, nodeArgs? }[]`. Each checker is its own plugin.
+  - `ignorers` is plugin file URLs. Every ignorer those modules export runs. There is no separate name list.
+  - Put Vitest settings on `testRunner.options` (`configFile`, `dir`, `related`). There is no `vitest` block.
+  - Put TypeScript checker settings on that checker's `options` (`prioritizePerformanceOverAccuracy`). There is no `typescriptChecker` block.
+
+  Before:
+
+  ```ts
+  export default defineConfig({
+    testRunner: 'vitest',
+    checkers: ['typescript'],
+    plugins: [
+      import.meta.resolve('@systemfsoftware/stryker-js-vitest-runner'),
+      import.meta.resolve('@systemfsoftware/stryker-js-typescript-checker'),
+      import.meta.resolve('@systemfsoftware/stryker-ignorer-effect-schema-declarations'),
+    ],
+    vitest: { configFile: 'vitest.config.ts' },
+    typescriptChecker: { prioritizePerformanceOverAccuracy: true },
+    ignorers: ['effect-schema-declarations'],
+  })
+  ```
+
+  After:
+
+  ```ts
+  export default defineConfig({
+    testRunner: {
+      plugin: import.meta.resolve('@systemfsoftware/stryker-js-vitest-runner'),
+      options: { configFile: 'vitest.config.ts' },
+    },
+    checkers: [
+      {
+        plugin: import.meta.resolve('@systemfsoftware/stryker-js-typescript-checker'),
+        options: { prioritizePerformanceOverAccuracy: true },
+      },
+    ],
+    ignorers: [
+      import.meta.resolve('@systemfsoftware/stryker-ignorer-effect-schema-declarations'),
+    ],
+  })
+  ```
+
 ## 5.0.0
 
 ### Major Changes

package/README.md

@@ -1,34 +1,77 @@
 # @systemfsoftware/stryker-js-vitest-runner
 
-Vitest test-runner plugin for Stryker
+[![License: Apache-2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](../../LICENSE)
+[![npm version](https://img.shields.io/npm/v/@systemfsoftware/stryker-js-vitest-runner.svg)](https://www.npmjs.com/package/@systemfsoftware/stryker-js-vitest-runner)
+
+Vitest test-runner plugin for Stryker mutation testing. Provides fast in-process sandboxing, per-test coverage tracking, and native TypeScript support.
+
+## Prerequisites
+
+- Node.js `>=22.18.0`
+- Vitest `>=2.0.0`
+- `@systemfsoftware/stryker-js` `>=5.0.0`
 
 ## Install
 
-```sh
-pnpm add @systemfsoftware/stryker-js-vitest-runner 'vitest@>=2.0.0'
+```bash
+pnpm add -D @systemfsoftware/stryker-js-vitest-runner vitest
 ```
 
-Those are peer dependencies: this package declares them but does not install them, so one copy is shared with the rest of your project.
+## Setup in `stryker.config.ts`
 
-## Entry points
+Plugins in Stryker 5.0 are resolved as `file:` URLs via `import.meta.resolve()`:
 
-- `@systemfsoftware/stryker-js-vitest-runner`
-- `@systemfsoftware/stryker-js-vitest-runner/stryker-setup`
+```ts
+import { defineConfig } from '@systemfsoftware/stryker-js/config'
+
+export default defineConfig({
+  testRunner: 'vitest',
+  plugins: [
+    import.meta.resolve('@systemfsoftware/stryker-js-vitest-runner'),
+  ],
+  mutate: [
+    'src/**/*.ts',
+    '!src/**/*.test.ts',
+    '!src/**/*.d.ts',
+  ],
+})
+```
 
-## Use
+## How It Works
 
-Name the plugin in your Stryker configuration:
+1. **Dry-run phase**: The Vitest runner executes your existing test suite, collecting per-test execution profiles and code coverage data.
+2. **Mutant sandbox**: During the mutation test phase, worker processes run only the subset of tests that cover each mutant, terminating early on test failure to maximize speed.
+3. **Vitest Config**: By default, Stryker automatically discovers your `vitest.config.ts` or `vite.config.ts`. If your configuration is located elsewhere, specify it in your config:
 
-```json
-{
-  "plugins": ["@systemfsoftware/stryker-js-vitest-runner"]
-}
+```ts
+export default defineConfig({
+  testRunner: 'vitest',
+  plugins: [import.meta.resolve('@systemfsoftware/stryker-js-vitest-runner')],
+  vitest: {
+    configFile: 'vitest.unit.config.ts',
+  },
+})
 ```
 
-## API
+## In-Source Tests (`import.meta.vitest`)
 
-The public surface ships as this package's type declarations in `dist`; no generated API report is carried in this repository.
+If your project uses in-source testing with `if (import.meta.vitest)` blocks, add the companion ignorer plugin so unreachable test mutants are excluded from your score:
+
+```bash
+pnpm add -D @systemfsoftware/stryker-ignorer-in-source-vitest-block
+```
+
+```ts
+export default defineConfig({
+  testRunner: {
+    plugin: import.meta.resolve('@systemfsoftware/stryker-js-vitest-runner'),
+  },
+  ignorers: [
+    import.meta.resolve('@systemfsoftware/stryker-ignorer-in-source-vitest-block'),
+  ],
+})
+```
 
 ## License
 
-Apache-2.0. Part of [systemfsoftware](https://github.com/systemfsoftware/stryker-js-effect#readme).
+[Apache-2.0](../../LICENSE)

package/dist/index.d.mts

@@ -4,12 +4,4 @@ export declare const strykerPlugins: readonly {
     readonly workerEntry: string;
 }[];
 
-/**
- * The `vitest` option section as a JSON Schema document, for Stryker's option
- * validation — derived from the declaration, never read from a file. It is built
- * here, at the entry that contributes it, because a document is a *use* of a
- * schema and the schema module exports only declarations.
- */
-export declare const strykerValidationSchema: Record<string, unknown>;
-
 export { }

package/dist/index.mjs

@@ -1,54 +1,8 @@
-import * as S from "effect/Schema";
-import { Effect } from "effect";
-import * as Predicate from "effect/Predicate";
-//#region src/Runner.schema.ts
-const VitestRunnerOptionsSchema = S.Struct({
-	dir: S.optional(S.String),
-	related: S.optional(S.Boolean).pipe(S.withDecodingDefault(Effect.succeed(true))),
-	configFile: S.optional(S.String)
-});
-S.optional(VitestRunnerOptionsSchema).pipe(S.withDecodingDefault(Effect.succeed({ related: true })));
-S.Struct({ hitCount: S.optional(S.Finite) });
-S.Struct({ mutantCoverage: S.optional(S.Struct({
-	static: S.Record(S.String, S.Finite),
-	perTest: S.Record(S.String, S.Record(S.String, S.Finite))
-})) });
-S.Struct({
-	static: S.Record(S.String, S.Finite),
-	perTest: S.Record(S.String, S.Record(S.String, S.Finite))
-});
-S.TaggedError()("CoverageDecodeFailed", { cause: S.Unknown });
-const ExportEntry = S.Union([S.String, S.Record(S.String, S.Unknown)]);
-S.StructWithRest(S.Struct({
-	name: S.optional(S.String),
-	exports: S.optional(S.Record(S.String, ExportEntry))
-}), [S.Record(S.String, S.Unknown)]);
-S.declare((input) => Predicate.isObject(input), { description: "The project-local vitest/node module" });
-S.Struct({ version: S.String });
-S.TaggedClass()("VitestDryRunCommand", {
-	rawTests: S.Array(S.Unknown),
-	projectRoot: S.String,
-	hasExternalError: S.Boolean,
-	externalErrorText: S.String
-});
-S.TaggedClass()("Complete", { testsJson: S.String });
-S.TaggedClass()("Error", {
-	testsJson: S.String,
-	errorMessage: S.String
-});
-//#endregion
 //#region src/index.ts
 const strykerPlugins = [{
 	kind: "TestRunner",
 	name: "vitest",
 	workerEntry: new URL("./main.mjs", import.meta.url).href
 }];
-/**
-* The `vitest` option section as a JSON Schema document, for Stryker's option
-* validation — derived from the declaration, never read from a file. It is built
-* here, at the entry that contributes it, because a document is a *use* of a
-* schema and the schema module exports only declarations.
-*/
-const strykerValidationSchema = S.toJsonSchemaDocument(S.Struct({ vitest: S.optional(VitestRunnerOptionsSchema) })).schema;
 //#endregion
-export { strykerPlugins, strykerValidationSchema };
+export { strykerPlugins };