@systemfsoftware/stryker-js-typescript-checker 3.0.2 → 4.0.0

package/CHANGELOG.md

@@ -1,5 +1,26 @@
 # @systemfsoftware/stryker-js-typescript-checker
 
+## 4.0.0
+
+### Major Changes
+
+- CheckMutantsDecision is now a branded tagged union CheckFinished|RetestRequired instead of a plain record; consumer dispatch is exhaustive over the tags
+
+### Patch Changes
+
+- Updated dependencies:
+  - @systemfsoftware/effect-cell-types@6.0.0
+  - @systemfsoftware/stryker-js@1.0.0
+
+## 3.0.3
+
+### Patch Changes
+
+- Refreshed builds on the platform-services dependency graph; the packages no longer reach for host builtins directly. No CLI flags or option names change.
+
+- Updated dependencies:
+  - @systemfsoftware/stryker-js@0.2.0
+
 ## 3.0.2
 
 ### Patch Changes

package/dist/index.mjs

@@ -1,4 +1,3 @@
-import { readFileSync } from "fs";
 import { Checker, CheckerFailed } from "@systemfsoftware/stryker-js/Checker";
 import { RunConfiguration, declarePlugin } from "@systemfsoftware/stryker-js/Plugin";
 import * as Effect from "effect/Effect";
@@ -6,62 +5,41 @@ import * as FileSystem from "effect/FileSystem";
 import * as Layer from "effect/Layer";
 import * as Path from "effect/Path";
 import * as S from "effect/Schema";
-import { EOL } from "os";
 import { Cell, Wire, Workflow } from "@systemfsoftware/effect-cell-types";
 import { Mutant, errorToString } from "@systemfsoftware/stryker-js/Mutant";
 import { Predicate, Result, Schema } from "effect";
-import { pipe } from "effect/Function";
 import * as HashMap from "effect/HashMap";
+import * as Match from "effect/Match";
 import * as MutableHashMap from "effect/MutableHashMap";
 import * as Option from "effect/Option";
 import { API, DiagnosticCategory } from "typescript/unstable/sync";
 import * as Result$1 from "effect/Result";
-import { createRequire } from "module";
 import { StrykerOptionsSchema } from "@systemfsoftware/stryker-js/Schema";
 import * as Context from "effect/Context";
 import * as MutableHashSet from "effect/MutableHashSet";
 import * as Ref from "effect/Ref";
 import { SyntaxKind } from "typescript/unstable/ast";
