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

package/CHANGELOG.md

@@ -1,5 +1,96 @@
 # @systemfsoftware/stryker-js-html-reporter
 
+## 2.0.0
+
+### Major Changes
+
+- The packages are renamed. `plugin-api` is now `@systemfsoftware/stryker-js`, the
+  language every plugin is written against. `mutation-run` is split: the run
+  itself is `@systemfsoftware/stryker-js-engine`
+  (host-neutral, no Node on its manifest) and the Node process entries are
+  `@systemfsoftware/stryker-js-cli`, which owns the worker files and the runtime
+  gate. `mutation-report` is now `@systemfsoftware/stryker-js-html-reporter`.
+  `@systemfsoftware/stryker-js-platform-node` is never published — do not install
+  it. Install the new names and change your imports.
+
+  Options types moved. `StrykerOptions`, `PartialStrykerOptions` and `LogLevel` are
+  imported from the `Schema` export; `Mutant`, `MutantStatus`, `Position` and
+  `Location` from the `Mutant` export. Point a config's `extends` at the language
+  package's `Schema` export.
+
+  `MutantStatus` accepts one spelling per outcome: `Killed`, `Survived`,
+  `NoCoverage`, `Timeout`, `CompileError`, `RuntimeError`, `Ignored` and `Pending`.
+  The lowercase and abbreviated forms — `killed`, `timedOut`, `noCoverage` and the
+  rest — are gone. A comparison against a removed spelling never matched the value
+  the reporter actually produced, so check any status comparison you wrote.
+
+  Statuses, plugin kinds, exit classes and AST formats are string literal unions
+  rather than enums, so read them as their string values. Member access such as
+  `ExitClass.VerdictFail` no longer resolves.
+
+  A plugin no longer receives a logger, and the logger port is gone. Plugins log
+  through Effect, and the host decides where that output goes.
+
+  The bundled base preset is gone. A config inherits from the language package's
+  `Schema` export and states the thresholds, reporters and plugins it wants; you no
+  longer silently inherit a package manager, a plugin list or a break threshold.
+
+- effect is now a required peer dependency. Install it alongside these packages. They previously bundled their own copy, which meant two Effect instances in one process and services that could not find each other across the boundary.
+
+- Five entry points that were never API are gone. Each existed because another
+  package in this project found the code convenient, not because it was a surface
+  anyone should depend on.
+
+  What is left is documented: an entry point is a name you may import and we may
+  not move without a major, and everything else is internal whatever file it sits
+  in.
+
+- Reporters are constructed by a factory and provided as a layer.
+
+  The exported reporter classes are gone. Replace each `new` with the matching
+  factory — `makeClearTextReporter`, `makeHtmlReporter`, `makeJsonReporter`,
+  `makeProgressBarReporter`, `makeProgressStreamReporter`.
+
+  Each factory takes the reporter's own options rather than an injected container,
+  and each operation returns an `Effect`. If you registered a reporter as a plugin,
+  declare it with `declarePlugin` and hand over a layer that provides `Reporter`.
+
+  `drawClearTextScoreTable` is now exported for anyone rendering the score table
+  outside a reporter.
+
+### Patch Changes
+
+- New version is published through npm trusted publishing, so it carries a provenance attestation you can verify.
+
+- Peer Effect requirement advances to 4.0.0-rc.112. No API changes.
+
+- A mutation run writes the JSON report the `json` reporter is configured to produce.
+
+  Vitest no longer reprints its full summary for every mutant.
+
+- Each of these packages now has a README, so its registry page says what the package is, how
+  to install it, and what to import or register — previously the page was blank. The lint
+  plugins show the configuration line that enables what they recommend.
+
+  `@systemfsoftware/stryker-js-html-reporter` also carries its licence text
+
+- Published packages no longer carry build artifacts left over from earlier builds. One package was shipping about a megabyte of bundled test-runner internals this way.
+
+- Updated dependencies:
+  - @systemfsoftware/stryker-js@2.0.0
+
+## 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
-[cli]: https://github.com/systemfsoftware/systemfsoftware/tree/main/packages/testing/mutation/stryker-js/cli
+[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

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,12 +1,12 @@
 {
   "name": "@systemfsoftware/stryker-js-html-reporter",
-  "version": "0.1.2",
+  "version": "2.0.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/systemfsoftware/systemfsoftware.git",
-    "directory": "packages/testing/mutation/stryker-js/html-reporter"
+    "directory": "packages/stryker-js/stryker-js-html-reporter"
   },
-  "homepage": "https://github.com/systemfsoftware/systemfsoftware/tree/main/packages/testing/mutation/stryker-js/html-reporter#readme",
+  "homepage": "https://github.com/systemfsoftware/systemfsoftware/tree/main/packages/stryker-js/stryker-js-html-reporter#readme",
   "bugs": "https://github.com/systemfsoftware/systemfsoftware/issues",
   "description": "HTML reporter plugin for the @systemfsoftware mutation engine.",
   "type": "module",
@@ -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.1",
+    "@systemfsoftware/stryker-js": "^2.0.0"
   },
   "devDependencies": {
     "@systemfsoftware/arethetypeswrong-cli": "^1.1.1",
@@ -30,8 +30,8 @@
     "tsdown": "^0.22.14",
     "typescript": "^7",
     "vitest": "^4",
-    "@systemfsoftware/all": "^1.1.0",
-    "@systemfsoftware/effect-gherkin-spec": "^4.0.0",
+    "@systemfsoftware/all": "^1.1.3",
+    "@systemfsoftware/effect-gherkin-spec": "^4.0.1",
     "@systemfsoftware/tsconfig": "^1.3.3",
     "@systemfsoftware/vitest-config": "^0.1.0"
   },