@systemfsoftware/stryker-js-html-reporter 2.0.0 → 3.0.0

package/CHANGELOG.md

@@ -1,5 +1,41 @@
 # @systemfsoftware/stryker-js-html-reporter
 
+## 3.0.0
+
+### Major Changes
+
+- Reporter plugins are now pull-stream consumers: a reporter exports a factory
+  that returns an async consumer of the four run events, instead of registering
+  an Effect layer that provides the `Reporter` capability service.
+
+  - Removed: `ReporterService`, `broadcastReporter`, `NamedReporter`, the
+    `Reporter` service class, and the legacy event payload types.
+  - The event protocol ships as a Standard Schema object; validate and infer it
+    with `import { ReporterEventSchema, type ReporterFactory, type ReporterInit }
+    from '@systemfsoftware/stryker-js/ReporterEvent'`.
+  - Event payloads are narrowed: the dry-run event no longer carries the coverage
+    map; the plan event carries reduced mutant descriptors instead of full run
+    options; `mutantTested` drops `killedBy`, `coveredBy`, `static`,
+    `testsCompleted` and `statusReason`, and renames `mutatorName` to `mutator`.
+  - `ReporterFailed.event` now names the event kind being processed instead of a
+    lifecycle method name; `'wrapUp'` no longer occurs.
+  - An unknown reporter name now fails the run at startup instead of being
+    silently ignored. A reporter that fails on the terminal report now fails the
+    run; a reporter that fails earlier is logged and detached with the exit code
+    unchanged.
+  - `@systemfsoftware/stryker-js-engine/builtin-reporters` no longer exports
+    `strykerPlugins`; call `makeBuiltinReporterFactories({ fileSystem, path })`.
+  - The built-in json and clear-text reporters write their notices directly to
+    stdout and stderr instead of the Effect logger, and the html reporter no
+    longer depends on `@effect/platform-node`.
+
+### Patch Changes
+
+- Re-released against @systemfsoftware/stryker-js without the removed --llms manifest. The Run stream no longer carries a manifest terminal event, and the RunEvent / RunTerminalEvent unions no longer include the manifest arm, so any exhaustive consumer of those types must drop that case.
+
+- Updated dependencies:
+  - @systemfsoftware/stryker-js@3.0.0
+
 ## 2.0.0
 
 ### Major Changes

package/dist/index.d.mts

@@ -1,17 +1,11 @@
-import { ReporterService } from "@systemfsoftware/stryker-js/Reporter";
-import * as FileSystem from "effect/FileSystem";
-import * as Path from "effect/Path";
-import { Wire } from "@systemfsoftware/effect-cell-types";
 import "effect/Schema";
-import { ProvidedStrykerOptions } from "@systemfsoftware/stryker-js/provided-options";
+import { Wire } from "@systemfsoftware/effect-cell-types";
+import { ReporterFactory } from "@systemfsoftware/stryker-js/ReporterEvent";
 //#region src/Reporter.d.ts
-declare const makeHtmlReporter: (params: {
-  readonly options?: ProvidedStrykerOptions;
-  readonly fs: FileSystem.FileSystem;
-  readonly path: Path.Path;
-}) => ReporterService;
+declare const makeHtmlReporter: ReporterFactory;
 //#endregion
 //#region src/index.d.ts
-declare const strykerPlugins: import("@systemfsoftware/stryker-js/Plugin").PluginContribution<"Reporter">[];
+declare const htmlReporterFactory: ReporterFactory;
+declare const strykerPlugins: import("@systemfsoftware/stryker-js/Plugin").PluginReporterContribution[];
 //#endregion
-export { makeHtmlReporter, strykerPlugins };
+export { htmlReporterFactory, makeHtmlReporter, strykerPlugins };

package/dist/index.mjs

@@ -1,13 +1,13 @@
-import { RunConfiguration, declarePlugin } from "@systemfsoftware/stryker-js/Plugin";
-import { Reporter, ReporterFailed } from "@systemfsoftware/stryker-js/Reporter";
+import { declarePlugin } from "@systemfsoftware/stryker-js/Plugin";
+import * as NodeFileSystem from "@effect/platform-node-shared/NodeFileSystem";
+import * as NodePath from "@effect/platform-node-shared/NodePath";
+import { MutationTestReportReady } from "@systemfsoftware/stryker-js/Reporter";
 import * as Effect from "effect/Effect";
 import * as FileSystem from "effect/FileSystem";
 import * as Layer from "effect/Layer";
 import * as Path from "effect/Path";
-import { writeOutputFile } from "@systemfsoftware/stryker-js/output-file";
-import * as Cause from "effect/Cause";
-import { Wire } from "@systemfsoftware/effect-cell-types";
 import * as S from "effect/Schema";