-//#region src/Checker.schema.ts
-/**
-* Checker — declarations for the TypeScript checker.
-*
-* Houses the wire types and error variants shared by the capability and its
-* workflow. Decoded at the checker boundary; no I/O.
-*/
-var CheckMutantsCommand = class extends S.TaggedClass()("CheckMutantsCommand", { mutants: S.Array(Mutant) }) {};
-/**
-* Every way the TypeScript compiler can fail while serving a check.
-* One tagged error — callers branch only on failure itself; `reason` keeps
-* cases distinguishable in reports.
-*/
-var CompilerFailed = class extends S.TaggedError()("CompilerFailed", {
-	reason: S.Literals([
-		"not-initialized",
-		"no-projects",
-		"unknown-file-node",
-		"file-not-in-project"
-	]),
-	subject: S.optional(S.String)
-}) {
-	get message() {
-		switch (this.reason) {
-			case "not-initialized": return "The TypeScript compiler was used before it was initialized";
-			case "no-projects": return `No projects were found for ${this.subject ?? "the tsconfig"}`;
-			case "unknown-file-node": return `The file graph has no node for '${this.subject ?? "a file"}', which should not happen`;
-			case "file-not-in-project": return `'${this.subject ?? "a file"}' is part of your TypeScript project but could not be found on disk`;
-		}
-	}
+//#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/Checker.workflow.ts
-/**
-* Checker — pure check decision.
-*
-* `Workflow.make` lives here and only here. The workflow receives a fully
-* decoded input (mutants + diagnostics + file graph) and produces results plus
-* `needsRetest` without touching I/O.
-*/
+//#region src/check-mutants.workflow.ts
 var DiagnosticWithoutFileError = class extends S.TaggedError()("DiagnosticWithoutFileError", { text: Wire.mint(S.String) }) {};
 var DiagnosticInUnrelatedFileError = class extends S.TaggedError()("DiagnosticInUnrelatedFileError", {
 	text: Wire.mint(S.String),
@@ -81,6 +59,20 @@ var CheckMutantsInput = class extends S.TaggedClass()("CheckMutantsInput", {
 	diagnostics: S.Array(DiagnosticSchema),
 	nodes: Wire.mint(S.Record(Wire.mint(S.String), TSFileNodeSchema))
 }) {};
+const CheckMutantsTypeId = Symbol.for("@systemfsoftware/stryker-js-typescript-checker/CheckMutants");
+const MutantCheckStatusSchema = S.Union([S.Struct({ status: S.Literal("passed") }), S.Struct({
+	status: S.Literal("compileError"),
+	reason: S.String
+})]);
+var CheckFinished = class extends S.TaggedClass()("CheckFinished", { results: S.Record(S.String, MutantCheckStatusSchema) }) {
+	[CheckMutantsTypeId] = CheckMutantsTypeId;
+};
+var RetestRequired = class extends S.TaggedClass()("RetestRequired", {
+	results: S.Record(S.String, MutantCheckStatusSchema),
+	needsRetest: S.Array(Mutant)
+}) {
+	[CheckMutantsTypeId] = CheckMutantsTypeId;
+};
 const normalizeFileName$3 = (fileName) => fileName.replace(/\\/g, "/");
 const getMutantsWithReferenceToChildrenOrSelf = (node, mutants, nodesChecked = []) => {
 	if (nodesChecked.includes(node.fileName)) return [];
@@ -131,18 +123,12 @@ const buildResult = (input) => {
 	const mutants = input.mutants;
 	const diagnostics = input.diagnostics;
 	const nodes = input.nodes;
-	if (mutants.length === 0) return Result$1.succeed({
-		results: {},
-		needsRetest: []
-	});
+	if (mutants.length === 0) return Result$1.succeed(CheckFinished.make({ results: {} }));
 	const first = mutants[0];
 	if (first === void 0 || nodes[normalizeFileName$3(first.fileName)] === void 0) {
 		const results = {};
 		for (const m of mutants) results[m.id] = { status: "passed" };
-		return Result$1.succeed({
-			results,
-			needsRetest: []
-		});
+		return Result$1.succeed(CheckFinished.make({ results }));
 	}
 	const classified = classifyDiagnosticsPure(diagnostics, mutants, nodes);
 	if (Result$1.isFailure(classified)) return Result$1.fail(classified.failure);
@@ -158,13 +144,46 @@ const buildResult = (input) => {
 		};
 		else if (retestIds[m.id] !== true) results[m.id] = { status: "passed" };
 	}
-	return Result$1.succeed({
+	if (needsRetest.length === 0) return Result$1.succeed(CheckFinished.make({ results }));
+	return Result$1.succeed(RetestRequired.make({
 		results,
-		needsRetest
-	});
+		needsRetest: [...needsRetest]
+	}));
 };
 const checkMutants = Workflow.make(CheckMutantsInput, (input) => buildResult(input));
 //#endregion
+//#region src/Checker.schema.ts
+/**
+* Checker — declarations for the TypeScript checker.
+*
+* Houses the wire types and error variants shared by the capability and its
+* workflow. Decoded at the checker boundary; no I/O.
+*/
+var CheckMutantsCommand = class extends S.TaggedClass()("CheckMutantsCommand", { mutants: S.Array(Mutant) }) {};
+/**
+* Every way the TypeScript compiler can fail while serving a check.
+* One tagged error — callers branch only on failure itself; `reason` keeps
+* cases distinguishable in reports.
+*/
+var CompilerFailed = class extends S.TaggedError()("CompilerFailed", {
+	reason: S.Literals([
+		"not-initialized",
+		"no-projects",
+		"unknown-file-node",
+		"file-not-in-project"
+	]),
+	subject: S.optional(S.String)
+}) {
+	get message() {
+		switch (this.reason) {
+			case "not-initialized": return "The TypeScript compiler was used before it was initialized";
+			case "no-projects": return `No projects were found for ${this.subject ?? "the tsconfig"}`;
+			case "unknown-file-node": return `The file graph has no node for '${this.subject ?? "a file"}', which should not happen`;
+			case "file-not-in-project": return `'${this.subject ?? "a file"}' is part of your TypeScript project but could not be found on disk`;
+		}
+	}
+};
+//#endregion
 //#region src/Compiler.schema.ts
 /**
 * Compiler — declarations for the TypeScript compiler and version guard.
@@ -527,22 +546,16 @@ function retrieveReferencedProjects(config, fromDirName, pathService) {
 }
 //#endregion
 //#region src/Compiler.ts
-/**
-* Compiler — capability that hosts the TypeScript language service, the
-* in-memory file system, and the file-graph used for grouping.
-*
-* All `typescript/unstable/*` interaction is confined here; callers consume
-* only the Effect-typed service surface.
-*/
 const normalizeFileName$1 = (fileName) => fileName.replace(/\\/g, "/");
 const findSourceMapRegex = /\/\/# sourceMappingURL=(.+)$/m;
 function getSourceMappingURL(content) {
 	return findSourceMapRegex.exec(content)?.[1];
 }
 let cachedTSVersion;
-const getTSVersion = (fsService) => Effect.gen(function* () {
+const getTSVersion = (fsService, pathService) => Effect.gen(function* () {
 	if (cachedTSVersion !== void 0) return cachedTSVersion;
-	const pkgPath = createRequire(import.meta.url).resolve("typescript/package.json");
+	const urlString = import.meta.resolve("typescript/package.json");
+	const pkgPath = yield* pathService.fromFileUrl(new URL(urlString));
 	const text = yield* fsService.readFileString(pkgPath);
 	const raw = JSON.parse(text);
 	let version = "";
@@ -565,8 +578,8 @@ function isSupportedTypescriptVersion(version) {
 	if (minor !== 0) return minor > 0;
 	return patch >= 0;
 }
-const guardTSVersion = (fsService) => Effect.gen(function* () {
-	const version = yield* getTSVersion(fsService);
+const guardTSVersion = (fsService, pathService) => Effect.gen(function* () {
+	const version = yield* getTSVersion(fsService, pathService);
 	if (!isSupportedTypescriptVersion(version)) return yield* new UnsupportedTypeScriptVersionError({ version });
 });
 function makeScriptFile(content, fileName, modifiedTime = /* @__PURE__ */ new Date()) {
@@ -1042,7 +1055,7 @@ function makeTypescriptCompiler(options, fs, fsService, pathService) {
 		]).filter((diagnostic) => diagnostic.category === DiagnosticCategory.Error);
 	});
 	const init = Effect.gen(function* () {
-		yield* guardTSVersion(fsService);
+		yield* guardTSVersion(fsService, pathService);
 		const absoluteTsconfigFile = normalizeFileName$1(pathService.resolve(rawTsconfigFile));
 		yield* Ref.update(stateRef, (prev) => ({
 			...prev,
@@ -1091,18 +1104,7 @@ function makeTypescriptCompiler(options, fs, fsService, pathService) {
 }
 //#endregion
 //#region src/Checker.ts
-/**
-* Checker — capability that validates mutants against the TypeScript compiler.
-*
-* Bridges the checker plugin protocol (`@systemfsoftware/stryker-js/Checker`)
-* to the compiler service and the pure `checkMutants` workflow. Diagnostics
-* are classified without I/O; the file graph is sourced from the compiler.
-*/
 const normalizeFileName = (fileName) => fileName.replace(/\\/g, "/");
-/**
-* Pure grouping decision: separates mutants inside the project graph from
-* those outside it, honouring `prioritizePerformanceOverAccuracy`.
-*/
 function partitionMutantsForGrouping(mutants, nodes, prioritizePerformanceOverAccuracy) {
 	if (!prioritizePerformanceOverAccuracy) return {
 		inside: [],
@@ -1126,32 +1128,39 @@ function getPrioritize(options) {
 	if (typeof val === "boolean") return val;
 	return false;
 }
-const makeCheckDescription = (compiler) => pipe(Cell.read((command) => Effect.gen(function* () {
-	const nodesHm = yield* compiler.nodes.pipe(Effect.mapError((cause) => new CheckerFailed({
-		checkerName: "typescript",
-		mutantIds: command.mutants.map((m) => m.id),
-		cause: errorToString(cause)
-	})));
-	const nodes = {};
-	for (const [k, v] of nodesHm) nodes[k] = v;
-	const diagnostics = yield* compiler.check([...command.mutants]).pipe(Effect.mapError((cause) => new CheckerFailed({
-		checkerName: "typescript",
-		mutantIds: command.mutants.map((m) => m.id),
-		cause: errorToString(cause)
-	})));
-	return new CheckMutantsInput({
-		mutants: [...command.mutants],
-		diagnostics: [...diagnostics],
-		nodes
-	});
-})), Cell.decode((raw) => Result.succeed(raw)), Cell.decide(checkMutants), Cell.encode((outcome) => outcome), Cell.write((outcome) => Result.match(outcome, {
-	onFailure: (failure) => Effect.fail(new CheckerFailed({
-		checkerName: "typescript",
-		mutantIds: [],
-		cause: errorToString(failure)
-	})),
-	onSuccess: (decision) => Effect.succeed(decision)
-})));
+const checkCell = Cell.layer({
+	read: (command) => Effect.gen(function* () {
+		const compiler = yield* TypeScriptCompiler;
+		const nodesHm = yield* compiler.nodes.pipe(Effect.mapError((cause) => new CheckerFailed({
+			checkerName: "typescript",
+			mutantIds: command.mutants.map((m) => m.id),
+			cause: errorToString(cause)
+		})));
+		const nodes = {};
+		for (const [k, v] of nodesHm) nodes[k] = v;
+		const diagnostics = yield* compiler.check([...command.mutants]).pipe(Effect.mapError((cause) => new CheckerFailed({
+			checkerName: "typescript",
+			mutantIds: command.mutants.map((m) => m.id),
+			cause: errorToString(cause)
+		})));
+		return new CheckMutantsInput({
+			mutants: [...command.mutants],
+			diagnostics: [...diagnostics],
+			nodes
+		});
+	}),
+	decode: (raw) => Result.succeed(raw),
+	decide: checkMutants,
+	encode: (outcome) => outcome,
+	write: (outcome) => Result.match(outcome, {
+		onFailure: (failure) => Effect.fail(new CheckerFailed({
+			checkerName: "typescript",
+			mutantIds: [],
+			cause: errorToString(failure)
+		})),
+		onSuccess: (decision) => Effect.succeed(decision)
+	})
+});
 function makeCheckerService({ options, compiler }) {
 	const formatDiagnostic = (error) => Effect.gen(function* () {
 		let severity;
@@ -1174,7 +1183,7 @@ function makeCheckerService({ options, compiler }) {
 		return `${location}${severity} TS${error.code}: ${error.text}`;
 	});
 	const createErrorText = (errors) => Effect.gen(function* () {
-		return (yield* Effect.forEach(errors, formatDiagnostic)).join(EOL);
+		return (yield* Effect.forEach(errors, formatDiagnostic)).join("\n");
 	});
 	return {
 		init: Effect.gen(function* () {
@@ -1193,8 +1202,7 @@ function makeCheckerService({ options, compiler }) {
 			}
 		}),
 		check: (mutants) => Effect.gen(function* () {
-			const description = makeCheckDescription(compiler);
-			const applyOnce = (group) => Cell.apply(description, new CheckMutantsCommand({ mutants: [...group] }));
+			const applyOnce = (group) => Cell.run(checkCell, new CheckMutantsCommand({ mutants: [...group] })).pipe(Effect.provideService(TypeScriptCompiler, compiler));
 			const first = yield* applyOnce(mutants);
 			let map = HashMap.empty();
 			const mergeResults = (results) => {
@@ -1205,14 +1213,17 @@ function makeCheckerService({ options, compiler }) {
 				});
 			};
 			mergeResults(first.results);
-			if (first.needsRetest.length > 0) yield* applyOnce([]);
-			const originals = {};
-			for (const m of mutants) originals[m.id] = m;
-			for (const pending of first.needsRetest) {
-				const original = originals[pending.id];
-				if (original === void 0) continue;
-				mergeResults((yield* applyOnce([original])).results);
-			}
+			yield* Match.value(first).pipe(Match.tag("CheckFinished", () => Effect.void), Match.tag("RetestRequired", (retest) => Effect.gen(function* () {
+				yield* applyOnce([]);
+				const originals = {};
+				for (const m of mutants) originals[m.id] = m;
+				for (const pending of retest.needsRetest) {
+					const original = originals[pending.id];
+					if (original === void 0) continue;
+					const one = yield* applyOnce([original]);
+					mergeResults(one.results);
+				}
+			})), Match.exhaustive);
 			return map;
 		}),
 		group: (mutants) => Effect.gen(function* () {
@@ -1240,7 +1251,7 @@ const strykerPlugins = [declarePlugin("Checker", "typescript", Layer.effect(Chec
 		compiler: makeTypescriptCompiler(options, yield* makeHybridFileSystem(fsService), fsService, pathService)
 	});
 })))];
-const rawSchema = JSON.parse(readFileSync(new URL("../schema/typescript-checker-options.json", import.meta.url), "utf-8"));
+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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@systemfsoftware/stryker-js-typescript-checker",
-  "version": "3.0.2",
+  "version": "4.0.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/systemfsoftware/systemfsoftware.git",
@@ -22,10 +22,11 @@
   "dependencies": {
     "effect": "^4.0.0-rc.112",
     "typescript": "^7",
-    "@systemfsoftware/effect-cell-types": "^5.0.2",
-    "@systemfsoftware/stryker-js": "^0.1.1"
+    "@systemfsoftware/stryker-js": "^1.0.0",
+    "@systemfsoftware/effect-cell-types": "^6.0.0"
   },
   "devDependencies": {
+    "@effect/platform-node": "^4.0.0-rc.112",
     "@effect/platform-node-shared": "^4.0.0-rc.112",
     "@std/jsonc": "npm:@jsr/std__jsonc@^1.0.2",
     "@systemfsoftware/arethetypeswrong-cli": "^1.1.1",
@@ -34,13 +35,13 @@
     "rimraf": "^6.1.3",
     "tsdown": "^0.22.14",
     "vitest": "^4",
-    "@systemfsoftware/all": "^1.0.2",
+    "@systemfsoftware/all": "^1.1.2",
     "@systemfsoftware/effect-gherkin-spec": "^4.0.0",
-    "@systemfsoftware/effect-schema-vite": "^2.0.2",
     "@systemfsoftware/effect-schema-law": "^2.0.1",
     "@systemfsoftware/tsconfig": "^1.3.3",
     "@systemfsoftware/vitest-config": "^0.1.0",
-    "@systemfsoftware/oxlint-config": "^0.1.0"
+    "@systemfsoftware/oxlint-config": "^0.1.0",
+    "@systemfsoftware/effect-schema-vite": "^2.0.2"
   },
   "inlinedDependencies": {
     "@jsr/std__jsonc": "1.0.2"