@williamthorsen/nmr 0.35.0 → 0.37.0

package/.readyup/kits/default.js

@@ -1,18 +1,18 @@
 /** @noformat -- @generated. Do not edit. Compiled by rdy. */
 /* eslint-disable */
-export const __readyupVersion = "0.35.0";
+export const __readyupVersion = "0.36.0";
 
 
 // .readyup/kits/default.ts
 import { existsSync, globSync, readdirSync as readdirSync2 } from "node:fs";
-import { basename, dirname, join, sep } from "node:path";
+import { basename, dirname, join, posix, sep } from "node:path";
 
-// ../../node_modules/.pnpm/@williamthorsen+toolbelt.errors@0.6.3/node_modules/@williamthorsen/toolbelt.errors/dist/esm/4-release/isError.js
+// ../../node_modules/.pnpm/@williamthorsen+toolbelt.errors@0.7.0/node_modules/@williamthorsen/toolbelt.errors/dist/esm/4-release/isError.js
 function isError(error) {
   return error instanceof Error || Object.prototype.toString.call(error) === "[object Error]";
 }
 
-// ../../node_modules/.pnpm/@williamthorsen+toolbelt.errors@0.6.3/node_modules/@williamthorsen/toolbelt.errors/dist/esm/4-release/describeError.js
+// ../../node_modules/.pnpm/@williamthorsen+toolbelt.errors@0.7.0/node_modules/@williamthorsen/toolbelt.errors/dist/esm/4-release/describeError.js
 function describeError(error) {
   try {
     if (isError(error) && typeof error.message === "string" && error.message !== "") {
@@ -34,6 +34,7 @@ import {
   hasMinDevDependencyVersion,
   hasPackageJsonField,
   isRecord,
+  listTrackedFiles,
   readFile,
   readPackageJson
 } from "readyup/check-utils";
@@ -128,9 +129,15 @@ var TEST_EXTENSIONS = "{ts,tsx}";
 var TEST_GLOB_PREFIX = `**/${TEST_DIR}/**`;
 var TEST_FILE_PATTERN = /\.test\.tsx?$/;
 var ALL_TEST_PATTERNS = [`${TEST_GLOB_PREFIX}/*.test.${TEST_EXTENSIONS}`];
+function findMisplacedTestFiles(rootDir, options = {}) {
+  return walkTestFiles(rootDir, options, true);
+}
 function findTestFiles(rootDir, options = {}) {
   return walkTestFiles(rootDir, options, false);
 }
+function findUntieredTestFiles(rootDir, options = {}) {
+  return findTestFiles(rootDir, options).filter((file) => !hasTierInfix(file));
+}
 function hasTierInfix(filePath) {
   const tiers = TIER_NAMES;
   return tiers.includes(path.basename(filePath).split(".").at(-3) ?? "");
@@ -251,6 +258,14 @@ var default_default = defineRdyKit({
           check: noRedundantRootScripts,
           fix: "Remove scripts from root package.json that nmr provides as built-in root scripts \u2014 invoke via nmr directly"
         },
+        // -- Git hooks -----------------------------------------------------------
+        {
+          name: "no root install script runs lefthook install unguarded",
+          severity: "warn",
+          quiet: true,
+          check: () => noUnguardedLefthookInstall(),
+          fix: "Guard each listed script as `lefthook check-install || lefthook install`, which writes hooks only when they are missing or stale. A bare `lefthook install` rewrites `.git/hooks` on every install, so when that directory is not writable, as in an agent's sandbox, `pnpm install` fails and pnpm's `verifyDepsBeforeRun` then reinstalls before every `pnpm exec`"
+        },
         // -- Workspace build readiness -------------------------------------------
         {
           name: "all workspace packages can build",
@@ -258,6 +273,19 @@ var default_default = defineRdyKit({
           check: allWorkspacePackagesCanBuild,
           fix: `Add "build": ":" to packages that don't need a build, or ensure packages that use the default nmr build have a tsconfig.json and a src/ directory`
         },
+        // -- Bin targets ---------------------------------------------------------
+        {
+          name: "every bin target is a committed wrapper",
+          severity: "error",
+          check: () => everyBinTargetIsACommittedWrapper(),
+          fix: `Point each listed entry at a committed wrapper under bin/ that loads the build output at runtime. pnpm links a workspace package's bins during the install's link phase, which runs before anything is built, so a target that is not committed does not exist when pnpm reaches for it \u2014 and pnpm never retries, leaving the link missing for the life of the node_modules tree`
+        },
+        {
+          name: "every bin wrapper's build-output target is covered by files",
+          severity: "warn",
+          check: () => everyBinWrapperTargetIsCoveredByFiles(),
+          fix: "Add the build output directory to `files` in each listed package. npm and pnpm publish the bin target itself whatever `files` says, so the wrapper ships pointing at build output missing from the tarball"
+        },
         // -- Vitest projects -----------------------------------------------------
         {
           name: "no retired Vitest config variants",
@@ -284,12 +312,26 @@ var default_default = defineRdyKit({
           check: () => everyViteConfigHasVitestConfig(),
           fix: "Add a vitest.config.ts calling defineVitestConfig() from @williamthorsen/nmr/vitest beside each listed vite.config -- Vitest stops its config search at the first directory holding either name, so the Vite config otherwise wins and the projects model is never reached"
         },
+        {
+          name: "the test suite gates the test-file conventions",
+          severity: "warn",
+          check: () => testSuiteGatesTestFileConventions(),
+          fix: "Add a test of the repo's own under a __tests__ directory that declares the check: import { checkTestFileConventions } from '@williamthorsen/nmr/tests'; checkTestFileConventions(); -- passing `exclude` the directory names that the repo passes to `testCollectionExclude`. Without it no test run reports an untiered or misplaced test file, and this kit reports them in its place against nmr's built-in exclusions alone"
+        },
         {
           name: "every test file names its isolation tier",
           severity: "error",
+          skip: () => describeConventionsGuardSkip(),
           check: () => everyTestFileNamesItsTier(),
           fix: `Rename each to <subject>[.<aspect>].<tier>.test.ts, naming one of ${TIER_NAMES.join(", ")}. Use tool for a test that reaches a program the environment supplies, which is where a retired .int. or .integration. file belongs. Only the segment before .test. selects a project, so an untiered file runs under the residual unit project and reports success`
         },
+        {
+          name: "every test file sits under a __tests__ directory",
+          severity: "error",
+          skip: () => describeConventionsGuardSkip(),
+          check: () => everyTestFileSitsUnderTestsDir(),
+          fix: "Move each into a __tests__ directory, the only place from which the shared Vitest config collects. No project collects a file outside one, so it runs nowhere and reports nothing. For a file that is not a test, declare checkTestFileConventions with its directory in `exclude` instead, which this check then defers to"
+        },
         {
           name: "no package re-exports the ancestor Vitest config",
           severity: "recommend",
@@ -345,6 +387,8 @@ var default_default = defineRdyKit({
   ]
 });
 var SCAN_EXCLUDE_DIRS = /* @__PURE__ */ new Set([".git", "coverage", "dist", "node_modules"]);
+var BUILD_OUTPUT_DIR = "dist";
+var WRAPPER_TARGET_PATTERN = /['"](\.\.?\/[^'"]+)['"]/;
 var CONFIG_EXTENSIONS = "{ts,mts,cts,js,mjs,cjs}";
 var VITE_CONFIG_PATTERN = `vite.config.${CONFIG_EXTENSIONS}`;
 var VITEST_CONFIG_PATTERN = `vitest.config.${CONFIG_EXTENSIONS}`;
@@ -352,6 +396,7 @@ var SHARED_VITEST_MODULE = "@williamthorsen/nmr/vitest";
 var SHARED_PRETTIER_MODULE = "@williamthorsen/nmr/prettier";
 var INERT_PRETTIER_CONFIGS = [".prettierrc", ".prettierrc.{json,json5,yaml,yml,toml}"];
 var SHARED_TAZE_MODULE = "@williamthorsen/nmr/taze";
+var SHARED_TESTS_MODULE = "@williamthorsen/nmr/tests";
 var INERT_TAZE_CONFIGS = [".tazerc", ".tazerc.json", "taze.config.json"];
 var CLOBBERED_TAZE_OPTIONS = [
   { key: "concurrency", pattern: /\bconcurrency\s*:/ },
@@ -361,6 +406,17 @@ var CLOBBERED_TAZE_OPTIONS = [
   { key: "requestTimeout", pattern: /\brequestTimeout\s*:/ }
 ];
 var RE_EXPORT_LINE_PATTERN = /^export\s*(?:\{\s*default\s*}|\*)\s*from\s*['"]\.\.\/[^'"]*['"];?$/;
+var INSTALL_LIFECYCLE_SCRIPTS = [
+  "pnpm:devPreinstall",
+  "preinstall",
+  "install",
+  "postinstall",
+  "preprepare",
+  "prepare",
+  "postprepare"
+];
+var LEFTHOOK_CHECK_INSTALL_PATTERN = /\blefthook\s+check-install\b/;
+var LEFTHOOK_INSTALL_PATTERN = /\blefthook\s+install\b/;
 var MIN_ESLINT_VERSION = "10.0.0";
 var MIN_STRICT_LINT_VERSION = "9.3.0";
 var WORKSPACE_VERSION_MARKERS = ["catalog:", "workspace:"];
@@ -445,11 +501,80 @@ function discoverMemberWorkspaces() {
     return { ok: false, detail: `cannot enumerate workspaces: ${describeError(error)}` };
   }
 }
+async function everyBinTargetIsACommittedWrapper() {
+  const discovery = discoverMemberWorkspaces();
+  if (!discovery.ok) return discovery;
+  const tracked = await listTrackedFiles();
+  const trackedPaths = tracked === void 0 ? void 0 : new Set(tracked);
+  const offenders = discovery.workspaces.flatMap(
+    (workspace) => readBinEntries(workspace).flatMap((entry) => {
+      const defect = describeBinTargetDefect(workspace, entry, trackedPaths);
+      return defect === void 0 ? [] : [`${describeBinEntry(workspace, entry)} (${defect})`];
+    })
+  );
+  if (offenders.length === 0) return true;
+  return { ok: false, detail: formatPaths(offenders) };
+}
+function everyBinWrapperTargetIsCoveredByFiles() {
+  const discovery = discoverMemberWorkspaces();
+  if (!discovery.ok) return discovery;
+  const cwd = process.cwd();
+  const offenders = discovery.workspaces.flatMap((workspace) => {
+    const files = workspace.packageJson["files"];
+    if (!Array.isArray(files)) return [];
+    const published = new Set(files.flatMap((entry) => typeof entry === "string" ? [readFirstSegment(entry)] : []));
+    return readBinEntries(workspace).flatMap((entry) => {
+      const target = readWrapperTarget(cwd, workspace, entry);
+      if (target === void 0 || published.has(readFirstSegment(target))) return [];
+      return [`${describeBinEntry(workspace, entry)} -> ${target}`];
+    });
+  });
+  if (offenders.length === 0) return true;
+  return { ok: false, detail: formatPaths(offenders) };
+}
+function describeBinEntry(workspace, entry) {
+  return `${workspace.name ?? workspace.dir}:${entry.command} -> ${entry.target}`;
+}
+function describeBinTargetDefect(workspace, entry, trackedPaths) {
+  if (readFirstSegment(entry.target) === BUILD_OUTPUT_DIR) return `names a path under ${BUILD_OUTPUT_DIR}/`;
+  if (trackedPaths === void 0) return void 0;
+  return trackedPaths.has(`${workspace.dir}/${entry.target}`) ? void 0 : "untracked";
+}
+function normalizeBinTarget(target) {
+  return target.replace(/^\.\//, "");
+}
+function readBinEntries(workspace) {
+  const bin = workspace.packageJson["bin"];
+  if (typeof bin === "string") {
+    const command = workspace.name?.split("/").at(-1) ?? basename(workspace.dir);
+    return [{ command, target: normalizeBinTarget(bin) }];
+  }
+  if (!isRecord(bin)) return [];
+  return Object.entries(bin).flatMap(
+    ([command, target]) => typeof target === "string" ? [{ command, target: normalizeBinTarget(target) }] : []
+  );
+}
+function readFirstSegment(entry) {
+  return normalizeBinTarget(entry).split("/", 1).at(0) ?? "";
+}
+function readWrapperTarget(cwd, workspace, entry) {
+  if (readFirstSegment(entry.target) === BUILD_OUTPUT_DIR) return void 0;
+  const content = readFileIn(cwd, `${workspace.dir}/${entry.target}`);
+  if (content === void 0) return void 0;
+  const specifier = WRAPPER_TARGET_PATTERN.exec(content)?.[1];
+  if (specifier === void 0) return void 0;
+  return posix.normalize(posix.join(posix.dirname(entry.target), specifier));
+}
 function everyTestFileNamesItsTier(cwd = process.cwd()) {
-  const untiered = findTestFiles(cwd).filter((path2) => !hasTierInfix(path2));
+  const untiered = findUntieredTestFiles(cwd);
   if (untiered.length === 0) return true;
   return { ok: false, detail: formatPaths(untiered) };
 }
+function everyTestFileSitsUnderTestsDir(cwd = process.cwd()) {
+  const misplaced = findMisplacedTestFiles(cwd);
+  if (misplaced.length === 0) return true;
+  return { ok: false, detail: formatPaths(misplaced) };
+}
 function everyViteConfigHasVitestConfig() {
   const discovery = discoverMemberWorkspaces();
   if (!discovery.ok) return discovery;
@@ -472,7 +597,7 @@ function formatPaths(paths) {
 ${paths.map((path2) => `      ${path2}`).join("\n")}`;
 }
 function getMinVersion() {
-  const picked = { "version": "0.35.0" };
+  const picked = { "version": "0.37.0" };
   if (typeof picked["version"] !== "string") {
     throw new TypeError("nmr/package.json: 'version' must be a string");
   }
@@ -538,6 +663,17 @@ function noRetiredVitestConfigs(cwd = process.cwd()) {
     cwd
   );
 }
+function noUnguardedLefthookInstall(cwd = process.cwd()) {
+  const scripts = readRootScripts(cwd);
+  const unguarded = INSTALL_LIFECYCLE_SCRIPTS.flatMap((name) => {
+    const command = scripts[name];
+    if (typeof command !== "string") return [];
+    const isUnguarded = LEFTHOOK_INSTALL_PATTERN.test(command) && !LEFTHOOK_CHECK_INSTALL_PATTERN.test(command);
+    return isUnguarded ? [`${name}: ${command}`] : [];
+  });
+  if (unguarded.length === 0) return true;
+  return { ok: false, detail: formatPaths(unguarded) };
+}
 function noWorkspaceRunScriptReferences() {
   const packagesDir = join(process.cwd(), "packages");
   if (!existsSync(packagesDir)) return true;
@@ -572,6 +708,19 @@ function readPnpmFieldKeys(content) {
   const pnpm = parsed["pnpm"];
   return isRecord(pnpm) ? Object.keys(pnpm).toSorted() : void 0;
 }
+function readRootScripts(cwd) {
+  const content = readFileIn(cwd, "package.json");
+  if (content === void 0) return {};
+  let parsed;
+  try {
+    parsed = JSON.parse(content);
+  } catch {
+    return {};
+  }
+  if (!isRecord(parsed)) return {};
+  const scripts = parsed["scripts"];
+  return isRecord(scripts) ? scripts : {};
+}
 function resolvesVersionViaWorkspace(range) {
   return WORKSPACE_VERSION_MARKERS.some((marker) => range.startsWith(marker));
 }
@@ -603,6 +752,22 @@ function describeMissingTazeConfig(cwd) {
   if (inert.length > 0) return `holds no code to call the factory: ${inert.join(", ")}`;
   return "taze.config.ts is missing";
 }
+function testSuiteGatesTestFileConventions(cwd = process.cwd()) {
+  if (findConventionsGuard(cwd) !== void 0) return true;
+  return {
+    ok: false,
+    detail: `no test file under __tests__ imports checkTestFileConventions from ${SHARED_TESTS_MODULE}`
+  };
+}
+function describeConventionsGuardSkip() {
+  const guard = findConventionsGuard(process.cwd());
+  return guard === void 0 ? false : `reported by checkTestFileConventions in ${guard}`;
+}
+function findConventionsGuard(cwd) {
+  return findTestFiles(cwd).find(
+    (relativePath) => importsSharedExport(readFileIn(cwd, relativePath), "checkTestFileConventions", SHARED_TESTS_MODULE)
+  );
+}
 function toolVersionsHasNoPnpm() {
   const content = readFile(".tool-versions");
   if (content === void 0) return true;
@@ -626,16 +791,21 @@ function vitestRootConfigBuildsOnSharedConfig(cwd = process.cwd()) {
 }
 export {
   default_default as default,
+  everyBinTargetIsACommittedWrapper,
+  everyBinWrapperTargetIsCoveredByFiles,
   everyTestFileNamesItsTier,
+  everyTestFileSitsUnderTestsDir,
   everyViteConfigHasVitestConfig,
   hasSupportedEslintVersion,
   hasSupportedStrictLintVersion,
   noPnpmFieldInPackageJson,
   noReExportOnlyVitestConfigs,
   noRetiredVitestConfigs,
+  noUnguardedLefthookInstall,
   prettierConfigBuildsOnSharedConfig,
   tazeConfigAvoidsClobberedOptions,
   tazeConfigBuildsOnSharedConfig,
+  testSuiteGatesTestFileConventions,
   vitestConfigBuildsOnSharedConfig,
   vitestRootConfigBuildsOnSharedConfig
 };

package/.readyup/manifest.json

@@ -3,7 +3,7 @@
   "kits": [
     {
       "bundledDependencies": {
-        "@williamthorsen/toolbelt.errors": "0.6.3"
+        "@williamthorsen/toolbelt.errors": "0.7.0"
       },
       "checklists": [
         "nmr"
@@ -11,12 +11,12 @@
       "esbuildVersion": "0.28.2",
       "inputs": [
         {
-          "hash": "b67d9796",
+          "hash": "488459c0",
           "kind": "module",
           "path": "kits/default.ts"
         },
         {
-          "hash": "7a897007",
+          "hash": "d4b2e208",
           "kind": "inline",
           "path": "../package.json",
           "paths": [
@@ -41,10 +41,10 @@
       ],
       "name": "default",
       "path": "kits/default.js",
-      "readyupVersion": "0.35.0",
+      "readyupVersion": "0.36.0",
       "source": "kits/default.ts",
-      "sourceHash": "b67d9796",
-      "targetHash": "3cd6b2d0"
+      "sourceHash": "488459c0",
+      "targetHash": "d1c8d02c"
     }
   ]
 }