@systemfsoftware/stryker-js-typescript-checker 6.0.0 → 7.0.0

package/CHANGELOG.md

@@ -1,5 +1,59 @@
 # @systemfsoftware/stryker-js-typescript-checker
 
+## 7.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'),
+    ],
+  })
+  ```
+
+### Patch Changes
+
+- Updated dependencies:
+  - @systemfsoftware/stryker-js-plugin-interface@6.0.0
+
 ## 6.0.0
 
 ### Major Changes

package/README.md

@@ -1,27 +1,43 @@
 # @systemfsoftware/stryker-js-typescript-checker
 
-TypeScript checker plugin for Stryker — TS7 native
+[![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-typescript-checker.svg)](https://www.npmjs.com/package/@systemfsoftware/stryker-js-typescript-checker)
 
-## Install
+TypeScript checker plugin for Stryker mutation testing — provides native support for TypeScript 5.x through 7.x.
 
-```sh
-pnpm add @systemfsoftware/stryker-js-typescript-checker
-```
+## Why Use a Type Checker Plugin?
+
+Mutation testing modifies code syntax in ways that may cause compiler errors (e.g. invalid type assignments, breaking return type contracts). Without a checker plugin, those mutants execute in your test runner, waste runner execution time, or trigger misleading test runner errors.
+
+The TypeScript checker intercepts mutants _before_ they reach the test runner. If a mutant causes a TypeScript compilation failure, it is classified immediately as `CompileError` without spinning up test runner workers.
 
-## Entry points
+## Prerequisites
 
-- `@systemfsoftware/stryker-js-typescript-checker`
+- Node.js `>=22.18.0`
+- TypeScript `>=5.0.0`
+- `@systemfsoftware/stryker-js` `>=5.0.0`
+
+## Install
+
+```bash
+pnpm add -D @systemfsoftware/stryker-js-typescript-checker typescript
+```
 
-## Use
+## Setup in `stryker.config.ts`
 
-Name the plugin in your Stryker configuration:
+```ts
+import { defineConfig } from '@systemfsoftware/stryker-js/config'
 
-```json
-{
-  "plugins": ["@systemfsoftware/stryker-js-typescript-checker"]
-}
+export default defineConfig({
+  checkers: ['typescript'],
+  plugins: [
+    import.meta.resolve('@systemfsoftware/stryker-js-typescript-checker'),
+  ],
+  // Optional custom tsconfig path (defaults to tsconfig.json)
+  // tsConfigFile: 'tsconfig.build.json',
+})
 ```
 
 ## License
 
-Apache-2.0. Part of [systemfsoftware](https://github.com/systemfsoftware/stryker-js-effect/tree/main/packages/stryker-js-typescript-checker#readme).
+[Apache-2.0](../../LICENSE)

package/dist/index.d.mts

@@ -1,8 +1,7 @@
-//#region src/index.d.ts
-export declare const strykerPlugins: readonly {
-  readonly kind: 'Checker';
-  readonly name: string;
-  readonly workerEntry: string;
-}[];
-export declare const strykerValidationSchema: Record<string, unknown>;
-//#endregion
+export declare const strykerPlugins: readonly {
+    readonly kind: 'Checker';
+    readonly name: string;
+    readonly workerEntry: string;
+}[];
+
+export { }

package/dist/index.mjs

@@ -1,32 +1,8 @@
-import * as S from "effect/Schema";
-//#region schema/typescript-checker-options.json
-var typescript_checker_options_default = {
-	$schema: "http://json-schema.org/draft-07/schema",
-	title: "TypescriptCheckerPluginOptions",
-	type: "object",
-	additionalProperties: false,
-	properties: { "typescriptChecker": {
-		"description": "Configuration for @systemfsoftware/stryker-js-typescript-checker",
-		"title": "TypescriptCheckerOptions",
-		"additionalProperties": false,
-		"type": "object",
-		"default": {},
-		"properties": { "prioritizePerformanceOverAccuracy": {
-			"description": "Configures the performance of the TypescriptChecker. Setting this to false results in a slower, but more accurate result.",
-			"type": "boolean",
-			"default": true
-		} }
-	} }
-};
-//#endregion
 //#region src/index.ts
 const strykerPlugins = [{
 	kind: "Checker",
 	name: "typescript",
 	workerEntry: new URL("./main.mjs", import.meta.url).href
 }];
-const rawSchema = typescript_checker_options_default;
-if (!S.is(S.Record(S.String, S.Unknown))(rawSchema)) throw new Error("Invalid typescript-checker schema file");
-const strykerValidationSchema = rawSchema;
 //#endregion
-export { strykerPlugins, strykerValidationSchema };
+export { strykerPlugins };