@hublo/sentinel 1.4.0-alpha.4 → 1.4.0-alpha.41

package/README.md

@@ -24,6 +24,7 @@ A large monorepo accumulates:
 - **One source of truth for config** — every project just `extends @hublo/sentinel/...`; the actual rules live in one versioned place. Change a rule once, everyone gets it on the next version bump.
 - **One source of truth for tooling dependencies** — a project depends on `@hublo/sentinel`, not on a scattered pile of eslint / vitest / plugin devDeps. Bump one version and the whole toolchain moves, atomically, tested in isolation first.
 - **`--init` sets a module up** — the one command generates the stubs the first time (**adopt**), regenerates them after a change like a runner swap (**refresh**), and applies the workspace prep the module needs. Run it module by module to roll out gradually. (`--migrate`, for changing an already-initialized setup, is a reserved future verb.)
+- **`--validate` proves the move did not change anything** — a verb of its own, because what separates it from `--init` is what SURVIVES the run: `--init` and `--migrate` write state that REMAINS, `--validate` may instrument the module it is proving provided nothing it writes stays. Run before a migration it records what the module does today; run after, it compares and refuses a run that lost a test or invented one. It composes with every type, and answers "not available yet" for the ones without a proof rather than calling a valid command wrong.
 - **Move one module at a time** — installed per module, so you adopt at your pace; a module can adopt sentinel while its neighbour keeps the old setup. No big-bang.
 - **Swap tools without touching projects** — change eslint → biome (or benchmark them) in one place; `--init` regenerates the stubs.
 - **No silent drift** — the guard keeps every project's config converged on the source of truth.

package/dist/bin/sentinel.d.ts

@@ -4,3 +4,4 @@ import '@vitejs/plugin-react';
 import 'nitro/vite';
 import 'vite-plugin-svgr';
 import 'vite';
+import 'msw';

package/dist/bin/sentinel.js

@@ -14,118 +14,33 @@ import {
   dispatch,
   palette,
   registerAdapters,
-  resolve,
-  resolveBin
-} from "../chunk-ASBZQAXV.js";
+  resolve
+} from "../chunk-2UU57Y2T.js";
+import {
+  resolveContext
+} from "../chunk-I3FX32E7.js";
+import "../chunk-O7REVMOC.js";
+import "../chunk-QXFCZON7.js";
 import {
-  WORKSPACE_ROOT_MARKER,
   ensureWorkspacePrep,
   findWorkspaceRoot,
   inspectWorkspacePrep,
-  moduleName,
   readOwnVersion,
   readProjectPackageJson
-} from "../chunk-WLFE5RUU.js";
+} from "../chunk-NW6UHNYX.js";
 
 // bin/sentinel.ts
 import { program } from "commander";
 
-// src/core/context.ts
-import { existsSync } from "fs";
-import { join as join2 } from "path";
-
-// src/core/discover-modules.ts
-import { execFileSync } from "child_process";
-import { mkdtempSync, readFileSync, rmSync } from "fs";
-import { tmpdir } from "os";
-import { join } from "path";
-function runNx(cwd2, args) {
-  const nx = resolveBin(cwd2, "nx") ?? "nx";
-  try {
-    return execFileSync(nx, args, {
-      cwd: cwd2,
-      encoding: "utf8",
-      env: { ...process.env, NX_DAEMON: "false" }
-    });
-  } catch (error) {
-    const message = error instanceof Error ? error.message : String(error);
-    throw new Error(
-      `sentinel: could not run nx (${message}). Is nx installed in this workspace, and are you at its root?`,
-      { cause: error }
-    );
-  }
-}
-function readGraph(cwd2) {
-  const dir = mkdtempSync(join(tmpdir(), "sentinel-nx-"));
-  const file = join(dir, "graph.json");
-  try {
-    runNx(cwd2, ["graph", "--file", file]);
-    const parsed = JSON.parse(readFileSync(file, "utf8"));
-    const nodes = parsed.graph?.nodes;
-    if (!nodes || typeof nodes !== "object") {
-      throw new Error(
-        "sentinel: unexpected nx graph output (no graph.nodes); the installed nx version may be incompatible."
-      );
-    }
-    return Object.entries(nodes).map(([name, node]) => ({
-      name,
-      root: join(cwd2, node.data.root)
-    }));
-  } finally {
-    rmSync(dir, { recursive: true, force: true });
-  }
-}
-function discoverModules(cwd2, options = {}) {
-  const modules = readGraph(cwd2);
-  if (!options.affected) return modules;
-  const affected = new Set(
-    JSON.parse(runNx(cwd2, ["show", "projects", "--affected", "--json"]))
-  );
-  return modules.filter((module) => affected.has(module.name));
-}
-
-// src/core/context.ts
-var MODULE_MARKERS = ["package.json", "project.json"];
-function isModuleDir(cwd2) {
-  return MODULE_MARKERS.some((marker) => existsSync(join2(cwd2, marker)));
-}
-function resolveContext(cwd2, opts2) {
-  const atRoot = existsSync(join2(cwd2, WORKSPACE_ROOT_MARKER));
-  if (!atRoot && isModuleDir(cwd2)) {
-    if (opts2.module) {
-      throw new Error(
-        "You are in a module directory: drop --module (the context is the current module)."
-      );
-    }
-    if (opts2.ci) {
-      throw new Error("--ci selects the affected set from the workspace root; run it there.");
-    }
-    const name = moduleName(cwd2);
-    return { modules: [{ name, root: cwd2 }], scope: "cwd-module" };
-  }
-  if (atRoot) {
-    if (opts2.module) {
-      const found = discoverModules(cwd2).find((module) => module.name === opts2.module);
-      if (!found) throw new Error(`module "${opts2.module}" not found in the workspace.`);
-      return { modules: [found], scope: "named-module" };
-    }
-    if (opts2.ci) return { modules: discoverModules(cwd2, { affected: true }), scope: "affected" };
-    return { modules: discoverModules(cwd2), scope: "all" };
-  }
-  throw new Error(
-    `Run sentinel from a module directory or the workspace root (found neither ${MODULE_MARKERS.join("/")} nor ${WORKSPACE_ROOT_MARKER} here).`
-  );
-}
-
 // src/roles/build/declined.ts
