@ingenioz-it/caits 0.5.0 → 0.5.1

package/bin/caits.js

@@ -23,6 +23,8 @@ const USAGE = `Usage: caits <command>
   check <script>…      Runs the npm scripts of the checks at once. Shows the output of the checks that fail, and only theirs.
   architecture         Checks the rules of quality/architecture.mjs.
   e2e                  Runs the end-to-end tests on the production build.
+  mutation             Runs the mutation tests (Stryker), then gives the score of each file and the mutants that survived. Its exit
+                       code is that of Stryker.
   mutation-summary     Gives the mutation score of each file (--survivors: the mutants that survived).
   mutation-suite       The unit tests, as Stryker runs them for each mutant.
 
@@ -30,7 +32,7 @@ const USAGE = `Usage: caits <command>
   --version            Shows the version of CAITS.`;
 
 /** The commands that run a tool of quality/: their code is in the folder quality/ of CAITS. */
-const TOOLS = new Set(["dev", "check", "architecture", "e2e", "mutation-summary", "mutation-suite"]);
+const TOOLS = new Set(["dev", "check", "architecture", "e2e", "mutation", "mutation-summary", "mutation-suite"]);
 
 /** The options of `caits init`. */
 const INIT_OPTIONS = /** @type {const} */ ({ caits: { type: "string" }, example: { type: "boolean" }, "example-source": { type: "string" }, "no-install": { type: "boolean" } });

package/bin/init.js

@@ -99,7 +99,7 @@ const PACKAGE = {
     "test:integration": "vitest run --config quality/vite.config.ts .integration.test.ts",
     "test:e2e": "caits e2e",
     "test:coverage": "vitest run --config quality/vite.config.ts --coverage --reporter=default --reporter=@ingenioz-it/caits/quality/test-docs/vitest-reporter",
-    "test:mutation": "stryker run quality/stryker.config.mjs && caits mutation-summary",
+    "test:mutation": "caits mutation",
     tdd: "vitest --config quality/vite.config.ts",
     check: "caits check typecheck lint:code lint:architecture test:coverage test:mutation test:e2e"
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ingenioz-it/caits",
-  "version": "0.5.0",
+  "version": "0.5.1",
   "description": "CAITS (Clean Architecture In TypeScript): the technical base of a Marko project with a backend and a frontend.",
   "keywords": [
     "clean-architecture",

package/quality/mutation-summary.mjs

@@ -2,7 +2,7 @@
 import { existsSync, readFileSync } from "node:fs";
 
 /** The report that Stryker writes in JSON (quality/caits/stryker.mjs). */
-const REPORT = "reports/mutation/mutation.json";
+export const REPORT = "reports/mutation/mutation.json";
 
 /** @typedef {{ status: string; mutatorName: string; replacement?: string; location: { start: { line: number } } }} Mutant */
 

package/quality/mutation.mjs

@@ -0,0 +1,30 @@
+// `caits mutation`: the mutation tests (Stryker, with quality/stryker.config.mjs), then the score of each file and the mutants that
+// survived, whether Stryker passed or not. Stryker alone ends with its threshold when the score is too low: the survivors say what to fix.
+import { spawn } from "node:child_process";
+import { existsSync, rmSync } from "node:fs";
+import { REPORT, run as summary } from "./mutation-summary.mjs";
+
+/** The configuration of Stryker in a project: it imports the defaults of CAITS (quality/caits/stryker.mjs). */
+export const STRYKER_CONFIG = "quality/stryker.config.mjs";
+
+/**
+ * @param {string[]} args the options of Stryker
+ * @returns {Promise<number>} the exit code of Stryker
+ */
+export async function run(args) {
+  if (!existsSync(STRYKER_CONFIG)) throw new Error(`${STRYKER_CONFIG} is missing: it gives the configuration of the mutation tests. Run \`npx caits init .\` to write it.`);
+  // A run that stops before its report must not show the summary of the run before.
+  rmSync(REPORT, { force: true });
+  // Ctrl+C and `caits check` stop the whole group of processes: Stryker and its test runners stop with this command.
+  const stryker = spawn("npx", ["stryker", "run", STRYKER_CONFIG, ...args], { stdio: "inherit" });
+  /** @type {number} */
+  const status = await new Promise(resolve => {
+    stryker.on("error", () => resolve(1));
+    stryker.on("close", code => resolve(code ?? 1));
+  });
+  if (existsSync(REPORT)) {
+    console.log("");
+    summary(["--survivors"]);
+  }
+  return status;
+}