@systemfsoftware/stryker-js-html-reporter 3.0.2 → 4.0.0

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # @systemfsoftware/stryker-js-html-reporter
 
+## 4.0.0
+
+### Major Changes
+
+- The plugin system now runs each configured TestRunner/Checker/Reporter plugin in its own spawned process over an @effect/rpc wire: plugins load from the project's config-declared specifiers (no glob discovery), boundary failures are typed errors, and plugin spans link into the host trace. Breaking: the in-process plugin Layer contract is removed.
+
+### Patch Changes
+
+- Maintenance release. Every published entry point, export, option, and behaviour is exactly as it was.
+
+- effect peer range widens to ^4.0.0-rc.112 and the platform-node-shared dependency range widens to the repo catalog; repository metadata now points at stryker-js-effect
+
+## 3.0.3
+
+### Patch Changes
+
+- Imports rewired to the collapsed `@systemfsoftware/stryker-js` root entry; each package now co-releases against the root-entry major.
+
+- Updated dependencies:
+  - @systemfsoftware/effect-cell-types@8.0.0
+  - @systemfsoftware/stryker-js@4.0.0
+
 ## 3.0.2
 
 ### Patch Changes

package/README.md

@@ -7,17 +7,18 @@ HTML reporter plugin for the @systemfsoftware mutation engine.
 
 ## Usage
 