-import { existsSync as existsSync2, readFileSync as readFileSync2 } from "fs";
-import { join as join3 } from "path";
+import { existsSync, readFileSync } from "node:fs";
+import { join } from "node:path";
 var DEPRECATED_NX_BUILDER = "@nx/webpack:webpack";
 function buildsWithDeprecatedExecutor(cwd2) {
-  const projectJson = join3(cwd2, "project.json");
-  if (!existsSync2(projectJson)) return false;
+  const projectJson = join(cwd2, "project.json");
+  if (!existsSync(projectJson)) return false;
   try {
-    const project = JSON.parse(readFileSync2(projectJson, "utf8"));
+    const project = JSON.parse(readFileSync(projectJson, "utf8"));
     return project.targets?.build?.executor === DEPRECATED_NX_BUILDER;
   } catch {
     return false;
@@ -218,6 +133,32 @@ sentinel (${type}): ${asMessage(error)}
   return worst;
 }
 
+// src/cli/run-validate.ts
+async function runValidate(ctx) {
+  const { modules } = resolveContext(ctx.cwd, { module: ctx.module, ci: ctx.ci });
+  const unsupported = ctx.targets.filter((target) => target !== "test");
+  if (unsupported.length > 0) {
+    const named = unsupported.map((target) => `--${target}`).join(", ");
+    process.stdout.write(
+      `  \xB7 ${named}: not available yet. \`--validate\` answers \`--test\` today, by recording a suite before a migration and comparing it after. Nothing was checked for ${named}.
+`
+    );
+  }
+  if (!ctx.targets.includes("test")) return 1;
+  const { validateModuleTests } = await import("../validate-ANM7RQ3C.js");
+  const outcomes = modules.flatMap(
+    (module) => validateModuleTests(module.name, module.root)
+  );
+  for (const outcome of outcomes) {
+    const suite = outcome.suite === "main" ? "" : ` [${outcome.suite}]`;
+    process.stdout.write(
+      `  ${outcome.ok ? "\u2713" : "\u2717"} ${outcome.module}${suite} \u2014 ${outcome.message}
+`
+    );
+  }
+  return outcomes.every((outcome) => outcome.ok) ? 0 : 1;
+}
+
 // src/core/orchestrate.ts
 async function analyse(params) {
   const results = [];
@@ -645,13 +586,16 @@ program.name("sentinel").description("One CLI that guards code health: presets,
   "before",
   [
     "A check composes: verb + type + location.",
-    "  verb    what to do:   --run  --inspect  --report  --status  --init  (--migrate: planned)",
+    "  verb    what to do:   --run  --inspect  --report  --status  --init  --validate  (--migrate: planned)",
     "  type    which check:  --lint --typescript ...  (omit = all types; or --all)",
     "  where   run from a MODULE dir \u2192 that module; from the ROOT \u2192 --module <name>,",
     "          --ci (affected), or all modules. --init targets one module only.",
     ""
   ].join("\n")
-).option("--run", "execute the target tool").option("--inspect", "show the resolved configuration").option("--init", "set up a module: write its config stubs + the workspace prep it needs").option("--migrate", "planned: change an already-initialized setup (not available yet)").option("--report", "deprecated: use --run --json").option("--status", "deprecated: use --inspect").option(
+).option("--run", "execute the target tool").option("--inspect", "show the resolved configuration").option("--init", "set up a module: write its config stubs + the workspace prep it needs").option("--migrate", "planned: change an already-initialized setup (not available yet)").option(
+  "--validate",
+  "prove a migration kept the suite: record the reference, then compare against it"
+).option("--report", "deprecated: use --run --json").option("--status", "deprecated: use --inspect").option(
   "--module <name>",
   "from the workspace root: scope to one module (omit = all; inside a module dir, drop this)"
 ).option("--preset <name>", `the stack preset to apply (${PRESET_NAMES.join(", ")})`).option("--flavour <name>", "deprecated: use --preset").option("--runner <tool>", "override the default runner (e.g. eslint, biome)").option("--ci", "CI mode: from the root, only the affected modules; non-zero exit on failure").option("--fix", "auto-fix where applicable").option("--dry-run", "preview the changes without writing (--init)").option("--json", "machine-readable output, for every verb").option(
@@ -783,7 +727,7 @@ async function main() {
     dryRun: Boolean(opts.dryRun),
     fail: (message) => program.error(message)
   };
-  const exitCode = verb === "init" ? await runInit(context) : await runVerb(context);
+  const exitCode = verb === "init" ? await runInit(context) : verb === "validate" ? await runValidate(context) : await runVerb(context);
   await exitWithoutTruncating(exitCode);
 }
 main().catch((error) => {
@@ -792,4 +736,3 @@ sentinel: ${asMessage2(error)}
 `);
   void exitWithoutTruncating(1);
 });
-//# sourceMappingURL=sentinel.js.map