@systemfsoftware/stryker-js-html-reporter 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,84 @@
+# @systemfsoftware/stryker-js-html-reporter
+
+## 0.1.0
+
+### Major Changes
+
+- Three packages are renamed. `plugin-api` is now `@systemfsoftware/stryker-js`, the
+  language every plugin is written against. `mutation-run` is now
+  `@systemfsoftware/stryker-js-platform-node`, the Node host that runs a mutation
+  test. `mutation-report` is now `@systemfsoftware/stryker-js-html-reporter`.
+  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.
+
+  - The engine's version and its engine range now come from the package's own
+    entry point.
+  - The failure identities you catch come from that same entry point rather than a
+    separate one.
+  - `toRelativeNormalizedFileName` comes from there too.
+  - A timer, and a barrel of plugin internals, are no longer reachable. Report's
+    `makeEmptyTimer` is gone with them; a progress tally now carries the instant
+    the run started rather than a timer object.
+
+  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.
+
+- 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/effect-cell-types@5.0.0

package/LICENSE

@@ -0,0 +1,203 @@
+Copyright (c) 2026 Ryan Lee (systemfsoftware)
+
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Ryan Lee (systemfsoftware)
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,32 @@
+[![NPM Version][npm-badge]][npm-url]
+[![License: Apache 2.0][license-badge]][license-url]
+
+# @systemfsoftware/stryker-js-html-reporter
+
+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:
+
+```ts
+import { makeHtmlReporter, strykerPlugins } from '@systemfsoftware/stryker-js-html-reporter'
+```
+
+## Related
+
+- [`@systemfsoftware/stryker-js-platform-node`][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
+
+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/testing/mutation/stryker-js/platform-node
+[cli]: https://github.com/systemfsoftware/systemfsoftware/tree/main/packages/testing/mutation/stryker-js/cli

package/dist/index.d.mts

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

package/dist/index.mjs

@@ -0,0 +1,126 @@
+import { RunConfiguration, declarePlugin } from "@systemfsoftware/stryker-js/Plugin";
+import { Reporter, ReporterFailed } 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 { pathToFileURL } from "url";
+import { createRequire } from "module";
+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 * 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
+}) {};
+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 }) {};
+function escapeHtmlTags(json) {
+	return json.replace(/</g, "<\"+\"");
+}
+function buildReportHtml(report, scriptContent) {
+	return `<!DOCTYPE html>
+  <html>
+  <head>
+    <meta charset="utf-8">
+    <script>
+      ${scriptContent}
+    <\/script>
+  </head>
+  <body>
+    <svg style="width: 80px; position:fixed; right:10px; bottom:10px; z-index:10" class="stryker-image" viewBox="0 0 1458 1458" xmlns="http://www.w3.org/2000/svg" fill-rule="evenodd" clip-rule="evenodd" stroke-linejoin="round" stroke-miterlimit="2"><path fill="none" d="M0 0h1458v1458H0z"/><clipPath id="a"><path d="M0 0h1458v1458H0z"/></clipPath><g clip-path="url(#a)"><path d="M1458 729c0 402.655-326.345 729-729 729S0 1131.655 0 729C0 326.445 326.345 0 729 0s729 326.345 729 729" fill="#e74c3c" fill-rule="nonzero"/><path d="M778.349 1456.15L576.6 1254.401l233-105 85-78.668v-64.332l-257-257-44-187-50-208 251.806-82.793L1076.6 389.401l380.14 379.15c-19.681 367.728-311.914 663.049-678.391 687.599z" fill-opacity=".3"/><path d="M753.4 329.503c41.79 0 74.579 7.83 97…</path></g></svg>
+    <mutation-test-report-app titlePostfix="Stryker">
+      Your browser doesn't support <a href="https://caniuse.com/#search=custom%20elements">custom elements</a>.
+      Please use a latest version of an evergreen browser (Firefox, Chrome, Safari, Opera, Edge, etc).
+    </mutation-test-report-app>
+    <script>
+      const app = document.querySelector('mutation-test-report-app');
+      app.report = ${escapeHtmlTags(JSON.stringify(report))};
+      function updateTheme() {
+        document.body.style.backgroundColor = app.themeBackgroundColor;
+      }
+      app.addEventListener('theme-changed', updateTheme);
+      updateTheme();
+    <\/script>
+  </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 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 = createRequire(import.meta.url).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);
+		yield* Effect.logInfo(`Your report can be found at: ${pathToFileURL(path.resolve(fileName)).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* () {
+			if (options === void 0) return;
+			if (heldReport === void 0) return;
+			yield* Cell.apply(htmlReportDescription, void 0);
+		}).pipe(Effect.catchCause((cause) => Effect.fail(new ReporterFailed({
+			reporterName: "html",
+			event: "wrapUp",
+			cause: Cause.pretty(cause)
+		}))))
+	};
+};
+//#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
+	});
+})))];
+//#endregion
+export { makeHtmlReporter, strykerPlugins };

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@systemfsoftware/stryker-js-html-reporter",
+  "version": "0.1.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/systemfsoftware/systemfsoftware.git",
+    "directory": "packages/testing/mutation/stryker-js/html-reporter"
+  },
+  "homepage": "https://github.com/systemfsoftware/systemfsoftware/tree/main/packages/testing/mutation/stryker-js/html-reporter#readme",
+  "bugs": "https://github.com/systemfsoftware/systemfsoftware/issues",
+  "description": "HTML reporter plugin for the @systemfsoftware mutation engine.",
+  "type": "module",
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "mutation-testing-elements": "3.7.3",
+    "mutation-testing-metrics": "3.7.3",
+    "mutation-testing-report-schema": "3.7.3",
+    "@systemfsoftware/effect-cell-types": "^5.0.0",
+    "@systemfsoftware/stryker-js": "^0.1.0"
+  },
+  "devDependencies": {
+    "@systemfsoftware/arethetypeswrong-cli": "^1.1.1",
+    "@types/node": "^24",
+    "effect": "^4.0.0-rc.112",
+    "oxlint": "^1.77.0",
+    "oxlint-tsgolint": ">=0.24.0",
+    "rimraf": "^6.1.3",
+    "tsdown": "^0.22.14",
+    "typescript": "^7",
+    "vitest": "^4.1.10",
+    "@systemfsoftware/all": "^1.0.0",
+    "@systemfsoftware/effect-gherkin-spec": "^2.0.1",
+    "@systemfsoftware/tsconfig": "^1.3.3",
+    "@systemfsoftware/vitest-config": "^0.1.0"
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "peerDependencies": {
+    "effect": "^4.0.0-rc.112"
+  },
+  "exports": {
+    ".": "./dist/index.mjs",
+    "./package.json": "./package.json"
+  },
+  "scripts": {
+    "clean": "rimraf dist",
+    "build": "tsdown",
+    "typecheck": "tsc --noEmit",
+    "attw": "attw --pack .",
+    "test": "vitest run",
+    "lint": "f=${OXLINT_FORMAT:-${AGENT:+agent}}; oxlint --format=${f:-default}"
+  }
+}