@williamthorsen/release-kit 15.0.3 → 16.0.0

package/dist/esm/validateConfig.js

@@ -1,15 +1,18 @@
 import { releaseKitConfigSchema } from "./configSchema.js";
 import { isRecord } from "./typeGuards.js";
-export function validateConfig(raw) {
-    if (!isRecord(raw)) {
+export function validateConfig(rawConfig) {
+    if (!isRecord(rawConfig)) {
         return { config: {}, errors: ['Config must be an object'], warnings: [] };
     }
-    const { cleaned, deprecationErrors } = preprocessDeprecatedKeys(raw);
-    const parseResult = releaseKitConfigSchema.safeParse(cleaned);
+    const { cleanedInput, deprecationErrors } = preprocessDeprecatedKeys(rawConfig);
+    const parseResult = releaseKitConfigSchema.safeParse(cleanedInput);
     if (!parseResult.success) {
         return {
             config: {},
-            errors: [...deprecationErrors, ...parseResult.error.issues.flatMap((issue) => formatZodIssue(issue, cleaned))],
+            errors: [
+                ...deprecationErrors,
+                ...parseResult.error.issues.flatMap((issue) => formatZodIssue(issue, cleanedInput)),
+            ],
             warnings: [],
         };
     }
@@ -26,40 +29,47 @@ export function validateConfig(raw) {
     }
     return { config, errors, warnings };
 }
-function preprocessDeprecatedKeys(raw) {
-    if (!isRecord(raw))
-        return { cleaned: raw, deprecationErrors: [] };
+function preprocessDeprecatedKeys(rawConfig) {
+    if (!isRecord(rawConfig))
+        return { cleanedInput: rawConfig, deprecationErrors: [] };
     const errors = [];
-    const cleaned = { ...raw };
-    if (Object.hasOwn(cleaned, 'cliffConfigPath')) {
+    const cleanedInput = { ...rawConfig };
+    if (Object.hasOwn(cleanedInput, 'cliffConfigPath')) {
         errors.push('cliffConfigPath is no longer supported. release-kit reads changelog history from git directly and does not use any external config file. Remove this field from the config, and delete the file that it names.');
-        delete cleaned['cliffConfigPath'];
+        delete cleanedInput['cliffConfigPath'];
     }
-    if (isRecord(cleaned['releaseNotes']) && Object.hasOwn(cleaned['releaseNotes'], 'shouldCreateGithubRelease')) {
+    if (isRecord(cleanedInput['releaseNotes']) &&
+        Object.hasOwn(cleanedInput['releaseNotes'], 'shouldCreateGithubRelease')) {
         errors.push('releaseNotes.shouldCreateGithubRelease is no longer supported. Adoption is now signaled by installing the create-github-release workflow, which `release-kit init` scaffolds. Remove this field from the config.');
-        const releaseNotesCopy = { ...cleaned['releaseNotes'] };
+        const releaseNotesCopy = { ...cleanedInput['releaseNotes'] };
         delete releaseNotesCopy['shouldCreateGithubRelease'];
-        cleaned['releaseNotes'] = releaseNotesCopy;
-    }
-    if (Array.isArray(cleaned['workspaces'])) {
-        cleaned['workspaces'] = cleaned['workspaces'].map((ws, i) => {
-            if (!isRecord(ws))
-                return ws;
-            const wsCopy = { ...ws };
-            if (Object.hasOwn(wsCopy, 'tagPrefix')) {
-                const dir = typeof wsCopy['dir'] === 'string' && wsCopy['dir'] !== '' ? wsCopy['dir'] : '<dir>';
-                errors.push(`workspaces[${i}]: 'tagPrefix' is no longer supported; remove it to use the default '${dir}-v'`);
-                delete wsCopy['tagPrefix'];
+        cleanedInput['releaseNotes'] = releaseNotesCopy;
+    }
+    if (isRecord(cleanedInput['changelogMarkdown']) && Object.hasOwn(cleanedInput['changelogMarkdown'], 'keepVersions')) {
+        errors.push('changelogMarkdown.keepVersions has been renamed. Rename it to changelogMarkdown.keptVersionCount in the config.');
+        const changelogMarkdownCopy = { ...cleanedInput['changelogMarkdown'] };
+        delete changelogMarkdownCopy['keepVersions'];
+        cleanedInput['changelogMarkdown'] = changelogMarkdownCopy;
+    }
+    if (Array.isArray(cleanedInput['workspaces'])) {
+        cleanedInput['workspaces'] = cleanedInput['workspaces'].map((workspace, index) => {
+            if (!isRecord(workspace))
+                return workspace;
+            const workspaceCopy = { ...workspace };
+            if (Object.hasOwn(workspaceCopy, 'tagPrefix')) {
+                const dir = typeof workspaceCopy['dir'] === 'string' && workspaceCopy['dir'] !== '' ? workspaceCopy['dir'] : '<dir>';
+                errors.push(`workspaces[${index}]: 'tagPrefix' is no longer supported; remove it to use the default '${dir}-v'`);
+                delete workspaceCopy['tagPrefix'];
             }
-            if (Object.hasOwn(wsCopy, 'legacyTagPrefixes')) {
-                errors.push(`workspaces[${i}]: 'legacyTagPrefixes' is no longer supported; use 'legacyIdentities: [{ name, tagPrefix }, ...]' instead`);
-                delete wsCopy['legacyTagPrefixes'];
+            if (Object.hasOwn(workspaceCopy, 'legacyTagPrefixes')) {
+                errors.push(`workspaces[${index}]: 'legacyTagPrefixes' is no longer supported; use 'legacyIdentities: [{ name, tagPrefix }, ...]' instead`);
+                delete workspaceCopy['legacyTagPrefixes'];
             }
-            return wsCopy;
+            return workspaceCopy;
         });
     }
-    if (isRecord(cleaned['releases'])) {
-        const releasesCopy = { ...cleaned['releases'] };
+    if (isRecord(cleanedInput['releases'])) {
+        const releasesCopy = { ...cleanedInput['releases'] };
         for (const [name, entry] of Object.entries(releasesCopy)) {
             if (!isRecord(entry) || !Object.hasOwn(entry, 'paths'))
                 continue;
@@ -68,9 +78,9 @@ function preprocessDeprecatedKeys(raw) {
             delete entryCopy['paths'];
             releasesCopy[name] = entryCopy;
         }
-        cleaned['releases'] = releasesCopy;
+        cleanedInput['releases'] = releasesCopy;
     }
-    return { cleaned, deprecationErrors: errors };
+    return { cleanedInput, deprecationErrors: errors };
 }
 function formatZodIssue(issue, input) {
     if (issue.code === 'invalid_union' && issue.path.length === 2 && issue.path[0] === 'releases') {
@@ -92,42 +102,42 @@ function customizeMessage(issue) {
 }
 const RELEASE_ENTRY_SHAPES = 'must be false, { path, tagPrefix?, legacyIdentities? }, or { includes, tagPrefix? }';
 function renderPath(path) {
-    let rendered = '';
+    let renderedPath = '';
     for (const segment of path) {
         if (typeof segment === 'number') {
-            rendered += `[${segment}]`;
+            renderedPath += `[${segment}]`;
         }
-        else if (rendered === '') {
-            rendered += String(segment);
+        else if (renderedPath === '') {
+            renderedPath += String(segment);
         }
         else {
-            rendered += `.${String(segment)}`;
+            renderedPath += `.${String(segment)}`;
         }
     }
-    return rendered;
+    return renderedPath;
 }
 function detectLegacyIdentityDuplicates(config, errors) {
     for (const { label, legacyIdentities } of listLegacyIdentityDeclarations(config)) {
-        const seen = new Set();
+        const seenKeys = new Set();
         for (const [entryIndex, identity] of legacyIdentities.entries()) {
             const key = `${identity.name}\0${identity.tagPrefix}`;
-            if (seen.has(key)) {
+            if (seenKeys.has(key)) {
                 errors.push(`${label}.legacyIdentities[${entryIndex}]: duplicate identity (name='${identity.name}', tagPrefix='${identity.tagPrefix}')`);
             }
-            seen.add(key);
+            seenKeys.add(key);
         }
     }
 }
 function detectRetiredPackageDuplicates(config, errors) {
     if (config.retiredPackages === undefined)
         return;
-    const seen = new Set();
-    for (const [index, retired] of config.retiredPackages.entries()) {
-        const key = `${retired.name}\0${retired.tagPrefix}`;
-        if (seen.has(key)) {
-            errors.push(`retiredPackages[${index}]: duplicate package (name='${retired.name}', tagPrefix='${retired.tagPrefix}')`);
+    const seenKeys = new Set();
+    for (const [index, retiredPackage] of config.retiredPackages.entries()) {
+        const key = `${retiredPackage.name}\0${retiredPackage.tagPrefix}`;
+        if (seenKeys.has(key)) {
+            errors.push(`retiredPackages[${index}]: duplicate package (name='${retiredPackage.name}', tagPrefix='${retiredPackage.tagPrefix}')`);
         }
-        seen.add(key);
+        seenKeys.add(key);
     }
 }
 function detectRetiredVsLegacyCollisions(config, errors) {
@@ -141,10 +151,10 @@ function detectRetiredVsLegacyCollisions(config, errors) {
             }
         }
     }
-    for (const [index, retired] of config.retiredPackages.entries()) {
-        const collidingOwner = legacyPrefixToOwner.get(retired.tagPrefix);
+    for (const [index, retiredPackage] of config.retiredPackages.entries()) {
+        const collidingOwner = legacyPrefixToOwner.get(retiredPackage.tagPrefix);
         if (collidingOwner !== undefined) {
-            errors.push(`retiredPackages[${index}]: tagPrefix '${retired.tagPrefix}' collides with a declared legacyIdentities[].tagPrefix on ${collidingOwner}`);
+            errors.push(`retiredPackages[${index}]: tagPrefix '${retiredPackage.tagPrefix}' collides with a declared legacyIdentities[].tagPrefix on ${collidingOwner}`);
         }
     }
 }

package/dist/esm/validateOverridesCommand.js

@@ -11,7 +11,7 @@ const SYNTHETIC_VALIDATE_TAG = 'validate-only';
 export async function validateOverridesCommand(styles, configPath, dependencies = {}) {
     const discover = dependencies.discoverWorkspaces ?? discoverWorkspaces;
     const load = dependencies.loadValidatedConfig ?? (() => loadValidatedConfig(configPath));
-    const buildEntries = dependencies.buildEntries ?? defaultBuildEntries;
+    const buildEntries = dependencies.buildEntries ?? buildEntriesByDefault;
     const validate = dependencies.validate ?? validateAllChangelogOverrides;
     const configResult = await load();
     if (configResult.status === 'invalid') {
@@ -66,7 +66,7 @@ function formatSummaryLine(errorCount, warningCount) {
 function pluralize(count, noun) {
     return count === 1 ? `${count} ${noun}` : `${count} ${noun}s`;
 }
-function defaultBuildEntries(config, options) {
+function buildEntriesByDefault(config, options) {
     return buildChangelogEntries(config, SYNTHETIC_VALIDATE_TAG, options).entries;
 }
 function flattenEntriesToItems(entries) {

package/docs/changelogs.md

@@ -2,7 +2,7 @@
 
 What a published tarball includes, what each `.meta/changelog.json` item contains, how `CHANGELOG.md` archives older versions, which commits appear in a changelog, how a merge commit's change-record block becomes items, and how release notes are written into a README.
 
-npm doesn't include either `CHANGELOG.md` or `.meta/changelog.json` in a published tarball on its own. npm stopped including `CHANGELOG` automatically in npm 7, so a package that declares a `files` field publishes a changelog only when that field names `CHANGELOG.md` and `.meta/changelog.json`. release-kit's readyup kit reports a publishable workspace whose `files` field omits either, and, when [`changelogMarkdown.keepVersions`](#archived-versions) is set, one whose `files` field omits `changelogs/`.
+npm doesn't include either `CHANGELOG.md` or `.meta/changelog.json` in a published tarball on its own. npm stopped including `CHANGELOG` automatically in npm 7, so a package that declares a `files` field publishes a changelog only when that field names `CHANGELOG.md` and `.meta/changelog.json`. release-kit's readyup kit reports a publishable workspace whose `files` field omits either, and, when [`changelogMarkdown.keptVersionCount`](#archived-versions) is set, one whose `files` field omits `changelogs/`.
 
 ## `changelog.json` item schema
 
@@ -43,19 +43,19 @@ The label match is exact: `migration:` and `**Migration:**` are not recognized.
 
 ## Archived versions
 
-`changelogMarkdown.keepVersions` bounds `CHANGELOG.md`, which otherwise grows by one section per release. `.meta/changelog.json` is not affected: It contains every version whatever the option says.
+`changelogMarkdown.keptVersionCount` bounds `CHANGELOG.md`, which otherwise grows by one section per release. `.meta/changelog.json` is not affected: It contains every version whatever the option says.
 
 ```typescript
 export default defineConfig({
-  changelogMarkdown: { keepVersions: 20 },
+  changelogMarkdown: { keptVersionCount: 20 },
 });
 ```
 
 With the option set, `prepare` writes each changelog as follows:
 
-- **`CHANGELOG.md`** contains the newest `keepVersions` sections, counting [hand-written sections](#existing-changelogmd-sections), and a paragraph below its header that links to each archive file.
+- **`CHANGELOG.md`** contains as many of the newest sections as `keptVersionCount` names, counting [hand-written sections](#existing-changelogmd-sections), and a paragraph below its header that links to each archive file.
 - **`changelogs/CHANGELOG-v{major}.md`**, beside `CHANGELOG.md`, contains every older section of that major version, newest first, under the same header and footer. `0.x` versions share `CHANGELOG-v0.md`, and a prerelease belongs to its major.
-- **An archive file that the render no longer produces**, after `keepVersions` is raised or the option is removed: `prepare` deletes it and renders its sections in `CHANGELOG.md` again. Every section is therefore in exactly one file.
+- **An archive file that the render no longer produces**, after `keptVersionCount` is raised or the option is removed: `prepare` deletes it and renders its sections in `CHANGELOG.md` again. Every section is therefore in exactly one file.
 
 `prepare` regenerates the archive files on every release of the target, so an override applies to an archived version as it does to any other. A target that does not release keeps its unbounded `CHANGELOG.md` until its next release. The prepare report lists each archive file that it writes and each that it removes.
 

package/docs/configuration.md

@@ -29,7 +29,7 @@ The two paths differ in what an absent file means. An absent default path means
 | `project`           | `ProjectConfig`                             | Opt-in project-level release block. Declaring `project: {}` (even empty) enables a project-release stage in `prepare`                                                                                                                                                                    |
 | `repoLabels`        | `RepoLabelsConfig`                          | Declares the repository's label registry for `sync-labels`; see [Label configuration](labels.md#label-configuration)                                                                                                                                                                     |
 | `changelogJson`     | `ChangelogJsonConfig`                       | Controls `.meta/changelog.json`: `enabled` (default `true`), `outputPath` (default `'.meta/changelog.json'`), and `devOnlySections`; see [Custom work types](work-types.md#custom-work-types)                                                                                            |
-| `changelogMarkdown` | `ChangelogMarkdownConfig`                   | `keepVersions` (an integer, at least 1) bounds `CHANGELOG.md` to that many of the newest versions and moves the rest into per-major archive files; omitted, `CHANGELOG.md` renders every version. See [Archived versions](changelogs.md#archived-versions)                               |
+| `changelogMarkdown` | `ChangelogMarkdownConfig`                   | `keptVersionCount` (an integer, at least 1) bounds `CHANGELOG.md` to that many of the newest versions and moves the rest into per-major archive files; omitted, `CHANGELOG.md` renders every version. See [Archived versions](changelogs.md#archived-versions)                           |
 | `releaseNotes`      | `ReleaseNotesConfig`                        | `shouldInjectIntoReadme` (default `false`) injects release notes into each package's README while it publishes; see [Release-notes injection](changelogs.md#release-notes-injection)                                                                                                     |
 
 All fields are optional.

package/docs/work-types.md

@@ -51,7 +51,7 @@ Each work-type has a `breakingPolicy` value:
 
 A `BREAKING CHANGE:` body footer on a `forbidden`-policy type triggers the same warning path as the prefix `!` does: A type that cannot be breaking is parsed as non-breaking whichever surface has the signal. The warning is all that a footer triggers; it doesn't raise a bump (see [`🚨 **Breaking:**` bullet marker](#-breaking-bullet-marker)).
 
-The release-prepare orchestrator (`releasePrepareTargets`) applies `DEFAULT_BREAKING_POLICIES` automatically. Violations in the titles and change-record entries of each workspace's or project's unreleased window are collected onto the corresponding result's `policyViolations` field, on a skipped result as on a released one, and rendered under the section in the prepare report:
+The release-prepare orchestrator (`prepareReleaseTargets`) applies `DEFAULT_BREAKING_POLICIES` automatically. Violations in the titles and change-record entries of each workspace's or project's unreleased window are collected onto the corresponding result's `policyViolations` field, on a skipped result as on a released one, and rendered under the section in the prepare report:
 
 ```
 arrays

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@williamthorsen/release-kit",
-  "version": "15.0.3",
+  "version": "16.0.0",
   "description": "Version-bumping and changelog-generation toolkit for release workflows",
   "keywords": [
     "changelog",