+import { Wire } from "@systemfsoftware/effect-cell-types";
 //#region src/Reporter.schema.ts
 const MutationTestResultSchema = Wire.mint(S.Unknown);
 var HtmlReportCommand = class extends S.TaggedClass()("HtmlReportCommand", {
@@ -49,46 +49,45 @@ function buildReportHtml(report, scriptContent) {
   </html>`;
 }
 const buildHtmlDocument = (command) => HtmlDocument.make({ html: buildReportHtml(command.report, command.scriptContent) });
-const makeHtmlReporter = (params) => {
-	const options = params.options;
-	return {
-		onDryRunCompleted: (_event) => Effect.void,
-		onMutationTestingPlanReady: (_event) => Effect.void,
-		onMutantTested: (_result) => Effect.void,
-		onMutationTestReportReady: (report, metrics) => Effect.gen(function* () {
-			const path = yield* Path.Path;
-			const fs = yield* FileSystem.FileSystem;
-			const scriptPath = yield* path.fromFileUrl(new URL(import.meta.resolve("mutation-testing-elements/dist/mutation-test-elements.js")));
-			const scriptContent = yield* fs.readFileString(scriptPath);
-			const html = buildHtmlDocument(HtmlReportCommand.make({
-				report,
-				scriptContent
-			})).html;
-			if (options === void 0) return;
-			const fileName = options.htmlReporter.fileName;
-			yield* Effect.logDebug(`Using file "${fileName}"`);
-			yield* writeOutputFile(fs, path, fileName, html);
-			const fileUrl = yield* path.toFileUrl(path.resolve(fileName));
-			yield* Effect.logInfo(`Your report can be found at: ${fileUrl.href}`);
-		}).pipe(Effect.provideService(FileSystem.FileSystem, params.fs), Effect.provideService(Path.Path, params.path), Effect.catchCause((cause) => Effect.fail(new ReporterFailed({
-			reporterName: "html",
-			event: "onMutationTestReportReady",
-			cause: Cause.pretty(cause)
-		})))),
-		wrapUp: Effect.void
+const BUNDLE_SPECIFIER = "mutation-testing-elements/dist/mutation-test-elements.js";
+const nodeFsPathLayer = Layer.mergeAll(NodeFileSystem.layer, NodePath.layer);
+const readBundleContent = Effect.gen(function* () {
+	const fs = yield* FileSystem.FileSystem;
+	const bundlePath = yield* (yield* Path.Path).fromFileUrl(new URL(import.meta.resolve(BUNDLE_SPECIFIER)));
+	return yield* fs.readFileString(bundlePath);
+});
+const writeHtmlFile = (fileName, html) => Effect.gen(function* () {
+	const fs = yield* FileSystem.FileSystem;
+	const path = yield* Path.Path;
+	yield* fs.makeDirectory(path.dirname(fileName), { recursive: true });
+	yield* fs.writeFileString(fileName, html);
+});
+const bundleLoader = () => {
+	let cached;
+	return async () => {
+		cached ??= await Effect.runPromise(Effect.provide(readBundleContent, nodeFsPathLayer));
+		return cached;
 	};
 };
+const writeReportHtml = async (fileName, event, loadBundle) => {
+	const html = buildHtmlDocument(HtmlReportCommand.make({
+		report: event.report,
+		scriptContent: await loadBundle()
+	})).html;
+	await Effect.runPromise(Effect.provide(writeHtmlFile(fileName, html), nodeFsPathLayer));
+};
+const writeReportHtmlIfReady = async (fileName, event, loadBundle) => {
+	if (!S.is(MutationTestReportReady)(event)) return;
+	await writeReportHtml(fileName, event, loadBundle);
+};
+const makeHtmlReporter = (options, _init) => async (events) => {
+	const fileName = options.htmlReporter.fileName;
+	const loadBundle = bundleLoader();
+	for await (const event of events) await writeReportHtmlIfReady(fileName, event, loadBundle);
+};
 //#endregion
 //#region src/index.ts
-const strykerPlugins = [declarePlugin("Reporter", "html", Layer.effect(Reporter, Effect.gen(function* () {
-	const options = yield* RunConfiguration;
-	const fs = yield* FileSystem.FileSystem;
-	const path = yield* Path.Path;
-	return makeHtmlReporter({
-		options,
-		fs,
-		path
-	});
-})))];
+const htmlReporterFactory = makeHtmlReporter;
+const strykerPlugins = [declarePlugin("Reporter", "html", htmlReporterFactory)];
 //#endregion
-export { makeHtmlReporter, strykerPlugins };
+export { htmlReporterFactory, makeHtmlReporter, strykerPlugins };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@systemfsoftware/stryker-js-html-reporter",
-  "version": "2.0.0",
+  "version": "3.0.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/systemfsoftware/systemfsoftware.git",
@@ -14,23 +14,22 @@
     "dist"
   ],
   "dependencies": {
+    "@effect/platform-node-shared": "4.0.0-rc.112",
     "mutation-testing-elements": "3.7.3",
-    "mutation-testing-metrics": "3.7.3",
-    "mutation-testing-report-schema": "3.7.3",
     "@systemfsoftware/effect-cell-types": "^6.0.1",
-    "@systemfsoftware/stryker-js": "^2.0.0"
+    "@systemfsoftware/stryker-js": "^3.0.0"
   },
   "devDependencies": {
     "@systemfsoftware/arethetypeswrong-cli": "^1.1.1",
     "@types/node": "^24",
-    "effect": "^4.0.0-rc.112",
+    "effect": "4.0.0-rc.112",
     "oxlint": "^1.77.0",
     "oxlint-tsgolint": "7.0.2001",
     "rimraf": "^6.1.3",
     "tsdown": "^0.22.14",
     "typescript": "^7",
     "vitest": "^4",
-    "@systemfsoftware/all": "^1.1.3",
+    "@systemfsoftware/all": "^2.0.0",
     "@systemfsoftware/effect-gherkin-spec": "^4.0.1",
     "@systemfsoftware/tsconfig": "^1.3.3",
     "@systemfsoftware/vitest-config": "^0.1.0"
@@ -44,7 +43,7 @@
     "provenance": true
   },
   "peerDependencies": {
-    "effect": "^4.0.0-rc.112"
+    "effect": "4.0.0-rc.112"
   },
   "exports": {
     ".": "./dist/index.mjs",