@williamthorsen/release-kit 6.0.0 → 8.0.0

package/dist/esm/validateOverridesCommand.js

@@ -1,137 +1,136 @@
-import { formatErrorLine } from "@williamthorsen/nmr-core";
+import { formatErrorLine } from '@williamthorsen/nmr-core';
 import { buildChangelogEntries } from "./buildChangelogEntries.js";
-import {
-  resolveOverridePath,
-  validateAllChangelogOverrides
-} from "./changelogOverrides.js";
+import { resolveOverridePath, validateAllChangelogOverrides, } from "./changelogOverrides.js";
 import { discoverWorkspaces } from "./discoverWorkspaces.js";
 import { buildTagPattern, getAllTagPrefixes } from "./generateChangelogs.js";
 import { loadConfig, mergeMonorepoConfig, mergeSinglePackageConfig, readRootPackageVersion } from "./loadConfig.js";
 import { validateConfig } from "./validateConfig.js";
-const SYNTHETIC_VALIDATE_TAG = "validate-only";
-async function validateOverridesCommand(dependencies = {}) {
-  const discover = dependencies.discoverWorkspaces ?? discoverWorkspaces;
-  const load = dependencies.loadConfig ?? loadConfig;
-  const buildEntries = dependencies.buildEntries ?? defaultBuildEntries;
-  const validate = dependencies.validate ?? validateAllChangelogOverrides;
-  let rawConfig;
-  try {
-    rawConfig = await load();
-  } catch (error) {
-    return { exitCode: 2, message: formatErrorLine(`Failed to load config: ${errorMessage(error)}`) };
-  }
-  let userConfig;
-  try {
-    userConfig = validateLoadedConfig(rawConfig);
-  } catch (error) {
-    return { exitCode: 2, message: errorMessage(error) };
-  }
-  let discoveredPaths;
-  try {
-    discoveredPaths = await discover();
-  } catch (error) {
-    return { exitCode: 2, message: formatErrorLine(`Failed to discover workspaces: ${errorMessage(error)}`) };
-  }
-  let inputs;
-  try {
-    inputs = discoveredPaths === void 0 ? buildSinglePackageInputs(userConfig, buildEntries) : buildMonorepoInputs(discoveredPaths, userConfig, buildEntries);
-  } catch (error) {
-    return { exitCode: 2, message: formatErrorLine(`Failed to resolve overrides scope: ${errorMessage(error)}`) };
-  }
-  const result = validate(inputs);
-  return formatValidateOverridesResult(result);
+const SYNTHETIC_VALIDATE_TAG = 'validate-only';
+export async function validateOverridesCommand(dependencies = {}) {
+    const discover = dependencies.discoverWorkspaces ?? discoverWorkspaces;
+    const load = dependencies.loadConfig ?? loadConfig;
+    const buildEntries = dependencies.buildEntries ?? defaultBuildEntries;
+    const validate = dependencies.validate ?? validateAllChangelogOverrides;
+    let rawConfig;
+    try {
+        rawConfig = await load();
+    }
+    catch (error) {
+        return { exitCode: 2, message: formatErrorLine(`Failed to load config: ${errorMessage(error)}`) };
+    }
+    let userConfig;
+    try {
+        userConfig = validateLoadedConfig(rawConfig);
+    }
+    catch (error) {
+        return { exitCode: 2, message: errorMessage(error) };
+    }
+    let discoveredPaths;
+    try {
+        discoveredPaths = await discover();
+    }
+    catch (error) {
+        return { exitCode: 2, message: formatErrorLine(`Failed to discover workspaces: ${errorMessage(error)}`) };
+    }
+    let inputs;
+    try {
+        inputs =
+            discoveredPaths === undefined
+                ? buildSinglePackageInputs(userConfig, buildEntries)
+                : buildMonorepoInputs(discoveredPaths, userConfig, buildEntries);
+    }
+    catch (error) {
+        return { exitCode: 2, message: formatErrorLine(`Failed to resolve overrides scope: ${errorMessage(error)}`) };
+    }
+    const result = validate(inputs);
+    return formatValidateOverridesResult(result);
 }
-function formatValidateOverridesResult(result) {
-  const { errors, warnings } = result;
-  if (errors.length === 0 && warnings.length === 0) {
-    return { exitCode: 0, message: "All override files are valid (no errors, no stale keys)." };
-  }
-  const exitCode = errors.length > 0 ? 2 : 1;
-  const summary = formatSummaryLine(errors.length, warnings.length);
-  const errorLines = errors.map((message2) => `  \u274C ${message2}`);
-  const warningLines = warnings.map((message2) => `  \u26A0\uFE0F  ${message2}`);
-  const message = [summary, "", ...errorLines, ...warningLines].join("\n");
-  return { exitCode, message };
+export function formatValidateOverridesResult(result) {
+    const { errors, warnings } = result;
+    if (errors.length === 0 && warnings.length === 0) {
+        return { exitCode: 0, message: 'All override files are valid (no errors, no stale keys).' };
+    }
+    const exitCode = errors.length > 0 ? 2 : 1;
+    const summary = formatSummaryLine(errors.length, warnings.length);
+    const errorLines = errors.map((message) => `  ❌ ${message}`);
+    const warningLines = warnings.map((message) => `  ⚠️  ${message}`);
+    const message = [summary, '', ...errorLines, ...warningLines].join('\n');
+    return { exitCode, message };
 }
 function formatSummaryLine(errorCount, warningCount) {
-  const parts = [];
-  if (errorCount > 0) {
-    parts.push(pluralize(errorCount, "error"));
-  }
-  if (warningCount > 0) {
-    parts.push(pluralize(warningCount, "warning"));
-  }
-  return `Found ${parts.join(" and ")}:`;
+    const parts = [];
+    if (errorCount > 0) {
+        parts.push(pluralize(errorCount, 'error'));
+    }
+    if (warningCount > 0) {
+        parts.push(pluralize(warningCount, 'warning'));
+    }
+    return `Found ${parts.join(' and ')}:`;
 }
 function pluralize(count, noun) {
-  return count === 1 ? `${count} ${noun}` : `${count} ${noun}s`;
+    return count === 1 ? `${count} ${noun}` : `${count} ${noun}s`;
 }
 function errorMessage(error) {
-  return error instanceof Error ? error.message : String(error);
+    return error instanceof Error ? error.message : String(error);
 }
 function defaultBuildEntries(config, tagPattern, includePaths) {
-  const options = {};
-  if (tagPattern !== void 0) {
-    options.tagPattern = tagPattern;
-  }
-  if (includePaths !== void 0) {
-    options.includePaths = includePaths;
-  }
-  return buildChangelogEntries(config, SYNTHETIC_VALIDATE_TAG, options);
+    const options = {};
+    if (tagPattern !== undefined) {
+        options.tagPattern = tagPattern;
+    }
+    if (includePaths !== undefined) {
+        options.includePaths = includePaths;
+    }
+    return buildChangelogEntries(config, SYNTHETIC_VALIDATE_TAG, options);
 }
 function flattenEntriesToHashes(entries) {
-  const hashes = [];
-  for (const entry of entries) {
-    for (const section of entry.sections) {
-      for (const item of section.items) {
-        if (item.hash !== void 0) {
-          hashes.push(item.hash);
+    const hashes = [];
+    for (const entry of entries) {
+        for (const section of entry.sections) {
+            for (const item of section.items) {
+                if (item.hash !== undefined) {
+                    hashes.push(item.hash);
+                }
+            }
         }
-      }
     }
-  }
-  return hashes;
+    return hashes;
 }
 function validateLoadedConfig(rawConfig) {
-  if (rawConfig === void 0) {
-    return void 0;
-  }
-  const { config, errors } = validateConfig(rawConfig);
-  if (errors.length > 0) {
-    throw new Error(`Invalid config:
-  - ${errors.join("\n  - ")}`);
-  }
-  return config;
+    if (rawConfig === undefined) {
+        return undefined;
+    }
+    const { config, errors } = validateConfig(rawConfig);
+    if (errors.length > 0) {
+        throw new Error(`Invalid config:\n  - ${errors.join('\n  - ')}`);
+    }
+    return config;
 }
 function buildSinglePackageInputs(userConfig, buildEntries) {
-  const config = mergeSinglePackageConfig(userConfig);
-  const hashes = flattenEntriesToHashes(buildEntries(config));
-  return {
-    project: { filePath: resolveOverridePath("."), hashes }
-  };
+    const config = mergeSinglePackageConfig(userConfig);
+    const hashes = flattenEntriesToHashes(buildEntries(config));
+    return {
+        project: { filePath: resolveOverridePath('.'), hashes },
+    };
 }
 function buildMonorepoInputs(discoveredPaths, userConfig, buildEntries) {
-  const rootPackage = readRootPackageVersion();
-  const config = mergeMonorepoConfig(discoveredPaths, userConfig, rootPackage);
-  const workspaces = config.workspaces.map((workspace) => {
-    const tagPattern = buildTagPattern(getAllTagPrefixes(workspace));
-    return {
-      filePath: resolveOverridePath(workspace.workspacePath),
-      hashes: flattenEntriesToHashes(buildEntries(config, tagPattern, workspace.paths))
+    const rootPackage = readRootPackageVersion();
+    const config = mergeMonorepoConfig(discoveredPaths, userConfig, rootPackage);
+    const workspaces = config.workspaces.map((workspace) => {
+        const tagPattern = buildTagPattern(getAllTagPrefixes(workspace));
+        return {
+            filePath: resolveOverridePath(workspace.workspacePath),
+            hashes: flattenEntriesToHashes(buildEntries(config, tagPattern, workspace.paths)),
+        };
+    });
+    const project = config.project;
+    const projectScope = {
+        filePath: resolveOverridePath('.'),
     };
-  });
-  const project = config.project;
-  const projectScope = {
-    filePath: resolveOverridePath(".")
-  };
-  if (project !== void 0) {
-    const contributingPaths = config.workspaces.flatMap((workspace) => workspace.paths);
-    const projectTagPattern = buildTagPattern([project.tagPrefix]);
-    projectScope.hashes = flattenEntriesToHashes(buildEntries(config, projectTagPattern, contributingPaths));
-  }
-  return { project: projectScope, workspaces };
+    if (project !== undefined) {
+        const contributingPaths = config.workspaces.flatMap((workspace) => workspace.paths);
+        const projectTagPattern = buildTagPattern([project.tagPrefix]);
+        projectScope.hashes = flattenEntriesToHashes(buildEntries(config, projectTagPattern, contributingPaths));
+    }
+    return { project: projectScope, workspaces };
 }
-export {
-  formatValidateOverridesResult,
-  validateOverridesCommand
-};

package/dist/esm/workTypesData.js

@@ -1,62 +1,59 @@
-const WORK_TYPES_DATA = {
-  tiers: ["public", "internal", "process"],
-  types: [
-    { tier: "public", key: "feat", aliases: ["feature"], emoji: "\u{1F389}", label: "Features", breakingPolicy: "optional" },
-    { tier: "public", key: "drop", aliases: [], emoji: "\u{1FAA6}", label: "Removed", breakingPolicy: "required" },
-    { tier: "public", key: "deprecate", aliases: [], emoji: "\u{1F5D1}\uFE0F", label: "Deprecated", breakingPolicy: "forbidden" },
-    { tier: "public", key: "fix", aliases: ["bugfix"], emoji: "\u{1F41B}", label: "Bug fixes", breakingPolicy: "forbidden" },
-    { tier: "public", key: "sec", aliases: ["security"], emoji: "\u{1F512}", label: "Security", breakingPolicy: "optional" },
-    {
-      tier: "public",
-      key: "perf",
-      aliases: ["performance"],
-      emoji: "\u26A1",
-      label: "Performance",
-      breakingPolicy: "forbidden"
+export const WORK_TYPES_DATA = {
+    tiers: ['public', 'internal', 'process'],
+    types: [
+        { tier: 'public', key: 'feat', aliases: ['feature'], emoji: '🎉', label: 'Features', breakingPolicy: 'optional' },
+        { tier: 'public', key: 'drop', aliases: [], emoji: '🪦', label: 'Removed', breakingPolicy: 'required' },
+        { tier: 'public', key: 'deprecate', aliases: [], emoji: '🗑️', label: 'Deprecated', breakingPolicy: 'forbidden' },
+        { tier: 'public', key: 'fix', aliases: ['bugfix'], emoji: '🐛', label: 'Bug fixes', breakingPolicy: 'forbidden' },
+        { tier: 'public', key: 'sec', aliases: ['security'], emoji: '🔒', label: 'Security', breakingPolicy: 'optional' },
+        {
+            tier: 'public',
+            key: 'perf',
+            aliases: ['performance'],
+            emoji: '⚡',
+            label: 'Performance',
+            breakingPolicy: 'forbidden',
+        },
+        {
+            tier: 'internal',
+            key: 'internal',
+            aliases: ['utility'],
+            emoji: '🏗️',
+            label: 'Internal features',
+            breakingPolicy: 'forbidden',
+        },
+        {
+            tier: 'internal',
+            key: 'refactor',
+            aliases: [],
+            emoji: '♻️',
+            label: 'Refactoring',
+            breakingPolicy: 'forbidden',
+        },
+        { tier: 'internal', key: 'tests', aliases: ['test'], emoji: '🧪', label: 'Tests', breakingPolicy: 'forbidden' },
+        { tier: 'process', key: 'tooling', aliases: [], emoji: '⚙️', label: 'Tooling', breakingPolicy: 'forbidden' },
+        { tier: 'process', key: 'ci', aliases: [], emoji: '👷', label: 'CI', breakingPolicy: 'forbidden' },
+        { tier: 'process', key: 'deps', aliases: ['dep'], emoji: '📦', label: 'Dependencies', breakingPolicy: 'forbidden' },
+        { tier: 'process', key: 'ai', aliases: [], emoji: '🤖', label: 'Agentic support', breakingPolicy: 'forbidden' },
+        {
+            tier: 'process',
+            key: 'docs',
+            aliases: ['doc'],
+            emoji: '📚',
+            label: 'Documentation',
+            breakingPolicy: 'forbidden',
+        },
+        {
+            tier: 'process',
+            key: 'fmt',
+            aliases: [],
+            emoji: '🎨',
+            label: 'Formatting',
+            breakingPolicy: 'forbidden',
+            excludedFromChangelog: true,
+        },
+    ],
+    markers: {
+        breaking: { emoji: '🚨', label: 'Breaking' },
     },
-    {
-      tier: "internal",
-      key: "internal",
-      aliases: ["utility"],
-      emoji: "\u{1F3D7}\uFE0F",
-      label: "Internal features",
-      breakingPolicy: "forbidden"
-    },
-    {
-      tier: "internal",
-      key: "refactor",
-      aliases: [],
-      emoji: "\u267B\uFE0F",
-      label: "Refactoring",
-      breakingPolicy: "forbidden"
-    },
-    { tier: "internal", key: "tests", aliases: ["test"], emoji: "\u{1F9EA}", label: "Tests", breakingPolicy: "forbidden" },
-    { tier: "process", key: "tooling", aliases: [], emoji: "\u2699\uFE0F", label: "Tooling", breakingPolicy: "forbidden" },
-    { tier: "process", key: "ci", aliases: [], emoji: "\u{1F477}", label: "CI", breakingPolicy: "forbidden" },
-    { tier: "process", key: "deps", aliases: ["dep"], emoji: "\u{1F4E6}", label: "Dependencies", breakingPolicy: "forbidden" },
-    { tier: "process", key: "ai", aliases: [], emoji: "\u{1F916}", label: "Agentic support", breakingPolicy: "forbidden" },
-    {
-      tier: "process",
-      key: "docs",
-      aliases: ["doc"],
-      emoji: "\u{1F4DA}",
-      label: "Documentation",
-      breakingPolicy: "forbidden"
-    },
-    {
-      tier: "process",
-      key: "fmt",
-      aliases: [],
-      emoji: "\u{1F3A8}",
-      label: "Formatting",
-      breakingPolicy: "forbidden",
-      excludedFromChangelog: true
-    }
-  ],
-  markers: {
-    breaking: { emoji: "\u{1F6A8}", label: "Breaking" }
-  }
-};
-export {
-  WORK_TYPES_DATA
 };

package/dist/esm/workTypesUtils.js

@@ -1,24 +1,19 @@
-function hasExpectedTopLevelShape(value) {
-  if (typeof value !== "object" || value === null) {
-    return false;
-  }
-  if (!("tiers" in value) || !("types" in value)) {
-    return false;
-  }
-  return Array.isArray(value.tiers) && Array.isArray(value.types);
+export function hasExpectedTopLevelShape(value) {
+    if (typeof value !== 'object' || value === null) {
+        return false;
+    }
+    if (!('tiers' in value) || !('types' in value)) {
+        return false;
+    }
+    return Array.isArray(value.tiers) && Array.isArray(value.types);
 }
-function errorMessage(error) {
-  return error instanceof Error ? error.message : String(error);
+export function errorMessage(error) {
+    return error instanceof Error ? error.message : String(error);
 }
-function buildFetchInit() {
-  const token = process.env.GITHUB_TOKEN;
-  if (token === void 0 || token === "") {
-    return void 0;
-  }
-  return { headers: { Authorization: `Bearer ${token}` } };
+export function buildFetchInit() {
+    const token = process.env.GITHUB_TOKEN;
+    if (token === undefined || token === '') {
+        return undefined;
+    }
+    return { headers: { Authorization: `Bearer ${token}` } };
 }
-export {
-  buildFetchInit,
-  errorMessage,
-  hasExpectedTopLevelShape
-};

package/dist/esm/writeReleaseNotesPreviews.js

@@ -1,65 +1,63 @@
-import { existsSync, readFileSync } from "node:fs";
-import path from "node:path";
-import { reportError, writeFileWithCheck } from "@williamthorsen/nmr-core";
+import { existsSync, readFileSync } from 'node:fs';
+import path from 'node:path';
+import { reportError, writeFileWithCheck } from '@williamthorsen/nmr-core';
 import { extractVersion } from "./changelogJsonUtils.js";
 import { dim } from "./format.js";
 import { renderInjectedReadme } from "./injectReleaseNotesIntoReadme.js";
-function writeReleaseNotesPreviews(options) {
-  const { workspacePath, tag, changelogJsonPath, sectionOrder, dryRun } = options;
-  const version = extractVersion(tag);
-  const readmePath = path.join(workspacePath, "README.md");
-  let readmeExists = existsSync(readmePath);
-  let readmeUnreadable = false;
-  let readmeContent = "";
-  if (readmeExists) {
-    try {
-      readmeContent = readFileSync(readmePath, "utf8");
-    } catch (error) {
-      const message = error instanceof Error ? error.message : String(error);
-      console.warn(`Warning: failed to read ${readmePath}: ${message}; skipping injected-README preview`);
-      readmeExists = false;
-      readmeUnreadable = true;
+export function writeReleaseNotesPreviews(options) {
+    const { workspacePath, tag, changelogJsonPath, sectionOrder, dryRun } = options;
+    const version = extractVersion(tag);
+    const readmePath = path.join(workspacePath, 'README.md');
+    let readmeExists = existsSync(readmePath);
+    let readmeUnreadable = false;
+    let readmeContent = '';
+    if (readmeExists) {
+        try {
+            readmeContent = readFileSync(readmePath, 'utf8');
+        }
+        catch (error) {
+            const message = error instanceof Error ? error.message : String(error);
+            console.warn(`Warning: failed to read ${readmePath}: ${message}; skipping injected-README preview`);
+            readmeExists = false;
+            readmeUnreadable = true;
+        }
     }
-  }
-  const rendered = renderInjectedReadme(readmeContent, changelogJsonPath, tag, sectionOrder);
-  if (rendered === void 0) {
-    return { renderSkipped: true };
-  }
-  const docsDir = path.join(workspacePath, "docs");
-  const readmePreviewPath = path.join(docsDir, `README.v${version}.md`);
-  const releaseNotesPreviewPath = path.join(docsDir, `RELEASE_NOTES.v${version}.md`);
-  let injectedReadme;
-  if (readmeExists) {
-    injectedReadme = writePreviewFile(readmePreviewPath, rendered.injectedReadme, dryRun);
-  } else {
-    if (!readmeUnreadable) {
-      console.warn(
-        `Warning: ${readmePath} not found; skipping injected-README preview but still writing standalone release notes`
-      );
+    const rendered = renderInjectedReadme(readmeContent, changelogJsonPath, tag, sectionOrder);
+    if (rendered === undefined) {
+        return { renderSkipped: true };
     }
-    injectedReadme = { filePath: readmePreviewPath, outcome: "skipped-no-readme" };
-  }
-  const releaseNotesContent = rendered.releaseNotesMarkdown.endsWith("\n") ? rendered.releaseNotesMarkdown : `${rendered.releaseNotesMarkdown}
-`;
-  const releaseNotes = writePreviewFile(releaseNotesPreviewPath, releaseNotesContent, dryRun);
-  return { injectedReadme, releaseNotes, renderSkipped: false };
+    const docsDir = path.join(workspacePath, 'docs');
+    const readmePreviewPath = path.join(docsDir, `README.v${version}.md`);
+    const releaseNotesPreviewPath = path.join(docsDir, `RELEASE_NOTES.v${version}.md`);
+    let injectedReadme;
+    if (readmeExists) {
+        injectedReadme = writePreviewFile(readmePreviewPath, rendered.injectedReadme, dryRun);
+    }
+    else {
+        if (!readmeUnreadable) {
+            console.warn(`Warning: ${readmePath} not found; skipping injected-README preview but still writing standalone release notes`);
+        }
+        injectedReadme = { filePath: readmePreviewPath, outcome: 'skipped-no-readme' };
+    }
+    const releaseNotesContent = rendered.releaseNotesMarkdown.endsWith('\n')
+        ? rendered.releaseNotesMarkdown
+        : `${rendered.releaseNotesMarkdown}\n`;
+    const releaseNotes = writePreviewFile(releaseNotesPreviewPath, releaseNotesContent, dryRun);
+    return { injectedReadme, releaseNotes, renderSkipped: false };
 }
 function writePreviewFile(filePath, content, dryRun) {
-  if (dryRun) {
-    console.info(dim(`  [dry-run] Would write ${filePath}`));
-    return { filePath, outcome: "dry-run" };
-  }
-  const result = writeFileWithCheck(filePath, content, { dryRun: false, overwrite: true });
-  if (result.outcome === "failed") {
-    reportError(`Failed to write ${filePath}: ${result.error ?? "unknown error"}`);
-    return { filePath, outcome: "failed", ...result.error === void 0 ? {} : { error: result.error } };
-  }
-  if (result.outcome === "created" || result.outcome === "overwritten") {
-    console.info(dim(`  Wrote ${filePath}`));
-    return { filePath, outcome: result.outcome };
-  }
-  return { filePath, outcome: "failed", error: `unexpected outcome: ${result.outcome}` };
+    if (dryRun) {
+        console.info(dim(`  [dry-run] Would write ${filePath}`));
+        return { filePath, outcome: 'dry-run' };
+    }
+    const result = writeFileWithCheck(filePath, content, { dryRun: false, overwrite: true });
+    if (result.outcome === 'failed') {
+        reportError(`Failed to write ${filePath}: ${result.error ?? 'unknown error'}`);
+        return { filePath, outcome: 'failed', ...(result.error === undefined ? {} : { error: result.error }) };
+    }
+    if (result.outcome === 'created' || result.outcome === 'overwritten') {
+        console.info(dim(`  Wrote ${filePath}`));
+        return { filePath, outcome: result.outcome };
+    }
+    return { filePath, outcome: 'failed', error: `unexpected outcome: ${result.outcome}` };
 }
-export {
-  writeReleaseNotesPreviews
-};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@williamthorsen/release-kit",
-  "version": "6.0.0",
+  "version": "8.0.0",
   "description": "Version-bumping and changelog-generation toolkit for release workflows",
   "keywords": [],
   "homepage": "https://github.com/williamthorsen/node-monorepo-tools/tree/main/packages/release-kit#readme",
@@ -17,6 +17,7 @@
   "type": "module",
   "exports": {
     ".": {
+      "types": "./dist/esm/index.d.ts",
       "import": "./dist/esm/index.js"
     }
   },
@@ -38,7 +39,7 @@
     "semver": "7.8.5",
     "yaml": "2.9.0",
     "zod": "4.4.3",
-    "@williamthorsen/nmr-core": "0.5.0"
+    "@williamthorsen/nmr-core": "0.7.0"
   },
   "devDependencies": {
     "@types/semver": "7.7.1",

package/dist/esm/.cache

@@ -1 +0,0 @@
-5ed41ffb0267b5678fc3b3273d6104a1c1c120fea20f92d48e173aee3ae9e2f5