@williamthorsen/nmr 0.33.0 → 0.35.0

package/README.md

@@ -3,15 +3,33 @@
 Context-aware script runner for pnpm monorepos. Ships an `nmr` (node-monorepo run) binary that provides centralized, consistent script execution across workspace packages and the monorepo root.
 
 <!-- section:release-notes -->
-## Release notes — v0.33.0 (2026-08-20)
+## Release notes — v0.35.0 (2026-09-01)
 
 ### 🎉 Features
 
-- Drop the coverage step from the `check:strict` gate (#727)
+- Expose tsconfigPaths as a first-class Vitest config flag (#751)
 
-  Drops the coverage step from `check:strict` in both the workspace and root registries: The gate now runs `test` rather than `test:coverage`.
+  Adds a `tsconfigPaths` option to `defineVitestConfig` and `defineRootVitestConfig` in `@williamthorsen/nmr/vitest`. It emits Vite's `resolve.tsconfigPaths`, so a test resolves an aliased specifier through the `paths` its own `tsconfig.json` declares, the way `tsc` does.
 
-  Coverage is still available as `nmr test:coverage`, run as a separate step.
+  The option defaults to `false` and requires Vite 8, which `@williamthorsen/nmr` now declares as an optional peer dependency at `>=8.0.0 <9`.
+
+- Publish a test-file conventions check consuming repos can gate in CI (#753)
+
+  Adds `checkTestFileConventions` at `@williamthorsen/nmr/tests`, which a consuming repo calls from a test of its own. It fails the run on any test file that names no isolation tier or sits outside `__tests__`. Both passed silently before.
+
+  Adds `testCollectionExclude` to `defineVitestConfig` and `defineRootVitestConfig`. The same array of directory names goes to the check's `exclude`, so one declaration scopes both the sweep and what Vitest collects.
+
+- Keep doc comments in published declaration files (#762)
+
+  Changes the behavior of `nmr-compile` so that it preserves doc comments in `.d.ts` files.
+
+  TypeScript's `removeComments` governs a whole emit, so a TS configuration that kept comments out of JavaScript also kept them out of declaration files. `nmr-compile` now emits from two programs: The first produces the `.js` under the package's own `removeComments`, and the second produces the declarations with comments.
+
+- Report workspaces whose Vitest config bypasses the projects model (#763)
+
+  Adds a check to nmr's ReadyUp kit to report every workspace that holds a Vite config without a Vitest config beside it, and widens the existing content check from the repo root to every workspace, so a Vitest config that does not build on `defineVitestConfig` is reported. The purpose of these checks is to ensure that tier-selecting test commands are supported.
+
+  Also fixes an issue where the `no package re-exports the ancestor Vitest config` check incorrectly advised a consumer to delete a config.
 <!-- /section:release-notes -->
 
 ## Installation
@@ -39,7 +57,7 @@ From a package directory:
 
 ```bash
 nmr test  # Run tests for the current package
-nmr build # Compile to .js and .d.ts in one pass
+nmr build # Compile to .js and .d.ts
 nmr check # Typecheck, format check, lint check, and tests
 ```
 
@@ -556,7 +574,7 @@ export default defineConfig({
 
 `defineConfig` supplies nmr's shared upgrade policy — a seven-day quarantine on brand-new releases, and the pair of settings that report a dependency pinned to an exact version: locked dependencies are included, and the range searched is `minor` — so your config carries only what is specific to your repo. Any setting you declare wins over nmr's default. Passing `undefined` clears a default rather than falling back to it, which is how you hand the quarantine policy back to `pnpm-workspace.yaml`'s `minimumReleaseAge`. `mode` is the exception: the upgrade tool carries a default of its own for it, and clearing nmr's leaves no valid range to search, so name a mode instead.
 
-Everything the [taze configuration](https://github.com/antfu-collective/taze#config-file) accepts is accepted here.
+Everything the [taze configuration](https://github.com/antfu-collective/taze#config-file) accepts is accepted here, with five exceptions that reach the upgrade tool from no config file at all: `concurrency`, `githubActions`, `ignoreOtherWorkspaces`, `nodeVersion`, and `requestTimeout`. The tool's CLI writes a default for each of them over whatever the config declares ([taze#317](https://github.com/antfu-collective/taze/issues/317)), so the command line is the only place they can be set. nmr's ReadyUp kit warns when your config declares one, and [request timeout](#request-timeout) below shows how to set it instead.
 
 > **Note:** This file is what activates nmr's upgrade policy at all. A repo without one gets neither the release quarantine nor the settings that report a dependency pinned to an exact version, and `nmr upgrade` reports nothing in a repo using pnpm's `savePrefix: ''`. nmr's ReadyUp kit warns when the file is missing.
 
@@ -565,6 +583,32 @@ Two consequences of the `minor` range mode the policy declares:
 - A `packageMode` entry is honored only by the pass whose mode matches it, or by a `default` pass; every other pass drops that dependency rather than narrowing it. Under the policy's `minor` mode, a `patch` ceiling hides its dependency until you run `nmr upgrade patch`, and a `minor` ceiling hides it from `nmr upgrade major`.
 - A `~` range is searched as `^`, so minor upgrades are proposed for it and `--write` applies them under the original `~`. To hold one dependency to patches, give it a `packageMode` entry of `patch` and read it from `nmr upgrade patch`; to hold the whole repo there, declare `mode: 'patch'`.
 
+### Request timeout
+
+Every `upgrade` script reaches the upgrade tool with a 30-second request timeout, in place of the tool's own 5 seconds.
+
+Five seconds is too tight for a registry that proxies npm. The tool fetches a full packument whenever the resolved registry is not `registry.npmjs.org`, and a large one runs to tens of megabytes; the budget covers the whole retry chain rather than a single attempt, so one slow response ends the run with `Timeout requesting "<package>"`. The symptom is an upgrade pass that succeeds or fails according to how warm the tool's cache happens to be.
+
+Pass a different value for one run:
+
+```bash
+nmr upgrade --request-timeout 90000
+```
+
+To change it for every run, override the `upgrade` script in `.config/nmr.config.ts`, keeping the rest of the default. This is nmr's own config, not the `taze.config.ts` above; taze ignores a `rootScripts` key, and nothing reports it:
+
+```ts
+import { defineConfig } from '@williamthorsen/nmr/config';
+
+export default defineConfig({
+  rootScripts: {
+    upgrade: 'nmr-report-overrides && nmr-taze --recursive --request-timeout 90000',
+  },
+});
+```
+
+The override is one command string rather than a list of steps, because a composite element names an nmr command and both halves here are binaries.
+
 ## Default script registries
 
 These scripts are available out of the box. Repo-wide config (tier 2) and per-package overrides (tier 3) can add to or replace any of them.
@@ -765,7 +809,7 @@ Position determines ownership: flags before the command name are nmr's own, and
 ```bash
 # From a package directory
 nmr test  # Run workspace test script
-nmr build # Compile to .js and .d.ts in one pass
+nmr build # Compile to .js and .d.ts
 
 # From the monorepo root
 nmr test    # Root tests + recursive workspace tests
@@ -842,7 +886,7 @@ nmr-clean
 
 ### `nmr-compile`
 
-Compile a single package's `src` tree to `dist/esm` with the TypeScript compiler API, emitting `.js` and `.d.ts` in one pass. Because the compiler parses each source file, every relative import form — static, re-export, dynamic `import()`, and bare side-effect — is rewritten from `.ts` to `.js` in both outputs, and `.ts` occurrences inside strings and comments are left intact. tsconfig `paths` aliases are resolved to runnable relative `.js` specifiers in both outputs, sourced from the package's tsconfig. An aliased import whose target resolves outside the package's `src/` and is not resolvable without the alias mapping fails the build with a diagnostic, rather than being emitted verbatim to produce output that fails at runtime. The build is skipped when no input has changed and the previous output is still on disk (the key is cached under `node_modules/.cache/nmr-compile/`, outside the published output). Deleting the output by any means — `nmr clean`, `rm -rf dist`, `git clean` — therefore forces a rebuild rather than a skip. This is the default `compile` script — run it from a package directory.
+Compile a single package's `src` tree to `dist/esm` with the TypeScript compiler API, emitting `.js` from one program and `.d.ts` from a second that reuses it. The package's own `removeComments` governs the `.js` emit; the declarations emit forces it off, so `.d.ts` files carry their doc comments either way. Because the compiler parses each source file, every relative import form — static, re-export, dynamic `import()`, and bare side-effect — is rewritten from `.ts` to `.js` in both outputs, and `.ts` occurrences inside strings and comments are left intact. tsconfig `paths` aliases are resolved to runnable relative `.js` specifiers in both outputs, sourced from the package's tsconfig. An aliased import whose target resolves outside the package's `src/` and is not resolvable without the alias mapping fails the build with a diagnostic, rather than being emitted verbatim to produce output that fails at runtime. The build is skipped when no input has changed and the previous output is still on disk (the key is cached under `node_modules/.cache/nmr-compile/`, outside the published output). Deleting the output by any means — `nmr clean`, `rm -rf dist`, `git clean` — therefore forces a rebuild rather than a skip. This is the default `compile` script — run it from a package directory.
 
 **What it compiles.** Entry points are `src/**/*.ts` less the directories that hold test scaffolding rather than shipped code: `__fixtures__/`, `__mocks__/`, `__tests__/`, and `test-utils/`. Add to that list per package with [`build.extraIgnorePatterns`](#package-level-configuration). Ignoring a directory drops it as an _entry point_, not from the emit: the compiler still emits whatever the surviving entry points import, so a helper that production code uses is still compiled and its importer never emits a dangling specifier. This list is deliberately not the Vitest [coverage exclusions](#what-the-config-excludes) — helpers live in `test-utils/` precisely so they stay covered.
 
@@ -877,7 +921,7 @@ nmr-fmt --write packages/nmr
 
 ### `nmr-taze`
 
-Run the [taze](https://github.com/antfu-collective/taze) dependency-upgrade tool, forwarding every argument to it untouched. This is what every `upgrade` chain ends with, `root:upgrade` included — see [dependency upgrades](#dependency-upgrades) for the workflow.
+Run the [taze](https://github.com/antfu-collective/taze) dependency-upgrade tool, forwarding every argument to it untouched and adding one of its own: a 30-second request timeout, unless the invocation already carries one. This is what every `upgrade` chain ends with, `root:upgrade` included — see [dependency upgrades](#dependency-upgrades) for the workflow, and [request timeout](#request-timeout) for why the timeout is set here.
 
 Under pnpm's isolated `node_modules`, a transitive package's binary is absent from the consuming repo's `node_modules/.bin`, so a repo that depends on nmr cannot run `taze` directly. `nmr-taze` can, because nmr is a direct dependency, and it resolves the tool from the tree nmr controls.
 
@@ -901,7 +945,7 @@ ensure-prepublish-hooks
 
 ## Conformance checks
 
-nmr publishes a `readyup` kit that checks a consuming repo against the current release: the shared Vitest and Prettier configs, the workspace layout, the root script registry, the [test-tier convention](#test-tiers), and that no `package.json` in the tree declares a `pnpm` field, which pnpm 11 reads no key from. Those settings belong in `pnpm-workspace.yaml`, and `pnpx codemod run pnpm-v10-to-v11` moves them. The kit ships inside the package, so it checks against the nmr version installed rather than whatever a repository ref happens to point at, and a tier added or renamed in nmr reaches the repo on upgrade.
+nmr publishes a `readyup` kit that checks a consuming repo against the current release: the shared Vitest and Prettier configs, the workspace layout, the root script registry, the [test-tier convention](#test-tiers), and that no `package.json` in the tree declares a `pnpm` field, which pnpm 11 reads no key from. Those settings belong in `pnpm-workspace.yaml`, and `pnpx codemod run pnpm-v10-to-v11` moves them. The kit ships inside the package, so it checks against the nmr version installed rather than whatever a repository ref happens to point at, and a tier added or renamed in nmr reaches the repo on upgrade. A repo that wants the tier convention in its own gate rather than in a command run by hand declares the [conventions check](#gating-the-test-file-conventions) instead, which also covers the half the kit does not.
 
 Add `readyup` as a devDependency, then name nmr in its config:
 
@@ -1023,7 +1067,7 @@ import { defineVitestConfig } from '@williamthorsen/nmr/vitest';
 export default defineVitestConfig();
 ```
 
-`vitest` is a peer dependency (`>=4.0.0 <5`), declared optional — the consuming repo provides it, and repos that never import this subpath are unaffected.
+`vitest` is a peer dependency (`>=4.0.0 <5`), declared optional — the consuming repo provides it, and repos that never import this subpath are unaffected. `vite` is an optional peer as well (`>=8.0.0 <9`), required only by the [`tsconfigPaths` setting](#resolving-through-tsconfig-paths); a repo that declares a `vite` of its own below that range sees an unmet-peer warning whether or not it sets the flag.
 
 ### Test tiers
 
@@ -1050,7 +1094,7 @@ vitest                               # every project
 
 **Every test file names its tier**, in the form `<subject>[.<aspect>].<tier>.test.ts`. Only the segment immediately before `.test.` selects a project, so an earlier one is free for documentation: `resolveConfig.packaged.unit.test.ts` reads as a companion to `resolveConfig.unit.test.ts` and still names `unit`.
 
-`unit` is defined by subtracting the tiers rather than by an allow-list of infixes, so a file such as `parser.smoke.test.ts` runs under `unit` instead of being silently dropped. That is a safety net, not a licence to omit the tier: a file whose tier segment is missing or misspelt runs under `unit` and reports success, so no test run distinguishes it from a conformant one. [nmr's readyup kit](#conformance-checks) reports those files, which is the only thing that does.
+`unit` is defined by subtracting the tiers rather than by an allow-list of infixes, so a file such as `parser.smoke.test.ts` runs under `unit` instead of being silently dropped. That is a safety net, not a licence to omit the tier: a file whose tier segment is missing or misspelt runs under `unit` and reports success, so no test run distinguishes it from a conformant one until the repo declares the [conventions check](#gating-the-test-file-conventions). In a repo that has not, [nmr's readyup kit](#conformance-checks) is what reports those files.
 
 `localhost` and `remote` have no test script of their own. They are declared anyway, so that a `*.remote.test.ts` file cannot fall into `unit` and run in the default gate unnoticed.
 
@@ -1058,6 +1102,73 @@ Every tier above `unit` carries a 30-second `testTimeout` and `hookTimeout`, whe
 
 To raise a budget for one tier and no other, use the `tiers` seam below. The `project` seam merges over both budgets as well, but like every option passed through it the value reaches all four projects at once -- raising a tier's budget raises `unit`'s with it. To lift the ceiling for a single file rather than a whole tier, pass a timeout to the individual test or hook, which stays the narrower tool.
 
+### Gating the test-file conventions
+
+Both halves of the convention are silent on their own: an untiered file runs under the residual `unit` and passes, and a file outside `__tests__` is collected by nothing at all. `@williamthorsen/nmr/tests` exports a check that reports both, which a repo declares from a one-line test of its own:
+
+```ts
+// __tests__/test-file-conventions.unit.test.ts
+import { checkTestFileConventions } from '@williamthorsen/nmr/tests';
+
+checkTestFileConventions();
+```
+
+It declares one suite with an assertion per half, each carrying the remedy that fixes it: the four tier names and the rename form, or the `__tests__` directory the file belongs in. The guard names its own tier like any other test file, so a misnamed guard reports itself.
+
+A repo linting with `vitest/require-hook` needs a disable directive on that call, which the rule reads as setup work where it declares the suite:
+
+```ts
+// eslint-disable-next-line vitest/require-hook -- the call declares the suite, where the rule reads it as setup work.
+checkTestFileConventions();
+```
+
+The sweep starts at the monorepo root rather than at the directory Vitest supplies, so one call covers the whole repo from whichever package the run began in. `rootDir` overrides that, for a check pointed at a tree other than the repo's own.
+
+An exported check rather than a step nmr runs for you, because nothing nmr runs reaches the whole tree: `nmr test` fans out per package, and a direct `vitest` invocation runs no nmr script at all. A test the repo owns also lets the repo scope what the sweep covers.
+
+`exclude` names directory basenames the sweep prunes at any depth, additive to the ones nmr always prunes:
+
+```ts
+checkTestFileConventions({ exclude: ['cypress', 'generated'] });
+```
+
+**Pass the same array to [`testCollectionExclude`](#what-the-config-excludes).** The two describe one scope, and naming a directory in only one is a defect in either direction. Pruned from the sweep alone, the directory's test files still run and still report nothing, which is the silence this check exists to end. Excluded from collection alone, the sweep reports files a consumer has no reason to act on.
+
+Expect the first run to fail in a repo that has never gated this. Vitest 4 excludes only `node_modules` and `.git` by default, so a `__tests__` tree under a generated or vendored directory is collected and runs today; naming that directory in both lists is the fix, rather than widening what nmr prunes for everyone.
+
+### What the config supplies
+
+Two settings a workspace test runner needs almost universally are part of what the factory produces, so a config file declares neither:
+
+- **Workspace packages resolve from source.** `source` leads the emitted `resolve.conditions` and `ssr.resolve.conditions`, so a cross-package import reaches the dependency's `.ts` rather than its `dist/` and a suite runs without a prior build. A package declaring no such condition is unaffected.
+- **Git subprocesses are isolated.** Every project loads a setup file that points `GIT_CONFIG_GLOBAL` and `GIT_CONFIG_SYSTEM` at the null device and sets `GIT_CONFIG_NOSYSTEM`, so a test that spawns `git` reads neither the developer's identity nor a signing config that can block on a passphrase. It leads each project's `setupFiles`, ahead of every entry the layers add, because a shared setup establishes the environment the rest run in.
+
+Both defaults exist because omitting either is silent rather than loud: the tiers still exist and the suite still runs green, testing `dist/` and the developer's git identity instead. Turn either off through its own option, which folds across layers like any other, the last layer to declare it winning:
+
+```ts
+export default defineVitestConfig({ isolateGit: false, resolveFromSource: false });
+```
+
+`resolveFromSource: false` is for a repo that resolves a `source` condition it does not want in tests; `isolateGit: false` is for a suite meant to read the developer's own git configuration.
+
+**Vite replaces its condition defaults rather than extending them.** A config writing `conditions: ['source']` by hand therefore drops `module`, so a dependency exposing a `module` entry falls through to whatever its `exports` lists next. A replaced list still resolves `node` and `development` under Vitest, which is why nothing in a test run reports the loss. The factory emits `source` alongside Vite's defaults for each environment, so a config declaring no conditions of its own starts from a complete list.
+
+**A package declaring a `source` condition must ship its sources.** Every nmr consumer now resolves that condition, so a published package whose `files` carries `dist` alone resolves to a path that is not in the tarball. A package that publishes only its build output takes a bespoke condition name instead, the way `@williamthorsen/nmr-core` uses `nmr-source` for the build's own bootstrap.
+
+### Resolving through tsconfig paths
+
+A third resolution setting sits alongside those two, and this one is off. `tsconfigPaths: true` emits Vite's `resolve.tsconfigPaths`, so a test reaches an aliased specifier through the `paths` its `tsconfig.json` declares, the way `tsc` does:
+
+```ts
+export default defineVitestConfig({ tsconfigPaths: true });
+```
+
+It folds across layers like the other two, the last layer to declare it winning. It needs no `ssr` counterpart the way a condition does: Vite holds this setting outside its per-environment resolve options, so the single key reaches the environment a test's own imports resolve through.
+
+**It is an opt-in because its silent direction is the reverse of the two defaults'.** Leaving it off fails loudly, with an unresolved import naming the specifier. Turning it on is the silent direction, for a repo that declares `paths` for `tsc` alone: a specifier that resolved through a package's `exports` starts resolving through the alias instead, and nothing in the run reports the switch. A repo declaring no `paths` is unaffected either way.
+
+**It requires Vite 8**, where `resolve.tsconfigPaths` arrived. nmr declares `vite` as an optional peer at `>=8.0.0 <9`, so a repo holding a stale `vite` of its own hears about it at install time. That check does not reach a repo whose only Vite comes in through Vitest's own dependency, and Vitest 4 accepts Vite 6 and 7: on those, the emitted key does nothing and the aliased import fails exactly as it would with the flag off.
+
 ### Customizing by scope
 
 Vitest applies some options at the root of a `projects` config and others per project, and placing one at the wrong level is silent rather than loud. The factory therefore takes separate override surfaces instead of one merged config:
@@ -1065,7 +1176,7 @@ Vitest applies some options at the root of a `projects` config and others per pr
 ```ts
 export default defineVitestConfig({
   // Vite-level options, plus the test options Vitest honours only at the root.
-  root: { resolve: { conditions: ['development'] } },
+  root: { ssr: { resolve: { conditions: ['my-condition'] } } },
   // Applied to every project.
   project: { setupFiles: ['./vitest.setup.ts'] },
   // Applied to one tier, after the `project` block above.
@@ -1079,7 +1190,9 @@ export default defineVitestConfig({
 
 Arrays concatenate rather than replace. `exclude` and `setupFiles` therefore add to what the config already declares, and no surface can narrow `include` or drop a default exclusion. Adding an `include` pattern through `project` widens all four projects at once, so a file matching it is collected by each and runs four times.
 
-`resolve.conditions` concatenates too, but layer order carries no meaning there: Vite consumes conditions as a set, and which one wins is decided by the key order of the consumed package's own `exports`. A later layer can add a condition and can never remove or outrank one an earlier layer contributed. `resolve.alias` is the one key that merges override-first, so a later alias takes precedence over an earlier one.
+`resolve.conditions` concatenates too, onto the `source` condition and the Vite defaults the factory already emits, but layer order carries no meaning there: Vite consumes conditions as a set, and which one wins is decided by the key order of the consumed package's own `exports`. A later layer can add a condition and can never remove or outrank one an earlier layer contributed; removing `source` is what `resolveFromSource: false` is for. `resolve.alias` is the one key that merges override-first, so a later alias takes precedence over an earlier one.
+
+**A condition for the tests' own resolution goes under `ssr`.** `resolve` is per-environment, and Vitest resolves a test's imports through the server environment, so `root: { ssr: { resolve: { conditions: ['my-condition'] } } }` is the seam that reaches them. A top-level `root: { resolve: { conditions: [...] } }` entry reaches the client environment, which only browser-mode tests resolve through; it composes into that array and never reports that a node test did not see it. `resolve.alias` is not per-environment, so a top-level alias reaches both.
 
 ### Sharing options across config files
 
@@ -1092,7 +1205,7 @@ import { fileURLToPath } from 'node:url';
 import type { VitestConfigOptions } from '@williamthorsen/nmr/vitest';
 
 export const shared: VitestConfigOptions = {
-  root: { resolve: { conditions: ['source'] } },
+  root: { resolve: { alias: { '~': fileURLToPath(new URL('.', import.meta.url)) } } },
   project: { setupFiles: [fileURLToPath(new URL('./vitest.setup.ts', import.meta.url))] },
 };
 ```
@@ -1110,15 +1223,25 @@ Both factories fold any number of layers left to right: a later layer wins on a
 
 Order is the point where `setupFiles` is concerned, since a shared setup file establishes the environment the package's own then runs in. A later layer's `project` block likewise wins over an earlier layer's `tiers` target: the nearer config is the more deliberate.
 
+**A package's own `vite.config.ts` fills that one slot too.** Vitest searches for a config by ascending from the run root and stopping at the first directory holding any of `vitest.config.*` or `vite.config.*`, so a package carrying only a Vite config ends the search there and never reaches the root config. Within a directory `vitest.config.*` is tried first, which makes the fix a Vitest config beside the Vite one, calling `defineVitestConfig()` as any other package config does. Without it the package declares no projects and every tier-selecting command fails with `No projects matched the filter`, `nmr ci` among them. [nmr's readyup kit](#conformance-checks) reports a package in that state.
+
 **A path in a shared layer must be absolute.** Vitest resolves `setupFiles` against each project's own root, not against the module that declared the path, so a bare `'./vitest.setup.ts'` in a shared module names a different file in every package that consumes it -- and a package that happens to own a file by that name loads the wrong one instead of failing. The co-located form stays correct in a config file that declares the path directly.
 
 **Do not merge two returned configs.** `mergeConfig(defineVitestConfig(), defineVitestConfig(mine))` looks like the idiomatic recovery and fails at startup: both sides declare the same four project names, which Vitest rejects with `Project name "unit" ... is not unique`. Layers merge the factory's inputs instead, which is why they yield four projects however many fold.
 
-A config file that omits the shared layer still loses those settings, silently -- Vitest's own resolution contract, not something the factory can intercept. Guard it with a test that fails when a package's suite goes missing, which also catches a shared `exclude` pattern swallowing one package's tests.
+A config file that omits the shared layer still loses those settings, silently -- Vitest's own resolution contract, not something the factory can intercept. Guard it with a test that fails when a package's suite goes missing, which also catches a shared `exclude` pattern swallowing one package's tests. Source resolution and git isolation need no such guard: the factory supplies both, so a config file cannot omit them by forgetting a layer.
 
 ### What the config excludes
 
-Collection skips `**/node_modules/**`, `**/.git/**`, and `**/dist/**`. Coverage skips `**/__{fixtures,mocks,tests}__/**`, `**/index.ts`, and `**/*.d.ts`.
+Collection skips `**/node_modules/**`, `**/.git/**`, `**/coverage/**`, and `**/dist/**`. Coverage skips `**/__{fixtures,mocks,tests}__/**`, `**/index.ts`, and `**/*.d.ts`.
+
+`testCollectionExclude` adds to the collection list. It takes directory basenames rather than globs, matched at any depth, so the same array serves the [conventions check](#gating-the-test-file-conventions):
+
+```ts
+export default defineVitestConfig({ testCollectionExclude: ['cypress', 'generated'] });
+```
+
+Every layer's entries are concatenated, and a name the shared config already prunes is emitted once. A repo needing a glob rather than a directory name has the `project` seam's own `exclude`.
 
 Because both seams concatenate, a consumer can add an exclusion but never remove one. A pattern therefore earns its place in these lists only by preventing a _silent_ failure, one a consumer cannot self-diagnose. A visible failure, such as a stray file sitting at 0% in the coverage report, is left to the consumer's own `project` seam.
 
@@ -1155,7 +1278,7 @@ The projects were once named `unit`, `integration`, and `app`, for what a test _
 2. Rename every `*.app.test.ts` onto the convention. `app` was never a tier, so keep it as the aspect segment and add the tier after it: `scaffold.app.test.ts` becomes `scaffold.app.unit.test.ts`.
 3. Replace `nmr test:integration` with `nmr test:tool`, and `nmr root:test:integration` with `nmr root:test:tool`, wherever a script or workflow names them.
 
-**A file left without a tier is a silent failure.** The residual `unit` claims it and it runs in the default gate -- green, with nothing reporting that the separation was lost. [nmr's readyup kit](#conformance-checks) reports every such file; a passing test run does not. Run it before treating the migration as done.
+**A file left without a tier is a silent failure.** The residual `unit` claims it and it runs in the default gate -- green, with nothing reporting that the separation was lost. Declare the [conventions check](#gating-the-test-file-conventions), which turns that state into a failing test run, or run [nmr's readyup kit](#conformance-checks), which reports every such file. Do one of the two before treating the migration as done.
 
 `nmr test` also runs the `tool` tier, which the old `test` excluded. Those tests previously ran in no default selection at all: `check`, `check:strict`, and `ci` all inherited the exclusion, so a green pipeline said nothing about them. Expect `nmr test` to take longer and to surface failures that were never gated.
 
@@ -1171,3 +1294,17 @@ nmr once selected a package's test scripts by looking for a `vitest.integration.
 Until step 1 is done, every test command that names a tier fails against a config declaring no projects, with `Error: No projects matched the filter "unit", "tool".` at startup. `test:all` is the exception: it names no project, so it runs everything the config collects.
 
 That is a change for the better. While `test` selected by negation, an unmigrated config produced a _green_ run, because `--project '!integration'` had nothing to exclude, so the separation was lost with no error anywhere. Positive selection turns the same state into a startup failure that names the missing projects.
+
+### Migrating a repo that layered source resolution or git isolation by hand
+
+The factory supplies both, so the layer a repo wrote for them, and any guard test that checked every config file imported it, can go.
+
+1. Delete the shared module's `resolve.conditions` entry for `source` and its `ssr.resolve` twin. Keep the module for whatever else it carries; delete it outright once it carries nothing.
+2. Delete the git-isolation setup file and its `setupFiles` entry. nmr's runs in its place, ahead of every entry a layer adds.
+3. Delete the test that asserted each config file imports the shared module, where the module is gone.
+
+Two behaviors change on upgrade even in a repo that layered neither.
+
+A suite whose tests run `git commit` while relying on the developer's global identity now fails with git's own `Please tell me who you are`. Set the identity locally in the fixture repo the test builds -- `git -C <repo> config user.email`, `user.name`, and `commit.gpgsign false` -- which is what makes the test report the same result on every machine.
+
+A workspace package declaring a `source` condition is now resolved from source in tests that previously read its `dist`. That is the point of the default, and it means a suite stops exercising build output it may have been exercising by accident.

package/agents/guidance/rulebooks/nmr.md

@@ -13,5 +13,5 @@ delivery: ambient
 - A check that already passed on the current working tree skips, printing `⏭️ <scope>: <command>: passed …` and, where the recalled run left one, `— replayed: <excerpt>` of what that run concluded. Any edit, addition, or deletion re-runs it, so read the replayed excerpt rather than paying for the answer again: never pass `--no-cache` to get a "real" run, which costs the command's full runtime to reach the same answer. Its one use is a file rather than an exit status -- a skipped command writes none, so a fresh `coverage/` needs `nmr --no-cache test:coverage`. A composite replays its constituents' excerpts, each attributed as `<scope>: <command>: <excerpt>` and cut at the line's ceiling where there are too many to fit. A skip carrying no excerpt is one whose run wrote to a terminal, or one whose constituents recorded none.
 - `nmr --log <command>` prints the whole run behind that excerpt -- up to 256 KiB, led by when it was recorded, how long it ran, and the command string that produced it -- so output you need in full is a recording to read rather than a run to pay for again. It runs nothing, and it is held to the tree rather than to the terminal: a recording a piped run made prints for a reader at one. A composite prints its constituents' excerpts, so the transcript of one of them is `nmr -F <pkg> --log <command>` or that constituent's own name. Nothing to show is said on one line and exits non-zero, naming which it is.
 - Every command nmr runs reports one line -- `✅ <scope>: <command>: passed in 12.4s`, `❌ … failed in 1.2s (exit 1)`, `⏭️ … passed 4m ago on this tree`, or `⛔ … skipped, the override is empty` -- and a composite reports alongside every command it expands into. The lines print in every verbosity, so `-q` is the low-noise way to run rather than a silent one: it withholds the output of the commands nmr runs and keeps nmr's own verdicts, which is how a pass, a cached skip, and a `""`/`":"` override stay distinguishable. Expect a run to be quiet already without the flag: nmr recognizes a known agent harness in the environment and takes quiet from that, as it does from `NMR_COMMAND_VERBOSITY` or the repo's `output.commandVerbosity`. A command whose output you need in full is one to run with `NMR_COMMAND_VERBOSITY=full`, which outranks both.
-- Every test file lives under a `__tests__` directory and names its isolation tier last: `<subject>[.<aspect>].<tier>.test.ts`, where any earlier segment is free-form documentation. A tier is the furthest thing the test reaches -- `tool` (a program the environment supplies), `localhost` (a service on this machine), `remote` (a machine that isn't this one), or `unit`, the residual claiming everything else. Neither a file outside `__tests__` nor one whose tier segment is missing or misspelt fails anything: the first is collected by nothing and the second runs under `unit`, and no test run distinguishes either from a conformant file. `rdy run --packages` reports the misspelt tier, and nothing reports the misplaced file.
+- Every test file lives under a `__tests__` directory and names its isolation tier last: `<subject>[.<aspect>].<tier>.test.ts`, where any earlier segment is free-form documentation. A tier is the furthest thing the test reaches -- `tool` (a program the environment supplies), `localhost` (a service on this machine), `remote` (a machine that isn't this one), or `unit`, the residual claiming everything else. A file outside `__tests__`, or one whose tier segment is missing or misspelt, fails the test run in a repo that declares nmr's exported conventions check, which reports both. In a repo that has not, neither fails anything -- the first is collected by nothing and the second runs under `unit` -- and `rdy run --packages` reports the misspelt tier alone.
 - The rest is in `node_modules/@williamthorsen/nmr/README.md`: pre/post hooks (every `nmr X` auto-wraps as `nmr X:pre && nmr X && nmr X:post`), script overrides and their `""`/`":"` skip values, `nmr upgrade` ceilings (report-only until `nmr upgrade --write`), the `nmr-compile` build (there is no repo-local build script), the test tiers' timeout budgets and the `tiers` seam that raises one, which script reaches which tier, and the check-result cache's key, the retention key a replayed excerpt is additionally held to, the retention ceiling `--log` prints within, its `checkCache` config, and every condition that disables it.

package/dist/esm/UserError.d.ts

@@ -1,3 +1,9 @@
+/**
+ * A failure in what the user declared -- a config file, a `package.json` -- rather than a fault in nmr.
+ *
+ * The CLI boundary prints one of these as its message alone. A stack trace records where nmr noticed the
+ * problem, which says nothing about the file the reader has to edit.
+ */
 export declare class UserError extends Error {
     constructor(message: string);
 }

package/dist/esm/check-cache.d.ts

@@ -1,7 +1,9 @@
 import type { Writable } from 'node:stream';
 import type { OutputChannels } from './runner.js';
 import type { CheckCacheConfig, NmrConfig } from './types.js';
+/** A recorded pass: what ran, on which tree, and what it cost. */
 export interface CheckCacheEntry {
+    /** The full cache key the pass was recorded under; a hit is this matching the key computed now. */
     key: string;
     treeHash: string;
     headSha: string;
@@ -9,44 +11,94 @@ export interface CheckCacheEntry {
     nmrVersion: string;
     nodeVersion: string;
     durationMs: number;
+    /** ISO-8601 instant the pass completed. */
     recordedAt: string;
+    /**
+     * The build digest each covered package's output carried when the pass was recorded. Build output is
+     * git-ignored, so the tree hash cannot describe it; comparing these is what separates output built from this
+     * tree from output another tree left behind.
+     */
     buildDigests: Record<string, string>;
+    /** What a skip replays in place of the run it recalls, absent on a pass that retained nothing. */
     retention?: Retention;
 }
+/** What locates one command's recorded pass at one scope, and the transcript beside it. */
 export interface EntryRef {
     anchorDir: string;
     command: string;
     monorepoRoot: string;
 }
+/** One command's excerpt, attributed to the scope and the command that produced it. */
 export interface ReplayLine {
     command: string;
     excerpt: string;
     scope: string;
 }
+/**
+ * What a recalled pass replays, the key certifying the excerpts describe this environment's output, and the
+ * run that last vouched for them.
+ *
+ * A list rather than one excerpt: a composite's entry carries its constituents' lines, and a nested one's are
+ * spliced into its parent's, where the attribution cannot be re-derived from the entry that holds them.
+ *
+ * The witness is what admits a constituent's line into the assembly its parent records: a run writes it when
+ * it records an excerpt, and restamps it when it recalls one and replays it.
+ */
 export interface Retention {
     key: string;
     replay: ReplayLine[];
     runId: string;
 }
+/** What nmr's own build has left on disk across the workspace. */
 export interface BuildOutputState {
+    /** Covered packages whose output is absent. */
     missing: string[];
+    /** The digest of the inputs each covered package's output was built from, keyed by package name. */
     digests: Record<string, string>;
 }
+/** The parts of the running interpreter that can change what a check concludes. */
 export interface RuntimeIdentity {
     arch: string;
     nodeVersion: string;
     platform: string;
 }
+/** One working tree, observed once per top-level invocation and shared with every process below it. */
 export interface TreeSnapshot {
     hash: string;
     headSha: string;
 }
+/** The interpreter this process is running on, folded into every key and recorded alongside every pass. */
 export declare const CURRENT_RUNTIME: RuntimeIdentity;
+/** Set to `1` to hear why the gate did not skip, or why it is disabled. */
 export declare const DEBUG_ENV_VAR = "NMR_DEBUG";
+/**
+ * The commands cacheable without configuration: those whose whole contribution is an exit status, and that
+ * reach nothing beyond a checkout and an install.
+ *
+ * Excluded on purpose. `audit` and `prepush` consult a vulnerability database that changes without the tree
+ * (`prepush`'s `ci` constituent still skips while its `audit` always runs). `build` and `compile` carry a cache
+ * of their own. `fix`, `fmt`, `lint`, and `upgrade` mutate the tree they are asked about. `test:all` reaches
+ * whatever the environment supplies. Anything a repo adds here promises exit-status-only semantics through its
+ * whole chain, hooks included.
+ */
 export declare const DEFAULT_CACHEABLE_COMMANDS: string[];
+/** Set to `1` for the standing equivalent of `--no-cache`: skip the lookup, still record on success. */
 export declare const NO_CACHE_ENV_VAR = "NMR_NO_CACHE";
+/** Carries one run's identity down the spawned chain, so an entry can name the run that vouched for it. */
 export declare const RUN_ID_ENV_VAR = "NMR_RUN_ID";
+/** Carries the top-level tree snapshot down the spawned chain, so one invocation hashes the tree once. */
 export declare const TREE_SNAPSHOT_ENV_VAR = "NMR_TREE_SNAPSHOT";
+/**
+ * Restamps a recalled entry's retention with the run that is replaying it, so an excerpt this run certified
+ * can join the assembly a composite above it records.
+ *
+ * A recall certifies as surely as a recording does: the pass key matched, so the excerpt describes this tree,
+ * and the caller reaches this only where the retention key matched too, so it describes this presentation
+ * environment. Everything else the entry records stands -- the instant and the duration belong to the run that
+ * earned the pass, and a recall must not make it read as later or longer than it was.
+ *
+ * A cache that cannot be written is not worth failing a green run over, so that failure goes to the debug note.
+ */
 export declare function certifyRetention(options: {
     anchorDir: string;
     command: string;
@@ -56,6 +108,14 @@ export declare function certifyRetention(options: {
     runId: string;
     stderr: Writable;
 }): Promise<void>;
+/**
+ * Folds everything that can change what a command concludes into one key: the tree's content, the command
+ * string that would run, the scope it would run in, nmr's own version, the interpreter, what is installed, and
+ * the environment variables a check can read. A hit is this key matching a recorded one, so an ingredient left
+ * out here is an ingredient that could change while the cache still claims a pass.
+ *
+ * Reports a reason instead of a key when the install fingerprint cannot be read, which disables the gate.
+ */
 export declare function computeCacheKey(options: {
     anchorDir: string;
     command: string;
@@ -72,26 +132,105 @@ export declare function computeCacheKey(options: {
     ok: false;
     reason: string;
 };
+/**
+ * Folds what changes a transcript without changing a conclusion onto the pass key: the channel each of the
+ * command's output streams ran on, and the environment variables a tool presents itself through.
+ *
+ * Taking the pass key as an ingredient rather than recomputing its parts is what keeps the two from drifting
+ * apart. The channel kind is what keeps a run at a terminal from replaying a piped recording; folding in raw
+ * TTY-ness instead would be wrong under quiet mode, where the child sees pipes at a terminal and the
+ * transcript is reproducible.
+ */
 export declare function computeRetentionKey(options: {
     channels: OutputChannels;
     env: NodeJS.ProcessEnv;
     passKey: string;
 }): string;
+/** Renders a snapshot for the environment of every process below this one. */
 export declare function encodeTreeSnapshot(snapshot: TreeSnapshot): string;
+/**
+ * Names a covered package whose output differs between two observations of it, or `undefined` when every
+ * package agrees. A package that has appeared or disappeared between them counts as a disagreement, because
+ * the output the earlier observation describes is not the output the later one found.
+ */
 export declare function findStaleBuildOutput(earlier: Record<string, string>, later: Record<string, string>): string | undefined;
+/**
+ * Renders the warning for a `--no-cache` that landed after the command name, where it is an argument to the
+ * command rather than a flag to nmr. Passing it on unchanged is the honest thing to do with an argument, so
+ * the warning is all that separates this from a silently un-bypassed run.
+ */
 export declare function formatMisplacedNoCacheWarning(command: string): string;
+/**
+ * Reports whether a command's passes are recorded at all, which is what separates a command with no recording
+ * from one that could never have had one.
+ *
+ * A hook is excluded here rather than at one caller: it is not a command anyone asks for, so nothing records
+ * it, and a repo naming one in `extraCommands` must not make the gate and a reader of its entries disagree.
+ */
 export declare function isCacheableCommand(checkCache: CheckCacheConfig | undefined, command: string): boolean;
+/**
+ * Reads the state of the build output nmr's own build covers. Build output is git-ignored, so the tree hash
+ * says nothing about it: a `ci` whose `build` constituent is cached would otherwise skip on a tree whose `dist`
+ * had been deleted, or whose `dist` was compiled from a different tree, and hand back a green exit over a
+ * repository that cannot run.
+ *
+ * A package whose `build` or `compile` is overridden emits somewhere this does not know about, so it is left
+ * out rather than made a permanent miss.
+ */
 export declare function readBuildOutputState(monorepoRoot: string, config: NmrConfig): Promise<BuildOutputState>;
+/**
+ * Reads the entry recorded for one command at one scope, or `undefined` when there is none to trust.
+ *
+ * Retention is vouched for separately from the pass it rides on: an excerpt of a shape this cannot read is
+ * dropped, leaving a pass that skips cleanly and reports its verdict alone. Voiding the pass instead would
+ * cost a full run to avoid a line nobody would have printed.
+ */
 export declare function readCheckCacheEntry(options: {
     anchorDir: string;
     command: string;
     monorepoRoot: string;
 }): Promise<CheckCacheEntry | undefined>;
+/**
+ * Reads the whole output one recorded pass retained, or `undefined` where it retained none.
+ *
+ * Held to nothing on its own: the entry beside it is what says which tree the bytes describe, and a caller
+ * that has not matched the entry's key is reading a transcript of some other tree.
+ */
 export declare function readTranscript(ref: EntryRef): Promise<string | undefined>;
+/**
+ * Makes the transcript beside one entry be exactly what this pass retained, removing what an earlier pass
+ * left when this one retained nothing.
+ *
+ * A composite retains nothing of its own, so without the removal a leaf's transcript would stand beside an
+ * entry that never produced it, and `--log` would date another run's bytes by this one's instant.
+ */
 export declare function recordTranscript(ref: EntryRef, transcript: string | undefined): Promise<void>;
+/** Removes every recorded pass for a monorepo, or for a standalone package outside one. */
 export declare function removeCheckCache(scopeDir: string): Promise<void>;
+/**
+ * Merges a repo's `checkCache` configuration into the default set. Extending rather than replacing means
+ * declaring one command cannot silently drop the defaults; excluding is how a repo retires a name whose chain
+ * turned out to do more than report an exit status.
+ */
 export declare function resolveCacheableCommands(checkCache: CheckCacheConfig | undefined): Set<string>;
+/**
+ * Resolves the identity of the run this invocation belongs to: the one an ancestor nmr process passed down,
+ * and otherwise a fresh one, this invocation being where the run starts.
+ *
+ * Unbounded where the tree snapshot is bounded by a HEAD comparison: a process that outlives its run hands a
+ * stale identity to the invocations it later makes, and what keeps that harmless is the tree hash every
+ * constituent entry is held to before its excerpt joins an assembly.
+ */
 export declare function resolveRunId(env: NodeJS.ProcessEnv): string;
+/**
+ * Resolves the tree snapshot this invocation gates on: the one a parent nmr process already took, when there
+ * is one, and otherwise a fresh hash of the working tree. Reports a reason instead when no snapshot can be
+ * had, which disables the gate.
+ *
+ * The monorepo root must be the git toplevel. A repository holding the monorepo inside a subdirectory has
+ * content outside it that the checks may still read, and a hash covering more than the monorepo would move
+ * for edits that cannot affect it.
+ */
 export declare function resolveTreeSnapshot(options: {
     monorepoRoot: string;
     env: NodeJS.ProcessEnv;
@@ -102,10 +241,16 @@ export declare function resolveTreeSnapshot(options: {
     ok: false;
     reason: string;
 };
+/** Records a pass, replacing whatever this command last recorded at this scope. */
 export declare function writeCheckCacheEntry(options: {
     anchorDir: string;
     command: string;
     entry: CheckCacheEntry;
     monorepoRoot: string;
 }): Promise<void>;
+/**
+ * Writes a note explaining a gate decision, but only when `NMR_DEBUG=1`. The gate is silent by default: a
+ * reason to run is not news, and a line per invocation explaining why nothing was skipped would bury the
+ * output of the command that did run.
+ */
 export declare function writeDebugNote(message: string, env: NodeJS.ProcessEnv, stderr: Writable): void;