-You normally never import this package directly — the CLI wires it in. The
-reporter exists so a programmatic consumer can assemble its own host:
+You normally never import this package directly — the CLI binds it as a built-in
+in-process reporter. The reporter exists so a programmatic consumer can assemble
+its own host:
 
 ```ts
-import { makeHtmlReporter, strykerPlugins } from '@systemfsoftware/stryker-js-html-reporter'
+import { makeHtmlReporter } from '@systemfsoftware/stryker-js-html-reporter'
 ```
 
 ## Related
 
 - [`@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`
+- [`@systemfsoftware/stryker-js-cli`][cli] — the terminal-facing half, which binds this package's `makeHtmlReporter` as a built-in reporter
 
 ## License
 
@@ -26,7 +27,7 @@ Licensed under [Apache 2.0][license-url].
 [npm-badge]: https://img.shields.io/npm/v/@systemfsoftware/stryker-js-html-reporter?style=flat-square
 [npm-url]: https://www.npmjs.com/package/@systemfsoftware/stryker-js-html-reporter
 [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/stryker-js/stryker-js-engine
-[cli]: https://github.com/systemfsoftware/systemfsoftware/tree/main/packages/stryker-js/stryker-js-cli
+[license-url]: https://github.com/systemfsoftware/stryker-js-effect/blob/main/LICENSE
+[repo]: https://github.com/systemfsoftware/stryker-js-effect
+[engine]: https://github.com/systemfsoftware/stryker-js-effect/tree/main/packages/stryker-js-engine
+[cli]: https://github.com/systemfsoftware/stryker-js-effect/tree/main/apps/stryker-js-cli

package/dist/index.d.mts

@@ -1,10 +1,5 @@
-import "effect/Schema";
-import { ReporterFactory } from "@systemfsoftware/stryker-js/ReporterEvent";
-//#region src/Reporter.d.ts
-declare const makeHtmlReporter: ReporterFactory;
-//#endregion
-//#region src/index.d.ts
-declare const htmlReporterFactory: ReporterFactory;
-declare const strykerPlugins: import("@systemfsoftware/stryker-js/Plugin").PluginReporterContribution[];
-//#endregion
-export { htmlReporterFactory, makeHtmlReporter, strykerPlugins };
+import { ReporterFactory } from '@systemfsoftware/stryker-js-language';
+
+export declare const makeHtmlReporter: ReporterFactory;
+
+export { }

package/dist/index.mjs

@@ -1,12 +1,14 @@
-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 { MutationTestReportReady, ReporterFailed, errorToString } from "@systemfsoftware/stryker-js-language";
 import * as Effect from "effect/Effect";
 import * as FileSystem from "effect/FileSystem";
 import * as Layer from "effect/Layer";
+import * as Match from "effect/Match";
 import * as Path from "effect/Path";
+import * as Ref from "effect/Ref";
 import * as S from "effect/Schema";
+import * as Stream from "effect/Stream";
 //#region src/Reporter.schema.ts
 const MutationTestResultSchema = S.Unknown;
 var HtmlReportCommand = class extends S.TaggedClass()("HtmlReportCommand", {
@@ -50,44 +52,29 @@ function buildReportHtml(report, scriptContent) {
 const buildHtmlDocument = (command) => HtmlDocument.make({ html: buildReportHtml(command.report, command.scriptContent) });
 const BUNDLE_SPECIFIER = "mutation-testing-elements/dist/mutation-test-elements.js";
 const nodeFsPathLayer = Layer.mergeAll(NodeFileSystem.layer, NodePath.layer);
-const readBundleContent = Effect.gen(function* () {
-	if (typeof __STRYKER_HTML_REPORTER_CLIENT_BUNDLE__ === "string") return __STRYKER_HTML_REPORTER_CLIENT_BUNDLE__;
-	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 inlinedBundle = () => Match.value(typeof __STRYKER_HTML_REPORTER_CLIENT_BUNDLE__).pipe(Match.when("undefined", () => void 0), Match.orElse(() => __STRYKER_HTML_REPORTER_CLIENT_BUNDLE__));
+const readBundleContent = Effect.suspend(() => Match.value(inlinedBundle()).pipe(Match.when(Match.string, (bundle) => Effect.succeed(bundle)), Match.orElse(() => Effect.flatMap(FileSystem.FileSystem, (fs) => Effect.flatMap(Path.Path, (path) => Effect.flatMap(path.fromFileUrl(new URL(import.meta.resolve(BUNDLE_SPECIFIER))), (bundlePath) => fs.readFileString(bundlePath)))))));
+const writeHtmlFile = (fileName, html) => Effect.flatMap(FileSystem.FileSystem, (fs) => Effect.flatMap(Path.Path, (path) => Effect.andThen(fs.makeDirectory(path.dirname(fileName), { recursive: true }), fs.writeFileString(fileName, html))));
+const loadBundle = (cached) => Effect.filterOrElse(Ref.get(cached), (hit) => hit !== void 0, () => Effect.tap(readBundleContent, (fresh) => Ref.set(cached, fresh)));
+const writeReportHtml = (fileName, event, cached) => Effect.flatMap(loadBundle(cached), (bundle) => writeHtmlFile(fileName, buildHtmlDocument(HtmlReportCommand.make({
+	report: event.report,
+	scriptContent: bundle
+})).html));
+const failAsHtmlReporter = (cause) => ReporterFailed.make({
+	reporterName: "html",
+	event: "mutationTestReportReady",
+	cause: errorToString(cause)
 });
-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 writeReportHtmlIfReady = (fileName, event, cached) => {
+	if (S.is(MutationTestReportReady)(event)) return writeReportHtml(fileName, event, cached).pipe(Effect.mapError(failAsHtmlReporter));
+	return Effect.void;
 };
-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 htmlReporterFactory = makeHtmlReporter;
-const strykerPlugins = [declarePlugin("Reporter", "html", htmlReporterFactory)];
+const streamErrorOf = (cause) => ReporterFailed.make({
+	reporterName: "html",
+	event: "mutationTestReportReady",
+	cause: errorToString(cause)
+});
+const drainEvents = (fileName, events) => Effect.flatMap(Ref.make(void 0), (cached) => Stream.runForEach(Stream.fromAsyncIterable(events, streamErrorOf), (event) => writeReportHtmlIfReady(fileName, event, cached)));
+const makeHtmlReporter = (options, _init) => (events) => Effect.provide(drainEvents(options.htmlReporter.fileName, events), nodeFsPathLayer);
 //#endregion
-export { htmlReporterFactory, makeHtmlReporter, strykerPlugins };
+export { makeHtmlReporter };

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@systemfsoftware/stryker-js-html-reporter",
-  "version": "3.0.2",
+  "version": "4.0.0",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/systemfsoftware/systemfsoftware.git",
-    "directory": "packages/stryker-js/stryker-js-html-reporter"
+    "url": "git+https://github.com/systemfsoftware/stryker-js-effect.git",
+    "directory": "packages/stryker-js-html-reporter"
   },
-  "homepage": "https://github.com/systemfsoftware/systemfsoftware/tree/main/packages/stryker-js/stryker-js-html-reporter#readme",
-  "bugs": "https://github.com/systemfsoftware/systemfsoftware/issues",
+  "homepage": "https://github.com/systemfsoftware/stryker-js-effect",
+  "bugs": "https://github.com/systemfsoftware/stryker-js-effect/issues",
   "description": "HTML reporter plugin for the @systemfsoftware mutation engine.",
   "type": "module",
   "files": [
@@ -15,24 +15,28 @@
   ],
   "dependencies": {
     "@effect/platform-node-shared": "4.0.0-rc.112",
+    "@systemfsoftware/effect-cell-types": "^8",
     "mutation-testing-elements": "3.7.3",
-    "@systemfsoftware/effect-cell-types": "^7.0.1",
-    "@systemfsoftware/stryker-js": "^3.0.2"
+    "@systemfsoftware/stryker-js-language": "^5.0.0",
+    "@systemfsoftware/stryker-js-plugin-interface": "^5.0.0"
   },
   "devDependencies": {
-    "@systemfsoftware/arethetypeswrong-cli": "^4.1.0",
+    "@effect/tsgo": "^0.45.0",
+    "@microsoft/api-extractor": "^7",
+    "@systemfsoftware/all": "^2",
+    "@systemfsoftware/arethetypeswrong-cli": "^4",
+    "@systemfsoftware/effect-gherkin-spec": "^4",
+    "@systemfsoftware/tsconfig": "^1",
     "@types/node": "^24",
     "effect": "4.0.0-rc.112",
-    "oxlint": "^1.77.0",
-    "oxlint-tsgolint": "7.0.2001",
+    "oxlint": "^1",
+    "oxlint-tsgolint": "^7",
     "rimraf": "^6.1.3",
-    "tsdown": "^0.22.14",
+    "tsdown": "^0.23.0",
     "typescript": "^7",
     "vitest": "^4",
-    "@systemfsoftware/all": "^2.0.1",
-    "@systemfsoftware/tsconfig": "^1.3.4",
-    "@systemfsoftware/effect-gherkin-spec": "^4.0.2",
-    "@systemfsoftware/vitest-config": "^0.1.0"
+    "@systemfsoftware/vitest-config": "^0.1.0",
+    "@systemfsoftware/tsdown-config": "^0.1.0"
   },
   "engines": {
     "node": ">=20.0.0"
@@ -46,15 +50,21 @@
     "effect": "4.0.0-rc.112"
   },
   "exports": {
-    ".": "./dist/index.mjs",
+    ".": {
+      "types": "./dist/index.d.mts",
+      "default": "./dist/index.mjs"
+    },
     "./package.json": "./package.json"
   },
   "scripts": {
     "clean": "rimraf dist",
     "build": "tsdown",
-    "typecheck": "tsc --noEmit",
+    "typecheck": "tsc --noEmit --incremental && tsc -p tsconfig.node.json --noEmit",
     "attw": "attw --pack .",
     "test": "vitest run",
-    "lint": "f=${OXLINT_FORMAT:-${AGENT:+agent}}; oxlint --format=${f:-default}"
+    "lint": "f=${OXLINT_FORMAT:-${AGENT:+agent}}; oxlint --format=${f:-default}",
+    "api:check": "api-extractor run",
+    "api:update": "api-extractor run --local",
+    "lint:tsgo": "effect-tsgo diagnostics --project tsconfig.json --format ${TSGO_FORMAT:-text}"
   }
 }