@williamthorsen/release-kit 4.5.1 → 4.7.0

package/dist/esm/sync-labels/generateCommand.d.ts

@@ -1,4 +1,4 @@
 import type { LabelDefinition } from './types.ts';
 export declare const LABELS_OUTPUT_PATH = ".github/labels.yaml";
-export declare function formatLabelsYaml(labels: LabelDefinition[]): string;
+export declare function formatLabelsYaml(labels: LabelDefinition[], presetHashes: Map<string, string>): string;
 export declare function generateCommand(): Promise<number>;

package/dist/esm/sync-labels/generateCommand.js

@@ -2,14 +2,16 @@ import { mkdirSync, writeFileSync } from "node:fs";
 import { dirname } from "node:path";
 import { dump } from "js-yaml";
 import { loadSyncLabelsConfig, SYNC_LABELS_CONFIG_PATH } from "./loadSyncLabelsConfig.js";
+import { hashPresetFile } from "./presets.js";
 import { resolveLabels } from "./resolveLabels.js";
 const LABELS_OUTPUT_PATH = ".github/labels.yaml";
-const GENERATED_HEADER = `# Generated by release-kit sync-labels \u2014 do not edit.
-# Source: ${SYNC_LABELS_CONFIG_PATH}
-`;
-function formatLabelsYaml(labels) {
+function formatLabelsYaml(labels, presetHashes) {
+  const headerLines = ["# Generated by release-kit sync-labels \u2014 do not edit.", `# Source: ${SYNC_LABELS_CONFIG_PATH}`];
+  for (const [name, hash] of [...presetHashes.entries()].sort(([a], [b]) => a.localeCompare(b))) {
+    headerLines.push(`# ${name} preset hash: ${hash}`);
+  }
   const yamlBody = dump(labels, { quotingType: "'", forceQuotes: false, lineWidth: -1 });
-  return GENERATED_HEADER + yamlBody;
+  return headerLines.join("\n") + "\n" + yamlBody;
 }
 async function generateCommand() {
   let config;
@@ -32,7 +34,11 @@ async function generateCommand() {
     console.error(`Error resolving labels: ${message}`);
     return 1;
   }
-  const content = formatLabelsYaml(labels);
+  const presetHashes = /* @__PURE__ */ new Map();
+  for (const presetName of config.presets ?? []) {
+    presetHashes.set(presetName, hashPresetFile(presetName));
+  }
+  const content = formatLabelsYaml(labels, presetHashes);
   try {
     mkdirSync(dirname(LABELS_OUTPUT_PATH), { recursive: true });
     writeFileSync(LABELS_OUTPUT_PATH, content, "utf8");

package/dist/esm/sync-labels/presets.d.ts

@@ -1,2 +1,3 @@
 import type { LabelDefinition } from './types.ts';
+export declare function hashPresetFile(presetName: string): string;
 export declare function loadPreset(presetName: string): LabelDefinition[];

package/dist/esm/sync-labels/presets.js

@@ -1,3 +1,4 @@
+import { createHash } from "node:crypto";
 import { existsSync, readFileSync } from "node:fs";
 import { resolve } from "node:path";
 import { load } from "js-yaml";
@@ -7,6 +8,14 @@ function resolvePresetPath(presetName) {
   const root = findPackageRoot(import.meta.url);
   return resolve(root, "presets", "labels", `${presetName}.yaml`);
 }
+function hashPresetFile(presetName) {
+  const presetPath = resolvePresetPath(presetName);
+  if (!existsSync(presetPath)) {
+    throw new Error(`Unknown preset "${presetName}". No file found at ${presetPath}`);
+  }
+  const content = readFileSync(presetPath, "utf8");
+  return createHash("sha256").update(content).digest("hex");
+}
 function loadPreset(presetName) {
   const presetPath = resolvePresetPath(presetName);
   if (!existsSync(presetPath)) {
@@ -36,5 +45,6 @@ function loadPreset(presetName) {
   return labels;
 }
 export {
+  hashPresetFile,
   loadPreset
 };

package/dist/esm/typeGuards.d.ts

@@ -1 +1,2 @@
 export declare function isRecord(value: unknown): value is Record<string, unknown>;
+export declare function isUnknownArray(value: unknown): value is unknown[];

package/dist/esm/typeGuards.js

@@ -1,6 +1,10 @@
 function isRecord(value) {
   return typeof value === "object" && value !== null && !Array.isArray(value);
 }
+function isUnknownArray(value) {
+  return Array.isArray(value);
+}
 export {
-  isRecord
+  isRecord,
+  isUnknownArray
 };

package/dist/esm/types.d.ts

@@ -1,4 +1,27 @@
 export type ReleaseType = 'major' | 'minor' | 'patch';
+export type ChangelogAudience = 'all' | 'dev';
+export interface ChangelogItem {
+    description: string;
+}
+export interface ChangelogSection {
+    title: string;
+    audience: ChangelogAudience;
+    items: ChangelogItem[];
+}
+export interface ChangelogEntry {
+    version: string;
+    date: string;
+    sections: ChangelogSection[];
+}
+export interface ChangelogJsonConfig {
+    enabled: boolean;
+    outputPath: string;
+    devOnlySections: string[];
+}
+export interface ReleaseNotesConfig {
+    shouldInjectIntoReadme: boolean;
+    shouldCreateGithubRelease: boolean;
+}
 export interface PropagationSource {
     packageName: string;
     newVersion: string;
@@ -51,6 +74,8 @@ export interface ReleaseKitConfig {
     formatCommand?: string;
     cliffConfigPath?: string;
     scopeAliases?: Record<string, string>;
+    changelogJson?: Partial<ChangelogJsonConfig>;
+    releaseNotes?: Partial<ReleaseNotesConfig>;
 }
 export interface ComponentOverride {
     dir: string;
@@ -82,6 +107,8 @@ export interface MonorepoReleaseConfig {
     formatCommand?: string;
     cliffConfigPath?: string;
     scopeAliases?: Record<string, string>;
+    changelogJson: ChangelogJsonConfig;
+    releaseNotes: ReleaseNotesConfig;
 }
 export interface ReleaseConfig {
     tagPrefix: string;
@@ -92,4 +119,6 @@ export interface ReleaseConfig {
     formatCommand?: string;
     cliffConfigPath?: string;
     scopeAliases?: Record<string, string>;
+    changelogJson: ChangelogJsonConfig;
+    releaseNotes: ReleaseNotesConfig;
 }

package/dist/esm/validateConfig.d.ts

@@ -2,4 +2,5 @@ import type { ReleaseKitConfig } from './types.ts';
 export declare function validateConfig(raw: unknown): {
     config: ReleaseKitConfig;
     errors: string[];
+    warnings: string[];
 };

package/dist/esm/validateConfig.js

@@ -2,29 +2,112 @@ import { isRecord } from "./typeGuards.js";
 function validateConfig(raw) {
   const errors = [];
   if (!isRecord(raw)) {
-    return { config: {}, errors: ["Config must be an object"] };
+    return { config: {}, errors: ["Config must be an object"], warnings: [] };
   }
   const config = {};
   const knownFields = /* @__PURE__ */ new Set([
+    "changelogJson",
+    "cliffConfigPath",
     "components",
-    "versionPatterns",
-    "workTypes",
     "formatCommand",
-    "cliffConfigPath",
-    "scopeAliases"
+    "releaseNotes",
+    "scopeAliases",
+    "versionPatterns",
+    "workTypes"
   ]);
   for (const key of Object.keys(raw)) {
     if (!knownFields.has(key)) {
       errors.push(`Unknown field: '${key}'`);
     }
   }
+  validateChangelogJson(raw.changelogJson, config, errors);
   validateComponents(raw.components, config, errors);
+  validateReleaseNotes(raw.releaseNotes, config, errors);
   validateVersionPatterns(raw.versionPatterns, config, errors);
   validateWorkTypes(raw.workTypes, config, errors);
   validateStringField("formatCommand", raw.formatCommand, config, errors);
   validateStringField("cliffConfigPath", raw.cliffConfigPath, config, errors);
   validateScopeAliases(raw.scopeAliases, config, errors);
-  return { config, errors };
+  const warnings = [];
+  const changelogJsonEnabled = config.changelogJson?.enabled ?? true;
+  if (!changelogJsonEnabled) {
+    if (config.releaseNotes?.shouldCreateGithubRelease) {
+      warnings.push(
+        "releaseNotes.shouldCreateGithubRelease is enabled but changelogJson.enabled is false; GitHub Releases will be skipped at runtime"
+      );
+    }
+    if (config.releaseNotes?.shouldInjectIntoReadme) {
+      warnings.push(
+        "releaseNotes.shouldInjectIntoReadme is enabled but changelogJson.enabled is false; README injection will be skipped at runtime"
+      );
+    }
+  }
+  return { config, errors, warnings };
+}
+function validateChangelogJson(value, config, errors) {
+  if (value === void 0) return;
+  if (!isRecord(value)) {
+    errors.push("'changelogJson' must be an object");
+    return;
+  }
+  const knownChangelogJsonFields = /* @__PURE__ */ new Set(["enabled", "outputPath", "devOnlySections"]);
+  for (const key of Object.keys(value)) {
+    if (!knownChangelogJsonFields.has(key)) {
+      errors.push(`changelogJson: unknown field '${key}'`);
+    }
+  }
+  const result = {};
+  if (value.enabled !== void 0) {
+    if (typeof value.enabled === "boolean") {
+      result.enabled = value.enabled;
+    } else {
+      errors.push("changelogJson.enabled: must be a boolean");
+    }
+  }
+  if (value.outputPath !== void 0) {
+    if (typeof value.outputPath === "string") {
+      result.outputPath = value.outputPath;
+    } else {
+      errors.push("changelogJson.outputPath: must be a string");
+    }
+  }
+  if (value.devOnlySections !== void 0) {
+    if (isStringArray(value.devOnlySections)) {
+      result.devOnlySections = value.devOnlySections;
+    } else {
+      errors.push("changelogJson.devOnlySections: must be a string array");
+    }
+  }
+  config.changelogJson = result;
+}
+function validateReleaseNotes(value, config, errors) {
+  if (value === void 0) return;
+  if (!isRecord(value)) {
+    errors.push("'releaseNotes' must be an object");
+    return;
+  }
+  const knownReleaseNotesFields = /* @__PURE__ */ new Set(["shouldInjectIntoReadme", "shouldCreateGithubRelease"]);
+  for (const key of Object.keys(value)) {
+    if (!knownReleaseNotesFields.has(key)) {
+      errors.push(`releaseNotes: unknown field '${key}'`);
+    }
+  }
+  const result = {};
+  if (value.shouldInjectIntoReadme !== void 0) {
+    if (typeof value.shouldInjectIntoReadme === "boolean") {
+      result.shouldInjectIntoReadme = value.shouldInjectIntoReadme;
+    } else {
+      errors.push("releaseNotes.shouldInjectIntoReadme: must be a boolean");
+    }
+  }
+  if (value.shouldCreateGithubRelease !== void 0) {
+    if (typeof value.shouldCreateGithubRelease === "boolean") {
+      result.shouldCreateGithubRelease = value.shouldCreateGithubRelease;
+    } else {
+      errors.push("releaseNotes.shouldCreateGithubRelease: must be a boolean");
+    }
+  }
+  config.releaseNotes = result;
 }
 function isStringArray(value) {
   return Array.isArray(value) && value.every((item) => typeof item === "string");

package/dist/esm/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = "4.5.1";
+export declare const VERSION = "4.7.0";

package/dist/esm/version.js

@@ -1,4 +1,4 @@
-const VERSION = "4.5.1";
+const VERSION = "4.7.0";
 export {
   VERSION
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@williamthorsen/release-kit",
-  "version": "4.5.1",
+  "version": "4.7.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",
@@ -12,7 +12,7 @@
     "url": "https://github.com/williamthorsen/node-monorepo-tools.git",
     "directory": "packages/release-kit"
   },
-  "license": "UNLICENSED",
+  "license": "ISC",
   "author": "William Thorsen <william@thorsen.dev> (https://github.com/williamthorsen)",
   "type": "module",
   "exports": {
@@ -34,7 +34,8 @@
     "glob": "13.0.6",
     "jiti": "2.6.1",
     "js-yaml": "4.1.1",
-    "@williamthorsen/node-monorepo-core": "0.2.5"
+    "json-stringify-pretty-compact": "4.0.0",
+    "@williamthorsen/node-monorepo-core": "0.2.6"
   },
   "devDependencies": {
     "@types/js-yaml": "4.0.9",

package/presets/labels/common.yaml

@@ -11,9 +11,21 @@
 - name: documentation
   color: a2eeef
   description: Improvements or additions to documentation
+- name: deprecation
+  color: fbca04
+  description: Marks functionality for future removal
 - name: feature
   color: '0075ca'
   description: Added or improved external functionality
+- name: fix
+  color: d73a4a
+  description: Fixes a bug
+- name: performance
+  color: '0075ca'
+  description: Improves performance without changing behavior
+- name: security
+  color: b60205
+  description: Security vulnerability or hardening
 - name: spike
   color: '000000'
   description: Investigation
@@ -30,6 +42,9 @@
   description: Further information is needed
 
 # Refactoring
+- name: ci
+  color: edc287
+  description: CI/CD tooling & configuration
 - name: dependencies
   color: edc287
   description: Change to dependencies
@@ -46,6 +61,34 @@
   color: 1d76db
   description: Changed internal functionality
 
+# Priority
+- name: 'priority:critical'
+  color: b60205
+  description: Demands immediate attention
+- name: 'priority:high'
+  color: d93f0b
+  description: Address soon
+- name: 'priority:medium'
+  color: fbca04
+  description: No rush but don't forget
+- name: 'priority:low'
+  color: cfd3d7
+  description: Get to it eventually
+
+# Value
+- name: 'value:must-have'
+  color: 7057ff
+  description: Essential for the application to fulfill its purpose
+- name: 'value:should-have'
+  color: 8d83fc
+  description: Important but the application is usable without it
+- name: 'value:nice-to-have'
+  color: a8b2f8
+  description: A nice-to-have enhancement
+- name: 'value:questionable'
+  color: c5def5
+  description: Decision needed on whether this would add sufficient value
+
 # Triage
 - name: duplicate
   color: cfd3d7

package/dist/esm/init/prompt.d.ts

@@ -1,4 +0,0 @@
-export declare function printStep(message: string): void;
-export declare function printSuccess(message: string): void;
-export declare function printSkip(message: string): void;
-export declare function printError(message: string): void;

package/dist/esm/init/prompt.js

@@ -1,19 +0,0 @@
-function printStep(message) {
-  console.info(`
-> ${message}`);
-}
-function printSuccess(message) {
-  console.info(`  \u2705 ${message}`);
-}
-function printSkip(message) {
-  console.info(`  \u26A0\uFE0F ${message}`);
-}
-function printError(message) {
-  console.error(`  \u274C ${message}`);
-}
-export {
-  printError,
-  printSkip,
-  printStep,
-  printSuccess
-};

package/dist/esm/runReleasePrepare.d.ts

@@ -1,10 +0,0 @@
-import type { MonorepoReleaseConfig, ReleaseConfig, ReleaseType } from './types.ts';
-export declare const RELEASE_TAGS_FILE = "tmp/.release-tags";
-export declare function parseArgs(argv: string[]): {
-    dryRun: boolean;
-    force: boolean;
-    bumpOverride: ReleaseType | undefined;
-    only: string[] | undefined;
-};
-export declare function runReleasePrepare(config: MonorepoReleaseConfig | ReleaseConfig): void;
-export declare function writeReleaseTags(tags: string[], dryRun: boolean): void;

package/dist/esm/runReleasePrepare.js

@@ -1,125 +0,0 @@
-import { mkdirSync, writeFileSync } from "node:fs";
-import { dirname } from "node:path";
-import { dim } from "./format.js";
-import { releasePrepare } from "./releasePrepare.js";
-import { releasePrepareMono } from "./releasePrepareMono.js";
-const RELEASE_TAGS_FILE = "tmp/.release-tags";
-const VALID_BUMP_TYPES = ["major", "minor", "patch"];
-function isReleaseType(value) {
-  return VALID_BUMP_TYPES.includes(value);
-}
-function isMonorepoConfig(config) {
-  return "components" in config;
-}
-function showHelp() {
-  console.info(`
-Usage: runReleasePrepare [options]
-
-Legacy entry point for release preparation. Prefer the CLI:
-  npx @williamthorsen/release-kit prepare
-
-Options:
-  --dry-run             Run without modifying any files
-  --bump=major|minor|patch  Override the bump type for all components
-  --force               Bypass the "no commits since last tag" check (monorepo only, requires --bump)
-  --only=name1,name2    Only process the named components (comma-separated, monorepo only)
-  --help                Show this help message
-`);
-}
-function parseArgs(argv) {
-  let dryRun = false;
-  let force = false;
-  let bumpOverride;
-  let only;
-  for (const arg of argv) {
-    if (arg === "--dry-run") {
-      dryRun = true;
-    } else if (arg === "--force") {
-      force = true;
-    } else if (arg.startsWith("--bump=")) {
-      const value = arg.slice("--bump=".length);
-      if (!isReleaseType(value)) {
-        console.error(`Error: Invalid bump type "${value}". Must be one of: ${VALID_BUMP_TYPES.join(", ")}`);
-        process.exit(1);
-      }
-      bumpOverride = value;
-    } else if (arg.startsWith("--only=")) {
-      const value = arg.slice("--only=".length);
-      if (!value) {
-        console.error("Error: --only requires a comma-separated list of component names");
-        process.exit(1);
-      }
-      only = value.split(",");
-    } else if (arg === "--help" || arg === "-h") {
-      showHelp();
-      process.exit(0);
-    } else {
-      console.error(`Error: Unknown argument: ${arg}`);
-      process.exit(1);
-    }
-  }
-  if (force && bumpOverride === void 0) {
-    console.error("Error: --force requires --bump to specify the version bump type");
-    process.exit(1);
-  }
-  return { dryRun, force, bumpOverride, only };
-}
-function runReleasePrepare(config) {
-  const { dryRun, force, bumpOverride, only } = parseArgs(process.argv.slice(2));
-  const options = {
-    dryRun,
-    force,
-    ...bumpOverride === void 0 ? {} : { bumpOverride }
-  };
-  if (!isMonorepoConfig(config)) {
-    if (only !== void 0) {
-      console.error("Error: --only is only supported for monorepo configurations");
-      process.exit(1);
-    }
-    try {
-      const tags = releasePrepare(config, options);
-      writeReleaseTags(tags, dryRun);
-    } catch (error) {
-      console.error("Error preparing release:", error instanceof Error ? error.message : String(error));
-      process.exit(1);
-    }
-    return;
-  }
-  let effectiveConfig = config;
-  if (only !== void 0) {
-    const knownNames = config.components.map((c) => c.dir);
-    for (const name of only) {
-      if (!knownNames.includes(name)) {
-        console.error(`Error: Unknown component "${name}". Known components: ${knownNames.join(", ")}`);
-        process.exit(1);
-      }
-    }
-    const filtered = config.components.filter((c) => only.includes(c.dir));
-    effectiveConfig = { ...config, components: filtered };
-  }
-  try {
-    const tags = releasePrepareMono(effectiveConfig, options);
-    writeReleaseTags(tags, dryRun);
-  } catch (error) {
-    console.error("Error preparing release:", error instanceof Error ? error.message : String(error));
-    process.exit(1);
-  }
-}
-function writeReleaseTags(tags, dryRun) {
-  if (tags.length === 0) {
-    return;
-  }
-  if (dryRun) {
-    console.info(dim(`  [dry-run] Would write ${RELEASE_TAGS_FILE}: ${tags.join(" ")}`));
-    return;
-  }
-  mkdirSync(dirname(RELEASE_TAGS_FILE), { recursive: true });
-  writeFileSync(RELEASE_TAGS_FILE, tags.join("\n"), "utf8");
-  console.info(dim(`  Wrote ${RELEASE_TAGS_FILE}: ${tags.join(" ")}`));
-}
-export {
-  RELEASE_TAGS_FILE,
-  parseArgs,
-  runReleasePrepare,
-  writeReleaseTags
-};

package/dist/esm/sync-labels/scaffold.d.ts

@@ -1,6 +0,0 @@
-interface WriteResult {
-    action: 'created' | 'skipped' | 'dry-run' | 'failed';
-    filePath: string;
-}
-export declare function writeIfAbsent(filePath: string, content: string, dryRun: boolean, overwrite: boolean): WriteResult;
-export {};

package/dist/esm/sync-labels/scaffold.js

@@ -1,25 +0,0 @@
-import { existsSync, mkdirSync, writeFileSync } from "node:fs";
-import { dirname } from "node:path";
-function writeIfAbsent(filePath, content, dryRun, overwrite) {
-  if (existsSync(filePath) && !overwrite) {
-    console.info(`  Skipped ${filePath} (already exists)`);
-    return { action: "skipped", filePath };
-  }
-  if (dryRun) {
-    console.info(`  [dry-run] Would create ${filePath}`);
-    return { action: "dry-run", filePath };
-  }
-  try {
-    mkdirSync(dirname(filePath), { recursive: true });
-    writeFileSync(filePath, content, "utf8");
-  } catch (error) {
-    const message = error instanceof Error ? error.message : String(error);
-    console.error(`  Failed to write ${filePath}: ${message}`);
-    return { action: "failed", filePath };
-  }
-  console.info(`  Created ${filePath}`);
-  return { action: "created", filePath };
-}
-export {
-  writeIfAbsent
-};