@williamthorsen/nmr 0.1.1 → 0.3.0

package/README.md

@@ -70,6 +70,39 @@ Script values can be `string` or `string[]`. Arrays expand to chained `nmr` invo
 // expands to: nmr compile && nmr generate-typings
 ```
 
+## Additional subcommands
+
+These commands are available as `nmr` subcommands and as standalone `nmr-`-prefixed binaries (for use in lifecycle hooks).
+
+### `report-overrides`
+
+Report any active `pnpm.overrides` in the root `package.json`. Useful as a `postinstall` hook to remind developers of active overrides that may need cleanup.
+
+```bash
+nmr report-overrides
+```
+
+### `sync-pnpm-version`
+
+Synchronize the pnpm version from the root `package.json` `packageManager` field into the GitHub `code-quality.yaml` workflow file.
+
+```bash
+nmr sync-pnpm-version
+```
+
+## Standalone utilities
+
+### `ensure-prepublish-hooks`
+
+Verify that all publishable workspace packages have a `prepublishOnly` script. Exits non-zero if any are missing.
+
+```bash
+ensure-prepublish-hooks              # Check only
+ensure-prepublish-hooks --fix        # Add missing hooks (default: "npm run build")
+ensure-prepublish-hooks --dry-run    # Preview what --fix would do
+ensure-prepublish-hooks --command "pnpm build"  # Use a custom hook command
+```
+
 ## Consumer migration
 
 After installing, a consuming repo's root `package.json` scripts shrink to lifecycle hooks:

package/bin/ensure-prepublish-hooks.js

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+import('../dist/esm/cli-ensure-prepublish-hooks.js');

package/dist/esm/.cache

@@ -1 +1 @@
-231a8d6ece4406ea0590ca7f31cff212ed0b31b0afa24e5b4cc00f048c5ce2d2
+75a615bf272a9fdadb44845d2a33161432fe36543278a1abdfa819bdeb581654

package/dist/esm/cli-ensure-prepublish-hooks.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/esm/cli-ensure-prepublish-hooks.js

@@ -0,0 +1,62 @@
+import { DEFAULT_HOOK, ensurePrepublishHooks } from "./commands/ensure-prepublish-hooks.js";
+import { findMonorepoRoot } from "./context.js";
+let fix = false;
+let dryRun = false;
+let command;
+const args = process.argv.slice(2);
+for (let i = 0; i < args.length; i++) {
+  const arg = args[i];
+  switch (arg) {
+    case "--fix":
+      fix = true;
+      break;
+    case "--dry-run":
+      dryRun = true;
+      break;
+    case "--command":
+      i++;
+      command = args[i];
+      if (!command) {
+        console.error("--command requires a value");
+        process.exit(1);
+      }
+      break;
+    default:
+      console.error(`Unknown argument: ${arg}`);
+      process.exit(1);
+  }
+}
+try {
+  const monorepoRoot = findMonorepoRoot();
+  const hookCommand = command ?? DEFAULT_HOOK;
+  const options = command ? { fix, dryRun, command } : { fix, dryRun };
+  const result = ensurePrepublishHooks(monorepoRoot, options);
+  for (const pkg of result.packages) {
+    if (pkg.isPrivate) {
+      continue;
+    }
+    switch (pkg.action) {
+      case "ok":
+        console.info(`\u2713 ${pkg.packageName}: prepublishOnly = "${pkg.prepublishOnly}"`);
+        break;
+      case "missing":
+        console.warn(`\u2717 ${pkg.packageName}: missing prepublishOnly`);
+        break;
+      case "fixed":
+        console.info(`\u2713 ${pkg.packageName}: added prepublishOnly = "${hookCommand}"`);
+        break;
+      case "would-fix":
+        console.info(`~ ${pkg.packageName}: would add prepublishOnly = "${hookCommand}"`);
+        break;
+    }
+  }
+  if (result.hasFailures) {
+    const missing = result.packages.filter((p) => p.action === "missing").length;
+    console.error(`
+${missing} package(s) missing prepublishOnly. Use --fix to add it.`);
+    process.exit(1);
+  }
+} catch (error) {
+  console.error(error instanceof Error ? error.message : String(error));
+  process.exit(1);
+}

package/dist/esm/cli.js

@@ -78,14 +78,19 @@ async function main() {
     process.exit(code2);
   }
   if (parsed.recursive) {
+    process.env.NMR_RUN_IF_PRESENT = "1";
     const delegateCmd = `pnpm --recursive exec nmr ${command}${passthrough}`;
     const code2 = runCommand(delegateCmd, context.monorepoRoot, runOptions);
     process.exit(code2);
   }
   const useRoot = parsed.workspaceRoot || context.isRoot;
   const registry = useRoot ? buildRootRegistry(context.config) : buildWorkspaceRegistry(context.config, parsed.intTest);
-  const resolved = resolveScript(command, registry, context.packageDir);
+  const packageDir = context.packageDir ?? context.monorepoRoot;
+  const resolved = resolveScript(command, registry, packageDir);
   if (!resolved) {
+    if (process.env.NMR_RUN_IF_PRESENT === "1") {
+      process.exit(0);
+    }
     console.error(`Unknown command: ${command}`);
     process.exit(1);
   }
@@ -95,7 +100,7 @@ async function main() {
     }
     process.exit(0);
   }
-  if (resolved.source === "package" && !parsed.quiet) {
+  if (resolved.source === "package" && !parsed.quiet && registry[command] !== void 0) {
     console.info(`Using override script: ${resolved.command}`);
   }
   const fullCommand = resolved.command + passthrough;

package/dist/esm/commands/ensure-prepublish-hooks.d.ts

@@ -0,0 +1,17 @@
+export interface PackageHookStatus {
+    packageName: string;
+    packageDir: string;
+    isPrivate: boolean;
+    prepublishOnly: string | undefined;
+    action: 'ok' | 'missing' | 'fixed' | 'would-fix';
+}
+export interface EnsurePrepublishHooksResult {
+    packages: PackageHookStatus[];
+    hasFailures: boolean;
+}
+export declare const DEFAULT_HOOK = "npm run build";
+export declare function ensurePrepublishHooks(monorepoRoot: string, options: {
+    fix: boolean;
+    dryRun: boolean;
+    command?: string;
+}): EnsurePrepublishHooksResult;

package/dist/esm/commands/ensure-prepublish-hooks.js

@@ -0,0 +1,76 @@
+import { readFileSync, writeFileSync } from "node:fs";
+import path from "node:path";
+import { getWorkspacePackageDirs } from "../context.js";
+import { readPackageJson } from "../helpers/package-json.js";
+import { isObject } from "../helpers/type-guards.js";
+const DEFAULT_HOOK = "npm run build";
+function ensurePrepublishHooks(monorepoRoot, options) {
+  const hookCommand = options.command ?? DEFAULT_HOOK;
+  const packageDirs = getWorkspacePackageDirs(monorepoRoot);
+  const packages = [];
+  for (const packageDir of packageDirs) {
+    const pkg = readPackageJson(packageDir);
+    const packageName = pkg.name ?? path.basename(packageDir);
+    const isPrivate = pkg.private === true;
+    if (isPrivate) {
+      packages.push({
+        packageName,
+        packageDir,
+        isPrivate: true,
+        prepublishOnly: pkg.scripts?.prepublishOnly,
+        action: "ok"
+      });
+      continue;
+    }
+    const existing = pkg.scripts?.prepublishOnly;
+    if (existing) {
+      packages.push({
+        packageName,
+        packageDir,
+        isPrivate: false,
+        prepublishOnly: existing,
+        action: "ok"
+      });
+      continue;
+    }
+    if (options.fix) {
+      const action = options.dryRun ? "would-fix" : "fixed";
+      if (!options.dryRun) {
+        addPrepublishOnly(packageDir, hookCommand);
+      }
+      packages.push({
+        packageName,
+        packageDir,
+        isPrivate: false,
+        prepublishOnly: void 0,
+        action
+      });
+    } else {
+      packages.push({
+        packageName,
+        packageDir,
+        isPrivate: false,
+        prepublishOnly: void 0,
+        action: "missing"
+      });
+    }
+  }
+  const hasFailures = packages.some((p) => p.action === "missing");
+  return { packages, hasFailures };
+}
+function addPrepublishOnly(packageDir, command) {
+  const filePath = path.join(packageDir, "package.json");
+  const raw = readFileSync(filePath, "utf8");
+  const parsed = JSON.parse(raw);
+  if (!isObject(parsed)) {
+    throw new TypeError(`Invalid package.json in ${packageDir}: expected an object`);
+  }
+  const scripts = isObject(parsed.scripts) ? parsed.scripts : {};
+  scripts.prepublishOnly = command;
+  parsed.scripts = scripts;
+  writeFileSync(filePath, JSON.stringify(parsed, null, 2) + "\n", "utf8");
+}
+export {
+  DEFAULT_HOOK,
+  ensurePrepublishHooks
+};

package/dist/esm/helpers/package-json.d.ts

@@ -1,5 +1,6 @@
 export interface PackageJson {
     name?: string;
+    private?: boolean;
     version?: string;
     packageManager?: string;
     scripts?: Record<string, string>;

package/dist/esm/helpers/package-json.js

@@ -9,6 +9,7 @@ function readPackageJson(dir) {
   }
   const pkg = {};
   if (typeof parsed.name === "string") pkg.name = parsed.name;
+  if (parsed.private === true) pkg.private = true;
   if (typeof parsed.version === "string") pkg.version = parsed.version;
   if (typeof parsed.packageManager === "string") pkg.packageManager = parsed.packageManager;
   if (isObject(parsed.scripts)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@williamthorsen/nmr",
-  "version": "0.1.1",
+  "version": "0.3.0",
   "private": false,
   "description": "Context-aware script runner for PNPM monorepos",
   "keywords": [
@@ -17,6 +17,7 @@
     "./tests": "./dist/esm/tests/consistency.js"
   },
   "bin": {
+    "ensure-prepublish-hooks": "bin/ensure-prepublish-hooks.js",
     "nmr": "bin/nmr.js",
     "nmr-report-overrides": "bin/nmr-report-overrides.js",
     "nmr-sync-pnpm-version": "bin/nmr-sync-pnpm-version.js"