@williamthorsen/release-kit 6.0.0 → 8.0.0

package/dist/esm/releasePrepareProject.d.ts

@@ -1,5 +1,5 @@
-import type { ReleasePrepareOptions } from './releasePrepare.ts';
-import type { ChangelogOverride, MonorepoReleaseConfig, ProjectPrepareResult } from './types.ts';
+import type { ReleasePrepareOptions } from './releasePrepare.js';
+import type { ChangelogOverride, MonorepoReleaseConfig, ProjectPrepareResult } from './types.js';
 export interface ReleasePrepareProjectArgs {
     config: MonorepoReleaseConfig;
     options: ReleasePrepareOptions;

package/dist/esm/releasePrepareProject.js

@@ -11,167 +11,157 @@ import { getCommitsSinceTarget } from "./getCommitsSinceTarget.js";
 import { writeChangelogMarkdown } from "./renderChangelogMarkdown.js";
 import { deriveSectionOrder } from "./resolveReleaseNotesConfig.js";
 import { writeReleaseNotesPreviews } from "./writeReleaseNotesPreviews.js";
-const ROOT_PACKAGE_FILE = "./package.json";
-const ROOT_CHANGELOG_PATH = ".";
-function releasePrepareProject(args) {
-  const { config, options, modifiedFiles, tags } = args;
-  const { rootOverrides, overrideWarnings, globalMatchedRootKeys } = resolveOptionalOverrideArgs(args);
-  const { dryRun, bumpOverride, withReleaseNotes, force } = options;
-  const project = config.project;
-  if (project === void 0) {
-    throw new Error("releasePrepareProject called without a configured project block");
-  }
-  const workTypes = config.workTypes ?? { ...DEFAULT_WORK_TYPES };
-  const versionPatterns = config.versionPatterns ?? { ...DEFAULT_VERSION_PATTERNS };
-  const breakingPolicies = config.breakingPolicies ?? DEFAULT_BREAKING_POLICIES;
-  const contributingPaths = config.workspaces.flatMap((workspace) => workspace.paths);
-  const { tag, commits } = getCommitsSinceTarget([project.tagPrefix], contributingPaths);
-  const since = tag === void 0 ? "(no previous release found)" : `since ${tag}`;
-  const collector = createPolicyViolationCollector();
-  const decision = decideRelease({
-    commits,
-    force,
-    bumpOverride,
-    workTypes,
-    versionPatterns,
-    scopeAliases: config.scopeAliases,
-    breakingPolicies,
-    onPolicyViolation: collector.onPolicyViolation,
-    skipReasons: {
-      noCommits: `No commits ${since}. Pass --force to release at patch. Skipping.`,
-      noBumpWorthy: `No bump-worthy commits ${since}. Pass --force to release at patch (or --force --bump=X for a different level). Skipping.`
+const ROOT_PACKAGE_FILE = './package.json';
+const ROOT_CHANGELOG_PATH = '.';
+export function releasePrepareProject(args) {
+    const { config, options, modifiedFiles, tags } = args;
+    const { rootOverrides, overrideWarnings, globalMatchedRootKeys } = resolveOptionalOverrideArgs(args);
+    const { dryRun, bumpOverride, withReleaseNotes, force } = options;
+    const project = config.project;
+    if (project === undefined) {
+        throw new Error('releasePrepareProject called without a configured project block');
     }
-  });
-  const policyViolations = collector.violations.length > 0 ? collector.violations : void 0;
-  if (decision.outcome === "skip") {
-    const skipped = {
-      status: "skipped",
-      commitCount: commits.length,
-      parsedCommitCount: decision.parsedCommitCount,
-      skipReason: decision.skipReason
+    const workTypes = config.workTypes ?? { ...DEFAULT_WORK_TYPES };
+    const versionPatterns = config.versionPatterns ?? { ...DEFAULT_VERSION_PATTERNS };
+    const breakingPolicies = config.breakingPolicies ?? DEFAULT_BREAKING_POLICIES;
+    const contributingPaths = config.workspaces.flatMap((workspace) => workspace.paths);
+    const { tag, commits } = getCommitsSinceTarget([project.tagPrefix], contributingPaths);
+    const since = tag === undefined ? '(no previous release found)' : `since ${tag}`;
+    const collector = createPolicyViolationCollector();
+    const decision = decideRelease({
+        commits,
+        force,
+        bumpOverride,
+        workTypes,
+        versionPatterns,
+        scopeAliases: config.scopeAliases,
+        breakingPolicies,
+        onPolicyViolation: collector.onPolicyViolation,
+        skipReasons: {
+            noCommits: `No commits ${since}. Pass --force to release at patch. Skipping.`,
+            noBumpWorthy: `No bump-worthy commits ${since}. Pass --force to release at patch (or --force --bump=X for a different level). Skipping.`,
+        },
+    });
+    const policyViolations = collector.violations.length > 0 ? collector.violations : undefined;
+    if (decision.outcome === 'skip') {
+        const skipped = {
+            status: 'skipped',
+            commitCount: commits.length,
+            parsedCommitCount: decision.parsedCommitCount,
+            skipReason: decision.skipReason,
+        };
+        if (tag !== undefined) {
+            skipped.previousTag = tag;
+        }
+        if (decision.unparseableCommits !== undefined) {
+            skipped.unparseableCommits = decision.unparseableCommits;
+        }
+        if (policyViolations !== undefined) {
+            skipped.policyViolations = policyViolations;
+        }
+        return skipped;
+    }
+    const { releaseType, parsedCommitCount, unparseableCommits } = decision;
+    const bump = bumpAllVersions([ROOT_PACKAGE_FILE], releaseType, dryRun);
+    const newTag = `${project.tagPrefix}${bump.newVersion}`;
+    const { changelogFiles, changelogJsonFiles } = writeProjectChangelogs({
+        config,
+        project,
+        commits,
+        contributingPaths,
+        newTag,
+        newVersion: bump.newVersion,
+        dryRun,
+        rootOverrides,
+        overrideWarnings,
+        globalMatchedRootKeys,
+    });
+    const firstChangelogJsonPath = changelogJsonFiles[0];
+    if (withReleaseNotes === true && config.changelogJson.enabled && firstChangelogJsonPath !== undefined) {
+        const sectionOrder = deriveSectionOrder(workTypes);
+        writeReleaseNotesPreviews({
+            workspacePath: ROOT_CHANGELOG_PATH,
+            tag: newTag,
+            changelogJsonPath: firstChangelogJsonPath,
+            sectionOrder,
+            dryRun,
+        });
+    }
+    tags.push(newTag);
+    modifiedFiles.push(ROOT_PACKAGE_FILE, ...changelogFiles, ...changelogJsonFiles);
+    const result = {
+        status: 'released',
+        commitCount: commits.length,
+        parsedCommitCount,
+        releaseType,
+        currentVersion: bump.currentVersion,
+        newVersion: bump.newVersion,
+        tag: newTag,
+        bumpedFiles: bump.files,
+        changelogFiles,
+        commits,
     };
-    if (tag !== void 0) {
-      skipped.previousTag = tag;
+    if (tag !== undefined) {
+        result.previousTag = tag;
     }
-    if (decision.unparseableCommits !== void 0) {
-      skipped.unparseableCommits = decision.unparseableCommits;
+    if (unparseableCommits !== undefined) {
+        result.unparseableCommits = unparseableCommits;
     }
-    if (policyViolations !== void 0) {
-      skipped.policyViolations = policyViolations;
+    if (policyViolations !== undefined) {
+        result.policyViolations = policyViolations;
     }
-    return skipped;
-  }
-  const { releaseType, parsedCommitCount, unparseableCommits } = decision;
-  const bump = bumpAllVersions([ROOT_PACKAGE_FILE], releaseType, dryRun);
-  const newTag = `${project.tagPrefix}${bump.newVersion}`;
-  const { changelogFiles, changelogJsonFiles } = writeProjectChangelogs({
-    config,
-    project,
-    commits,
-    contributingPaths,
-    newTag,
-    newVersion: bump.newVersion,
-    dryRun,
-    rootOverrides,
-    overrideWarnings,
-    globalMatchedRootKeys
-  });
-  const firstChangelogJsonPath = changelogJsonFiles[0];
-  if (withReleaseNotes === true && config.changelogJson.enabled && firstChangelogJsonPath !== void 0) {
-    const sectionOrder = deriveSectionOrder(workTypes);
-    writeReleaseNotesPreviews({
-      workspacePath: ROOT_CHANGELOG_PATH,
-      tag: newTag,
-      changelogJsonPath: firstChangelogJsonPath,
-      sectionOrder,
-      dryRun
-    });
-  }
-  tags.push(newTag);
-  modifiedFiles.push(ROOT_PACKAGE_FILE, ...changelogFiles, ...changelogJsonFiles);
-  const result = {
-    status: "released",
-    commitCount: commits.length,
-    parsedCommitCount,
-    releaseType,
-    currentVersion: bump.currentVersion,
-    newVersion: bump.newVersion,
-    tag: newTag,
-    bumpedFiles: bump.files,
-    changelogFiles,
-    commits
-  };
-  if (tag !== void 0) {
-    result.previousTag = tag;
-  }
-  if (unparseableCommits !== void 0) {
-    result.unparseableCommits = unparseableCommits;
-  }
-  if (policyViolations !== void 0) {
-    result.policyViolations = policyViolations;
-  }
-  if (bumpOverride !== void 0) {
-    result.bumpOverride = bumpOverride;
-  }
-  return result;
+    if (bumpOverride !== undefined) {
+        result.bumpOverride = bumpOverride;
+    }
+    return result;
 }
 function resolveOptionalOverrideArgs(args) {
-  return {
-    rootOverrides: args.rootOverrides ?? /* @__PURE__ */ new Map(),
-    overrideWarnings: args.overrideWarnings ?? [],
-    globalMatchedRootKeys: args.globalMatchedRootKeys ?? /* @__PURE__ */ new Set()
-  };
+    return {
+        rootOverrides: args.rootOverrides ?? new Map(),
+        overrideWarnings: args.overrideWarnings ?? [],
+        globalMatchedRootKeys: args.globalMatchedRootKeys ?? new Set(),
+    };
 }
 function writeProjectChangelogs(args) {
-  const {
-    config,
-    project,
-    commits,
-    contributingPaths,
-    newTag,
-    newVersion,
-    dryRun,
-    rootOverrides,
-    overrideWarnings,
-    globalMatchedRootKeys
-  } = args;
-  const isEmptyRange = commits.length === 0;
-  const today = (/* @__PURE__ */ new Date()).toISOString().slice(0, 10);
-  const tagPattern = buildTagPattern([project.tagPrefix]);
-  const newEntries = isEmptyRange ? [buildEmptyReleaseEntry(newVersion, today)] : buildChangelogEntries(config, newTag, { tagPattern, includePaths: contributingPaths });
-  const applied = applyChangelogOverrides(newEntries, rootOverrides);
-  if (applied.errors.length > 0) {
-    throw new Error(`Changelog override application failed:
-  - ${applied.errors.join("\n  - ")}`);
-  }
-  overrideWarnings.push(...applied.warnings);
-  for (const matched of applied.matchedKeys) {
-    globalMatchedRootKeys.add(matched);
-  }
-  const changelogJsonPath = resolveChangelogJsonPath(config, ROOT_CHANGELOG_PATH);
-  const sectionOrder = deriveSectionOrder(config.workTypes ?? { ...DEFAULT_WORK_TYPES });
-  const renderEntries = isEmptyRange ? mergeChangelogEntriesWithDisk(changelogJsonPath, applied.entries) : applied.entries;
-  if (config.changelogJson.enabled && !dryRun) {
-    if (isEmptyRange) {
-      writeChangelogJson(changelogJsonPath, renderEntries);
-    } else {
-      writeChangelogJson(changelogJsonPath, applied.entries);
+    const { config, project, commits, contributingPaths, newTag, newVersion, dryRun, rootOverrides, overrideWarnings, globalMatchedRootKeys, } = args;
+    const isEmptyRange = commits.length === 0;
+    const today = new Date().toISOString().slice(0, 10);
+    const tagPattern = buildTagPattern([project.tagPrefix]);
+    const newEntries = isEmptyRange
+        ? [buildEmptyReleaseEntry(newVersion, today)]
+        : buildChangelogEntries(config, newTag, { tagPattern, includePaths: contributingPaths });
+    const applied = applyChangelogOverrides(newEntries, rootOverrides);
+    if (applied.errors.length > 0) {
+        throw new Error(`Changelog override application failed:\n  - ${applied.errors.join('\n  - ')}`);
+    }
+    overrideWarnings.push(...applied.warnings);
+    for (const matched of applied.matchedKeys) {
+        globalMatchedRootKeys.add(matched);
+    }
+    const changelogJsonPath = resolveChangelogJsonPath(config, ROOT_CHANGELOG_PATH);
+    const sectionOrder = deriveSectionOrder(config.workTypes ?? { ...DEFAULT_WORK_TYPES });
+    const renderEntries = isEmptyRange
+        ? mergeChangelogEntriesWithDisk(changelogJsonPath, applied.entries)
+        : applied.entries;
+    if (config.changelogJson.enabled && !dryRun) {
+        if (isEmptyRange) {
+            writeChangelogJson(changelogJsonPath, renderEntries);
+        }
+        else {
+            writeChangelogJson(changelogJsonPath, applied.entries);
+        }
+    }
+    const changelogFiles = [
+        writeChangelogMarkdown({
+            changelogPath: ROOT_CHANGELOG_PATH,
+            entries: renderEntries,
+            sectionOrder,
+            dryRun,
+        }),
+    ];
+    const changelogJsonFiles = [];
+    if (config.changelogJson.enabled) {
+        changelogJsonFiles.push(changelogJsonPath);
     }
-  }
-  const changelogFiles = [
-    writeChangelogMarkdown({
-      changelogPath: ROOT_CHANGELOG_PATH,
-      entries: renderEntries,
-      sectionOrder,
-      dryRun
-    })
-  ];
-  const changelogJsonFiles = [];
-  if (config.changelogJson.enabled) {
-    changelogJsonFiles.push(changelogJsonPath);
-  }
-  return { changelogFiles, changelogJsonFiles };
+    return { changelogFiles, changelogJsonFiles };
 }
-export {
-  releasePrepareProject
-};

package/dist/esm/renderChangelogMarkdown.d.ts

@@ -1,4 +1,4 @@
-import type { ChangelogEntry } from './types.ts';
+import type { ChangelogEntry } from './types.js';
 export interface RenderChangelogMarkdownOptions {
     sectionOrder?: string[];
 }

package/dist/esm/renderChangelogMarkdown.js

@@ -1,32 +1,28 @@
-import { mkdirSync, writeFileSync } from "node:fs";
-import { dirname, join as joinPath } from "node:path";
+import { mkdirSync, writeFileSync } from 'node:fs';
+import { dirname, join as joinPath } from 'node:path';
 import { renderReleaseNotesMulti } from "./renderReleaseNotes.js";
 const CHANGELOG_HEADER = `# Changelog
 
 All notable changes to this project will be documented in this file.`;
 const CHANGELOG_FOOTER = `<!-- Generated by release-kit. Do not edit this file. Use .meta/changelog-overrides.json to override entries. -->`;
-function renderChangelogMarkdown(entries, options) {
-  const body = renderReleaseNotesMulti(entries, options);
-  const trimmedBody = body.trimEnd();
-  const parts = [CHANGELOG_HEADER];
-  if (trimmedBody.length > 0) {
-    parts.push(trimmedBody);
-  }
-  parts.push(CHANGELOG_FOOTER);
-  return parts.join("\n\n") + "\n";
+export function renderChangelogMarkdown(entries, options) {
+    const body = renderReleaseNotesMulti(entries, options);
+    const trimmedBody = body.trimEnd();
+    const parts = [CHANGELOG_HEADER];
+    if (trimmedBody.length > 0) {
+        parts.push(trimmedBody);
+    }
+    parts.push(CHANGELOG_FOOTER);
+    return parts.join('\n\n') + '\n';
 }
-function writeChangelogMarkdown(params) {
-  const { changelogPath, entries, sectionOrder, dryRun = false } = params;
-  const filePath = joinPath(changelogPath, "CHANGELOG.md");
-  if (dryRun) {
+export function writeChangelogMarkdown(params) {
+    const { changelogPath, entries, sectionOrder, dryRun = false } = params;
+    const filePath = joinPath(changelogPath, 'CHANGELOG.md');
+    if (dryRun) {
+        return filePath;
+    }
+    const rendered = renderChangelogMarkdown(entries, sectionOrder !== undefined ? { sectionOrder } : undefined);
+    mkdirSync(dirname(filePath), { recursive: true });
+    writeFileSync(filePath, rendered, 'utf8');
     return filePath;
-  }
-  const rendered = renderChangelogMarkdown(entries, sectionOrder !== void 0 ? { sectionOrder } : void 0);
-  mkdirSync(dirname(filePath), { recursive: true });
-  writeFileSync(filePath, rendered, "utf8");
-  return filePath;
 }
-export {
-  renderChangelogMarkdown,
-  writeChangelogMarkdown
-};

package/dist/esm/renderReleaseNotes.d.ts

@@ -1,4 +1,4 @@
-import type { ChangelogAudience, ChangelogEntry, ChangelogSection } from './types.ts';
+import type { ChangelogAudience, ChangelogEntry, ChangelogSection } from './types.js';
 export interface RenderOptions {
     filter?: (section: ChangelogSection) => boolean;
     includeHeading?: boolean;

package/dist/esm/renderReleaseNotes.js

@@ -1,73 +1,68 @@
 import { WORK_TYPES_DATA } from "./workTypesData.js";
 function getBreakingPrefix() {
-  const { emoji, label } = WORK_TYPES_DATA.markers.breaking;
-  return `${emoji} **${label}:** `;
+    const { emoji, label } = WORK_TYPES_DATA.markers.breaking;
+    return `${emoji} **${label}:** `;
 }
 function allSections() {
-  return true;
+    return true;
 }
 function publicSections(section) {
-  return section.audience === "all";
+    return section.audience === 'all';
 }
-function matchesAudience(audience) {
-  return audience === "dev" ? allSections : publicSections;
+export function matchesAudience(audience) {
+    return audience === 'dev' ? allSections : publicSections;
 }
-function renderReleaseNotesSingle(entry, options) {
-  const filter = options?.filter;
-  const includeHeading = options?.includeHeading ?? true;
-  const sectionOrder = options?.sectionOrder;
-  const filtered = filter !== void 0 ? entry.sections.filter(filter) : entry.sections;
-  const sections = sectionOrder !== void 0 ? sortSectionsByOrder(filtered, sectionOrder) : filtered;
-  if (sections.length === 0) {
-    return "";
-  }
-  const lines = [];
-  if (includeHeading) {
-    lines.push(`## ${entry.version} \u2014 ${entry.date}`);
-  }
-  for (const section of sections) {
-    if (lines.length > 0) {
-      lines.push("");
+export function renderReleaseNotesSingle(entry, options) {
+    const filter = options?.filter;
+    const includeHeading = options?.includeHeading ?? true;
+    const sectionOrder = options?.sectionOrder;
+    const filtered = filter !== undefined ? entry.sections.filter(filter) : entry.sections;
+    const sections = sectionOrder !== undefined ? sortSectionsByOrder(filtered, sectionOrder) : filtered;
+    if (sections.length === 0) {
+        return '';
     }
-    lines.push(`### ${section.title}`, "");
-    for (const [index, item] of section.items.entries()) {
-      const prefix = item.breaking === true ? getBreakingPrefix() : "";
-      lines.push(`- ${prefix}${item.description}`);
-      if (item.body !== void 0 && item.body.length > 0) {
-        lines.push("", ...indentBodyLines(item.body));
-        if (index < section.items.length - 1) {
-          lines.push("");
+    const lines = [];
+    if (includeHeading) {
+        lines.push(`## ${entry.version} — ${entry.date}`);
+    }
+    for (const section of sections) {
+        if (lines.length > 0) {
+            lines.push('');
+        }
+        lines.push(`### ${section.title}`, '');
+        for (const [index, item] of section.items.entries()) {
+            const prefix = item.breaking === true ? getBreakingPrefix() : '';
+            lines.push(`- ${prefix}${item.description}`);
+            if (item.body !== undefined && item.body.length > 0) {
+                lines.push('', ...indentBodyLines(item.body));
+                if (index < section.items.length - 1) {
+                    lines.push('');
+                }
+            }
         }
-      }
     }
-  }
-  return lines.join("\n") + "\n";
+    return lines.join('\n') + '\n';
 }
 function sortSectionsByOrder(sections, order) {
-  const priority = /* @__PURE__ */ new Map();
-  for (const [index, title] of order.entries()) {
-    priority.set(title, index);
-  }
-  const indexed = sections.map((section, index) => ({ section, index }));
-  indexed.sort((a, b) => {
-    const priorityA = priority.get(a.section.title) ?? Number.POSITIVE_INFINITY;
-    const priorityB = priority.get(b.section.title) ?? Number.POSITIVE_INFINITY;
-    if (priorityA !== priorityB) {
-      return priorityA - priorityB;
+    const priority = new Map();
+    for (const [index, title] of order.entries()) {
+        priority.set(title, index);
     }
-    return a.index - b.index;
-  });
-  return indexed.map(({ section }) => section);
+    const indexed = sections.map((section, index) => ({ section, index }));
+    indexed.sort((a, b) => {
+        const priorityA = priority.get(a.section.title) ?? Number.POSITIVE_INFINITY;
+        const priorityB = priority.get(b.section.title) ?? Number.POSITIVE_INFINITY;
+        if (priorityA !== priorityB) {
+            return priorityA - priorityB;
+        }
+        return a.index - b.index;
+    });
+    return indexed.map(({ section }) => section);
 }
 function indentBodyLines(body) {
-  return body.split("\n").map((line) => line.length === 0 ? "" : `  ${line}`);
+    return body.split('\n').map((line) => (line.length === 0 ? '' : `  ${line}`));
 }
-function renderReleaseNotesMulti(entries, options) {
-  const parts = entries.map((entry) => renderReleaseNotesSingle(entry, options)).filter((part) => part.length > 0);
-  return parts.join("\n");
+export function renderReleaseNotesMulti(entries, options) {
+    const parts = entries.map((entry) => renderReleaseNotesSingle(entry, options)).filter((part) => part.length > 0);
+    return parts.join('\n');
 }
-export {
-  matchesAudience,
-  renderReleaseNotesMulti,
-  renderReleaseNotesSingle
-};

package/dist/esm/reportPrepare.d.ts

@@ -1,2 +1,2 @@
-import type { PrepareResult } from './types.ts';
+import type { PrepareResult } from './types.js';
 export declare function reportPrepare(result: PrepareResult): string;