@williamthorsen/release-kit 10.4.4 → 10.6.0

package/dist/esm/validateOverridesCommand.d.ts

@@ -1,14 +1,44 @@
 import { type ValidateAllChangelogOverridesInputs, type ValidateAllChangelogOverridesResult } from './changelogOverrides.js';
 import type { ChangelogEntry, ReleaseConfig } from './types.js';
+/**
+ * Result of {@link validateOverridesCommand}: tiered exit code paired with a human-readable
+ * message. Mirrors the shape of `checkWorkTypesDrift` so the CLI dispatch layer can stay
+ * uniformly thin.
+ *
+ * Exit codes:
+ * - `0` — clean: no errors, no warnings.
+ * - `1` — only stale-key warnings.
+ * - `2` — schema/parse or ambiguous-prefix errors (errors dominate when both classes exist).
+ */
 export interface ValidateOverridesCommandResult {
     exitCode: 0 | 1 | 2;
     message: string;
 }
+/** Injection seams for unit testing. Production callers leave defaults; tests substitute deterministic fakes. */
 export interface ValidateOverridesCommandDependencies {
     discoverWorkspaces?: () => Promise<string[] | undefined>;
     loadConfig?: () => Promise<unknown>;
+    /**
+     * Build changelog entries for a scope. Defaults to `buildChangelogEntries`, the same path
+     * `release-kit prepare` uses — anchoring `validate`'s hash universe to `prepare`'s by
+     * construction. `tagPattern` and `includePaths` are passed straight through to git-cliff.
+     */
     buildEntries?: (config: Pick<ReleaseConfig, 'cliffConfigPath' | 'changelogJson'>, tagPattern?: string, includePaths?: string[]) => ChangelogEntry[];
+    /** Pluggable validator (default: the production library function). Tests use this to drive specific result shapes through the formatter. */
     validate?: (inputs: ValidateAllChangelogOverridesInputs) => ValidateAllChangelogOverridesResult;
 }
+/**
+ * Validate every changelog override file across the project and per-workspace scopes, and
+ * return a tiered exit-code-plus-message result. Performs workspace discovery, config load,
+ * and per-scope hash collection, then delegates the actual validation to
+ * {@link validateAllChangelogOverrides}.
+ *
+ * Single-package and monorepo modes are handled uniformly: single-package collapses to one
+ * project scope; monorepo expands to a project scope plus one scope per workspace.
+ */
 export declare function validateOverridesCommand(dependencies?: ValidateOverridesCommandDependencies): Promise<ValidateOverridesCommandResult>;
+/**
+ * Pure formatter — take an aggregated validation result, return the tiered exit code and a
+ * rendered message. Exported for unit testing without going through the full discovery path.
+ */
 export declare function formatValidateOverridesResult(result: ValidateAllChangelogOverridesResult): ValidateOverridesCommandResult;

package/dist/esm/workTypesData.d.ts

