@systemfsoftware/stryker-js-cli 4.0.0 → 4.0.2

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @systemfsoftware/stryker-js-cli
 
+## 4.0.2
+
+### Patch Changes
+
+- Re-published against the oxc-based instrumenter: workspace dependency ranges move to the new instrumenter major; no package's own behavior changes in this release.
+
+## 4.0.1
+
+### Patch Changes
+
+- A mutation run that is killed mid-way keeps every completed mutant: the JSONL progress stream is flushed after each result, and incremental mode writes remembered verdicts as they finish so the next run continues instead of starting over.
+
+  Remembered killed mutants still name the tests that killed them, so a resumed run's report matches a complete run.
+
+  The progress stream path is progressStreamFile (default reports/mutation-stream.jsonl) and can be set in config or with --progressStreamFile.
+
+- Peer Effect requirement advances to 4.0.0-rc.112. No API changes.
+
 ## 4.0.0
 
 ### Major Changes

package/dist/main.mjs

@@ -1053,6 +1053,35 @@ function emitMachineModeOutput(stream, mode, outcome, basePath, pathService) {
 	});
 }
 //#endregion
+//#region src/StreamFile.ts
+const DEFAULT_PROGRESS_STREAM_FILE = "reports/mutation-stream.jsonl";
+const encodeUtf8 = (line) => new TextEncoder().encode(line);
+const drainStreamFile = (fileName, framed) => Effect.gen(function* () {
+	const fs = yield* FileSystem.FileSystem;
+	const path = yield* Path.Path;
+	yield* fs.makeDirectory(path.dirname(fileName), { recursive: true }).pipe(Effect.orDie);
+	yield* Effect.scoped(Effect.gen(function* () {
+		const handle = yield* fs.open(fileName, { flag: "w" });
+		yield* Stream.runForEach(framed, (line) => handle.writeAll(encodeUtf8(line)).pipe(Effect.flatMap(() => handle.sync)));
+	})).pipe(Effect.orDie);
+});
+const RunEventStreamFileLive = Layer.effect(RunEventStreamPort, Effect.gen(function* () {
+	const stdio = yield* Stdio.Stdio;
+	const fs = yield* FileSystem.FileSystem;
+	const path = yield* Path.Path;
+	const fileNameRef = yield* Ref.make(DEFAULT_PROGRESS_STREAM_FILE);
+	const drainFramed = (framed) => Effect.gen(function* () {
+		const fileName = yield* Ref.get(fileNameRef);
+		yield* drainStreamFile(fileName, framed).pipe(Effect.provideService(FileSystem.FileSystem, fs), Effect.provideService(Path.Path, path));
+	});
+	return RunEventStreamPort.of({ createRunEventStream: (resolved) => Effect.gen(function* () {
+		return {
+			...yield* makeRunEventStream(stdio, resolved, drainFramed),
+			setProgressStreamFile: (fileName) => Ref.set(fileNameRef, fileName)
+		};
+	}) });
+}));
+//#endregion
 //#region src/Survivors.ts
 /**
 * Survivors — the survivors-admission capability.
@@ -1562,6 +1591,7 @@ const runOptions = {
 	incremental: Flag.map(optional(Flag.boolean("incremental")), absentWhenFalse).pipe(Flag.withDescription("Enable 'incremental mode'. Stryker will store results in a file and use that file to speed up the next --incremental run")),
 	allowEmpty: Flag.map(optional(Flag.boolean("allowEmpty")), absentWhenFalse).pipe(Flag.withDescription("Allows stryker to exit without any errors in cases where no tests are found")),
 	incrementalFile: Flag.string("incrementalFile").pipe(Flag.withDescription("Specify the file to use for incremental mode."), optional),
+	progressStreamFile: Flag.string("progressStreamFile").pipe(Flag.withDescription("Specify the file for the machine-mode progress stream."), optional),
 	force: Flag.map(optional(Flag.boolean("force")), absentWhenFalse).pipe(Flag.withDescription("Run all mutants, even if --incremental is provided and an incremental file exists. Can be used to force a rebuild of the incremental file.")),
 	mutate: Flag.string("mutate").pipe(Flag.withAlias("m"), Flag.withDescription("With `mutate` you configure the subset of files or just one specific file to be mutated. These should be your _production code files_, and definitely not your test files. (Whereas with `ignorePatterns` you prevent non-relevant files from being copied to the sandbox directory in the first place)\nThe default will try to guess your production code files based on sane defaults. It reads like this:\n- Include all js-like files inside the `src` or `lib` dir\n- Except files inside `__tests__` directories and file names ending with `test` or `spec`.\nIf the defaults are not sufficient for you, for example in a angular project you might want to **exclude** not only the `*.spec.ts` files but other files too, just like the default already does.\nIt is possible to override the defaults by: - supplying one or more [glob patterns](https://github.com/isaacs/minimatch) to include (e.g. `src/**/*.js`) - or one or more comma separated glob patterns preceded with `!` to exclude (e.g. `!src/**/*.spec.js`) - or both (e.g. `src/**/*.js,!src/**/*.spec.js`).\nNote: Stryker will use [minimatch](https://github.com/isaacs/minimatch) for parsing these patterns, see minimatch for the exact syntax."), Flag.map(splitOnComma), optional),
 	testFiles: Flag.string("testFiles").pipe(Flag.withAlias("t"), Flag.withDescription("With `testFiles` you can limit which test files are executed during mutation testing. When specified, only tests from these files will be run. This allows you to verify that a module's dedicated unit tests can kill all its mutants independently."), Flag.map(splitOnComma), optional),
@@ -1657,6 +1687,7 @@ function makeStrykerCommand(requestRef) {
 		setIfPresent(options, "incremental", config.incremental);
 		setIfPresent(options, "allowEmpty", config.allowEmpty);
 		setIfPresent(options, "incrementalFile", config.incrementalFile);
+		setIfPresent(options, "progressStreamFile", config.progressStreamFile);
 		setIfPresent(options, "force", config.force);
 		setIfPresent(options, "mutate", config.mutate);
 		setIfPresent(options, "testFiles", config.testFiles);
@@ -1802,9 +1833,19 @@ const runStrykerCli = (input, createRunEventStream) => Effect.gen(function* () {
 		process.on("SIGINT", onSignal);
 		process.on("SIGTERM", onSignal);
 	}), () => Effect.gen(function* () {
-		yield* stream.open;
-		yield* input.program;
+		const parsed = yield* Effect.result(input.program);
 		const request = yield* Ref.get(input.requestRef);
+		const fileName = Option.match(request, {
+			onNone: () => DEFAULT_PROGRESS_STREAM_FILE,
+			onSome: (cliRequest) => Match.value(cliRequest).pipe(Match.tag("run", (runRequest) => {
+				const fromCli = runRequest.options["progressStreamFile"];
+				if (typeof fromCli === "string" && fromCli.length > 0) return fromCli;
+				return DEFAULT_PROGRESS_STREAM_FILE;
+			}), Match.orElse(() => DEFAULT_PROGRESS_STREAM_FILE))
+		});
+		if (stream.setProgressStreamFile !== void 0) yield* stream.setProgressStreamFile(fileName);
+		yield* stream.open;
+		if (Result.isFailure(parsed)) return yield* Effect.fail(parsed.failure);
 		return yield* Option.match(request, {
 			onNone: () => Effect.void,
 			onSome: (cliRequest) => dispatch(cliRequest)
@@ -1822,24 +1863,6 @@ const runStrykerCli = (input, createRunEventStream) => Effect.gen(function* () {
 	}));
 });
 //#endregion
-//#region src/StreamFile.ts
-const STREAM_FILE_DIR = "reports";
-const STREAM_FILE_NAME = "mutation-stream.jsonl";
-const encodeUtf8 = (line) => new TextEncoder().encode(line);
-const drainStreamFile = (framed) => Effect.gen(function* () {
-	const fs = yield* FileSystem.FileSystem;
-	const file = (yield* Path.Path).join(STREAM_FILE_DIR, STREAM_FILE_NAME);
-	yield* fs.makeDirectory(STREAM_FILE_DIR, { recursive: true }).pipe(Effect.orDie);
-	yield* Stream.run(framed.pipe(Stream.map(encodeUtf8)), fs.sink(file, { flag: "w" })).pipe(Effect.orDie);
-});
-const RunEventStreamFileLive = Layer.effect(RunEventStreamPort, Effect.gen(function* () {
-	const stdio = yield* Stdio.Stdio;
-	const fs = yield* FileSystem.FileSystem;
-	const path = yield* Path.Path;
-	const drainFramed = (framed) => drainStreamFile(framed).pipe(Effect.provideService(FileSystem.FileSystem, fs), Effect.provideService(Path.Path, path));
-	return RunEventStreamPort.of({ createRunEventStream: (resolved) => makeRunEventStream(stdio, resolved, drainFramed) });
-}));
-//#endregion
 //#region src/main.ts
 const EXIT_CODE_RUN_NEVER_REACHED_ITS_FINALIZER = 1;
 process.title = "stryker";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@systemfsoftware/stryker-js-cli",
-  "version": "4.0.0",
+  "version": "4.0.2",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/systemfsoftware/systemfsoftware.git",
@@ -18,10 +18,10 @@
     "@effect/platform-node-shared": "^4.0.0-rc.112",
     "@noble/hashes": "1.8.0",
     "effect": "^4.0.0-rc.112",
-    "@systemfsoftware/effect-cell-types": "^5.0.0",
-    "@systemfsoftware/stryker-js-html-reporter": "^0.1.0",
-    "@systemfsoftware/stryker-js": "^0.1.0",
-    "@systemfsoftware/stryker-js-platform-node": "^0.1.0"
+    "@systemfsoftware/effect-cell-types": "^5.0.2",
+    "@systemfsoftware/stryker-js-html-reporter": "^0.1.1",
+    "@systemfsoftware/stryker-js": "^0.1.1",
+    "@systemfsoftware/stryker-js-platform-node": "^0.1.2"
   },
   "devDependencies": {
     "@systemfsoftware/arethetypeswrong-cli": "^1.1.1",
@@ -32,15 +32,16 @@
     "testcontainers": "^12.1.0",
     "tsdown": "^0.22.14",
     "vite-tsconfig-paths": "^6.1.1",
-    "vitest": "^4.1.10",
-    "@systemfsoftware/all": "^1.0.0",
-    "@systemfsoftware/effect-gherkin-spec": "^2.0.1",
-    "@systemfsoftware/effect-schema-law": "^1.0.0",
-    "@systemfsoftware/effect-schema-vite": "^2.0.0",
+    "vitest": "^4",
+    "@systemfsoftware/all": "^1.0.2",
+    "@systemfsoftware/effect-gherkin-spec": "^4.0.0",
+    "@systemfsoftware/effect-schema-law": "^2.0.1",
+    "@systemfsoftware/effect-schema-vite": "^2.0.2",
+    "@systemfsoftware/stryker-js-typescript-checker": "^3.0.2",
+    "@systemfsoftware/stryker-js-vitest-runner": "^2.0.2",
+    "@systemfsoftware/stryker-test-contribution": "^1.1.1",
+    "@systemfsoftware/stryker-plugins": "^2.0.0",
     "@systemfsoftware/oxlint-config": "^0.1.0",
-    "@systemfsoftware/oxlint-plugin-effect-entrypoint": "^1.0.5",
-    "@systemfsoftware/oxlint-plugin-test-placement": "^3.2.0",
-    "@systemfsoftware/oxlint-plugin-cell-vocabulary": "^1.2.2",
     "@systemfsoftware/tsconfig": "^1.3.3",
     "@systemfsoftware/vitest-config": "^0.1.0"
   },
@@ -65,8 +66,8 @@
     "test": "vitest run",
     "test:contract": "vitest run --config vitest.contract.config.ts",
     "lint": "f=${OXLINT_FORMAT:-${AGENT:+agent}}; oxlint . --format=${f:-default}",
-    "mutation": "stryker run",
-    "mutation:full": "stryker run --force",
+    "mutation": "node ./dist/main.mjs run",
+    "mutation:full": "node ./dist/main.mjs run --force",
     "api:check": "echo 'no API report for CLI (dts: false)' && exit 0",
     "api:update": "echo 'no API report for CLI (dts: false)' && exit 0"
   }