@systemfsoftware/stryker-js-html-reporter 0.1.2 → 1.0.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @systemfsoftware/stryker-js-html-reporter
 
+## 1.0.0
+
+### Major Changes
+
+- Report generation moved to a plain kernel; the reporter service shape is unchanged
+
+### Patch Changes
+
+- Updated dependencies:
+  - @systemfsoftware/effect-cell-types@6.0.0
+  - @systemfsoftware/stryker-js@1.0.0
+
 ## 0.1.2
 
 ### Patch Changes

package/README.md

@@ -16,7 +16,7 @@ import { makeHtmlReporter, strykerPlugins } from '@systemfsoftware/stryker-js-ht
 
 ## Related
 
-- [`@systemfsoftware/stryker-js-platform-node`][engine] — the engine that emits the events this reporter presents
+- [`@systemfsoftware/stryker-js-engine`][engine] — the engine that emits the events this reporter presents
 - [`@systemfsoftware/stryker-js-cli`][cli] — the terminal-facing half, which binds this package's `strykerPlugins`
 
 ## License
@@ -28,5 +28,5 @@ Licensed under [Apache 2.0][license-url].
 [license-badge]: https://img.shields.io/badge/license-Apache_2.0-blue?style=flat-square
 [license-url]: https://github.com/systemfsoftware/systemfsoftware/blob/main/LICENSE
 [repo]: https://github.com/systemfsoftware/systemfsoftware
-[engine]: https://github.com/systemfsoftware/systemfsoftware/tree/main/packages/testing/mutation/stryker-js/platform-node
+[engine]: https://github.com/systemfsoftware/systemfsoftware/tree/main/packages/testing/mutation/stryker-js/engine
 [cli]: https://github.com/systemfsoftware/systemfsoftware/tree/main/packages/testing/mutation/stryker-js/cli

package/dist/index.d.mts

@@ -1,6 +1,8 @@
 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";
 //#region src/Reporter.d.ts
 declare const makeHtmlReporter: (params: {

package/dist/index.mjs

@@ -4,28 +4,20 @@ 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 { Cell, Wire, Workflow } from "@systemfsoftware/effect-cell-types";
 import { writeOutputFile } from "@systemfsoftware/stryker-js/output-file";
 import * as Cause from "effect/Cause";
-import { pipe } from "effect/Function";
-import * as Result from "effect/Result";
+import { Wire } from "@systemfsoftware/effect-cell-types";
 import * as S from "effect/Schema";
 //#region src/Reporter.schema.ts
-/**
-* Html reporter declarations — the wire types for the html report pipeline.
-*/
 const MutationTestResultSchema = Wire.mint(S.Unknown);
 var HtmlReportCommand = class extends S.TaggedClass()("HtmlReportCommand", {
 	report: MutationTestResultSchema,
 	scriptContent: S.String
 }) {};
+var HtmlDocument = class extends S.TaggedClass()("HtmlDocument", { html: S.String }) {};
 S.TaggedError()("HtmlReportError", { message: S.String });
 //#endregion
-//#region src/Reporter.workflow.ts
-/**
-* Html reporter workflow — pure document construction.
-*/
-var HtmlDocument = class extends S.TaggedClass()("HtmlDocument", { html: S.String }) {};
+//#region src/Reporter.ts
 function escapeHtmlTags(json) {
 	return json.replace(/</g, "<\"+\"");
 }
@@ -56,57 +48,34 @@ function buildReportHtml(report, scriptContent) {
   </body>
   </html>`;
 }
-const makeHtmlDocument = Workflow.make(HtmlReportCommand, (command) => {
-	const html = buildReportHtml(command.report, command.scriptContent);
-	return Result.succeed(HtmlDocument.make({ html }));
-});
-//#endregion
-//#region src/Reporter.ts
-/**
-* Html reporter — Cell pipeline that renders the mutation report to a file.
-*/
+const buildHtmlDocument = (command) => HtmlDocument.make({ html: buildReportHtml(command.report, command.scriptContent) });
 const makeHtmlReporter = (params) => {
 	const options = params.options;
-	const fs = params.fs;
-	const path = params.path;
-	let heldReport;
-	const htmlReportDescription = pipe(Cell.read(() => Effect.gen(function* () {
-		const scriptPath = yield* path.fromFileUrl(new URL(import.meta.resolve("mutation-testing-elements/dist/mutation-test-elements.js")));
-		const scriptContent = yield* fs.readFileString(scriptPath);
-		return {
-			report: heldReport,
-			scriptContent
-		};
-	})), Cell.decode((raw) => Result.succeed(HtmlReportCommand.make({
-		report: raw.report,
-		scriptContent: raw.scriptContent
-	}))), Cell.decide(makeHtmlDocument), Cell.encode((outcome) => Result.match(outcome, {
-		onFailure: () => "",
-		onSuccess: (doc) => doc.html
-	})), Cell.write((html) => Effect.gen(function* () {
-		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}`);
-	})));
 	return {
 		onDryRunCompleted: (_event) => Effect.void,
 		onMutationTestingPlanReady: (_event) => Effect.void,
 		onMutantTested: (_result) => Effect.void,
-		onMutationTestReportReady: (report, _metrics) => Effect.sync(() => {
-			heldReport = report;
-		}),
-		wrapUp: Effect.gen(function* () {
+		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;
-			if (heldReport === void 0) return;
-			yield* Cell.apply(htmlReportDescription, void 0);
-		}).pipe(Effect.catchCause((cause) => Effect.fail(new ReporterFailed({
+			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: "wrapUp",
+			event: "onMutationTestReportReady",
 			cause: Cause.pretty(cause)
-		}))))
+		})))),
+		wrapUp: Effect.void
 	};
 };
 //#endregion

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@systemfsoftware/stryker-js-html-reporter",
-  "version": "0.1.2",
+  "version": "1.0.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/systemfsoftware/systemfsoftware.git",
@@ -17,8 +17,8 @@
     "mutation-testing-elements": "3.7.3",
     "mutation-testing-metrics": "3.7.3",
     "mutation-testing-report-schema": "3.7.3",
-    "@systemfsoftware/stryker-js": "^0.2.0",
-    "@systemfsoftware/effect-cell-types": "^5.0.2"
+    "@systemfsoftware/effect-cell-types": "^6.0.0",
+    "@systemfsoftware/stryker-js": "^1.0.0"
   },
   "devDependencies": {
     "@systemfsoftware/arethetypeswrong-cli": "^1.1.1",
@@ -30,9 +30,9 @@
     "tsdown": "^0.22.14",
     "typescript": "^7",
     "vitest": "^4",
-    "@systemfsoftware/all": "^1.1.0",
-    "@systemfsoftware/effect-gherkin-spec": "^4.0.0",
+    "@systemfsoftware/all": "^1.1.2",
     "@systemfsoftware/tsconfig": "^1.3.3",
+    "@systemfsoftware/effect-gherkin-spec": "^4.0.0",
     "@systemfsoftware/vitest-config": "^0.1.0"
   },
   "engines": {