@@ -1,3 +1,17 @@
+/**
+ * Canonical work-types data — runtime mirror of `work-types.json`.
+ *
+ * `work-types.json` is the canonical SSOT for the taxonomy and is the file
+ * `release-kit work-types check` / `:sync` operate on. This `.ts` mirror exists for
+ * runtime consumption: ESM JSON imports require an `import attributes` clause that
+ * esbuild's `bundle: false` mode strips, so a plain TS module is the most reliable way
+ * to ship the data to consumers.
+ *
+ * A drift test (`workTypesData.unit.test.ts`) asserts that this constant deep-equals the
+ * parsed contents of `work-types.json`. To change the taxonomy, edit BOTH files (or run
+ * `nmr work-types:sync` to pull from upstream).
+ */
+/** Schema for a single entry. */
 export interface WorkTypeEntry {
     tier: string;
     key: string;
@@ -7,16 +21,29 @@ export interface WorkTypeEntry {
     breakingPolicy: 'forbidden' | 'optional' | 'required';
     excludedFromChangelog?: boolean;
 }
+/**
+ * Schema for an orthogonal section marker (e.g., breaking-changes indicator).
+ *
+ * Stored as plain text — consumers add formatting (bold, prefix punctuation) when
+ * constructing the rendered form. Keeps the SSOT format-agnostic across Markdown,
+ * HTML, terminal, and plain-text consumers.
+ */
 export interface MarkerEntry {
     emoji: string;
     label: string;
 }
+/** Schema for the full data. */
 export interface WorkTypesData {
     tiers: string[];
     types: WorkTypeEntry[];
+    /**
+     * Cross-cutting section markers keyed by marker name. The `breaking` marker is
+     * canonical and required; additional keys are permitted for forward-compatibility.
+     */
     markers: {
         [key: string]: MarkerEntry;
         breaking: MarkerEntry;
     };
 }
+/** Canonical work-types data, kept in lockstep with `work-types.json`. */
 export declare const WORK_TYPES_DATA: WorkTypesData;

package/dist/esm/workTypesUtils.d.ts

@@ -1,5 +1,22 @@
+/**
+ * Shared helpers for the work-types canonical-source tooling.
+ *
+ * Both `checkWorkTypesDrift` and `syncWorkTypes` need to validate the upstream JSON's top-level
+ * shape and render unknown errors as strings. Keeping a single copy here avoids byte-for-byte
+ * duplication between the two entry points.
+ */
+/** Sanity-check that the parsed upstream JSON carries the expected top-level shape. */
 export declare function hasExpectedTopLevelShape(value: unknown): value is {
     tiers: unknown[];
     types: unknown[];
 };
+/**
+ * Build the `init` argument for `fetch` to reach codeassembly's canonical work-types files.
+ *
+ * Returns `{ headers: { Authorization: 'Bearer <token>' } }` when `GITHUB_TOKEN` is set in the
+ * environment; returns `undefined` otherwise so the call site stays byte-identical to an
+ * unauthenticated request. Centralised here so `checkWorkTypesDrift` and `syncWorkTypes`
+ * cannot diverge on auth handling. Tests stub the env via `vi.stubEnv` rather than parameter
+ * injection, so this reads `process.env` directly.
+ */
 export declare function buildFetchInit(): RequestInit | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@williamthorsen/release-kit",
-  "version": "10.4.4",
+  "version": "10.6.0",
   "description": "Version-bumping and changelog-generation toolkit for release workflows",
   "keywords": [
     "changelog",
@@ -38,30 +38,31 @@
     "release-kit": "./bin/release-kit.js"
   },
   "files": [
+    ".meta/changelog.json",
     ".readyup/kits/*.js",
     ".readyup/manifest.json",
+    "CHANGELOG.md",
     "bin",
-    "dist/*",
     "cliff.toml.template",
+    "dist/*",
     "presets/**",
-    "schemas/**",
-    "CHANGELOG.md"
+    "schemas/**"
   ],
   "dependencies": {
-    "@williamthorsen/toolbelt.errors": "0.6.1",
+    "@williamthorsen/nmr-core": "0.11.0",
+    "@williamthorsen/toolbelt.errors": "0.7.0",
     "glob": "13.0.6",
     "json-stringify-pretty-compact": "4.0.0",
     "semver": "7.8.5",
     "yaml": "2.9.0",
-    "zod": "4.4.3",
-    "@williamthorsen/nmr-core": "0.10.3"
+    "zod": "4.5.4"
   },
   "devDependencies": {
     "@types/semver": "7.8.0",
-    "@williamthorsen/toolbelt.filesystem": "0.8.0",
-    "@williamthorsen/toolbelt.testing": "0.4.0",
-    "@williamthorsen/toolbelt.vitest": "0.6.0",
-    "readyup": "0.32.0",
+    "@williamthorsen/toolbelt.filesystem": "0.8.3",
+    "@williamthorsen/toolbelt.testing": "0.5.1",
+    "@williamthorsen/toolbelt.vitest": "0.9.0",
+    "readyup": "0.35.0",
     "smol-toml": "1.8.0"
   },
   "engines": {