@williamthorsen/release-kit 10.7.0 → 10.9.0

package/dist/esm/createGithubReleaseCommand.js

@@ -9,7 +9,7 @@ const createGithubReleaseFlagSchema = {
     dryRun: { long: '--dry-run', type: 'boolean' },
     tags: { long: '--tags', type: 'string' },
 };
-export async function createGithubReleaseCommand(argv) {
+export async function createGithubReleaseCommand(argv, styles) {
     const parsed = parseArgsOrExit(argv, createGithubReleaseFlagSchema);
     const { dryRun } = parsed.flags;
     const requestedTags = parseRequestedTags(parsed.flags.tags);
@@ -23,7 +23,9 @@ export async function createGithubReleaseCommand(argv) {
     if (publishableTags.length === 0) {
         return;
     }
-    const { changelogJsonOutputPath, sectionOrder } = await resolveReleaseNotesConfig({ strictLoad: true });
+    const { changelogJsonOutputPath, sectionOrder } = await resolveReleaseNotesConfig(styles.stderr, {
+        strictLoad: true,
+    });
     let outcome;
     try {
         outcome = createGithubReleases(publishableTags, changelogJsonOutputPath, dryRun, sectionOrder);

package/dist/esm/createTags.d.ts

@@ -1,6 +1,8 @@
+import { type OutputStyle } from '@williamthorsen/nmr-core';
 export interface CreateTagsOptions {
     dryRun: boolean;
     noGitChecks: boolean;
+    style: OutputStyle;
 }
 /**
  * Read tag names from the tags file produced by `prepare` and create annotated git tags.

package/dist/esm/createTags.js

@@ -1,9 +1,10 @@
 import { execFileSync } from 'node:child_process';
-import { GIT_OUTPUT_LIMIT, hasErrnoCode } from '@williamthorsen/nmr-core';
+import { formatGlyphLine, GIT_OUTPUT_LIMIT, hasErrnoCode } from '@williamthorsen/nmr-core';
 import { deleteFileIfExists } from "./deleteFileIfExists.js";
+import { RELEASE_GLYPHS } from "./glyphs.js";
 import { readReleaseTags, RELEASE_SUMMARY_FILE, RELEASE_TAGS_FILE } from "./releaseFiles.js";
 export function createTags(options) {
-    const { dryRun, noGitChecks } = options;
+    const { dryRun, noGitChecks, style } = options;
     const tags = readReleaseTags();
     if (tags.length === 0) {
         return [];
@@ -14,7 +15,7 @@ export function createTags(options) {
     if (dryRun) {
         console.info('[dry-run] Would create tags:');
         for (const tag of tags) {
-            console.info(`🏷️ ${tag}`);
+            console.info(formatGlyphLine(RELEASE_GLYPHS, style, 'tag', tag));
         }
         return tags;
     }
@@ -36,7 +37,7 @@ export function createTags(options) {
     }
     console.info('Created tags:');
     for (const tag of tags) {
-        console.info(`🏷️ ${tag}`);
+        console.info(formatGlyphLine(RELEASE_GLYPHS, style, 'tag', tag));
     }
     deleteFileIfExists(RELEASE_TAGS_FILE);
     deleteFileIfExists(RELEASE_SUMMARY_FILE);

package/dist/esm/format.d.ts

@@ -1,6 +1,6 @@
-/** Wrap text in ANSI bold. */
-export declare function bold(text: string): string;
-/** Wrap text in ANSI dim. */
-export declare function dim(text: string): string;
-/** Render a section header for separating workspaces in CLI output. */
+/** Styles text bold, returning it unstyled for a stream that cannot render color. */
+export declare function bold(text: string, stream?: NodeJS.WritableStream): string;
+/** Styles text dim, returning it unstyled for a stream that cannot render color. */
+export declare function dim(text: string, stream?: NodeJS.WritableStream): string;
+/** Renders a section header for separating workspaces in CLI output. */
 export declare function sectionHeader(name: string): string;

package/dist/esm/format.js

@@ -1,8 +1,9 @@
-export function bold(text) {
-    return `\u{1B}[1m${text}\u{1B}[0m`;
+import { styleText } from 'node:util';
+export function bold(text, stream = process.stdout) {
+    return styleText('bold', text, { stream });
 }
-export function dim(text) {
-    return `\u{1B}[2m${text}\u{1B}[0m`;
+export function dim(text, stream = process.stdout) {
+    return styleText('dim', text, { stream });
 }
 export function sectionHeader(name) {
     return `━━━ ${name} ━━━`;

package/dist/esm/glyphs.d.ts

@@ -0,0 +1,3 @@
+/** Glyphs that name no status; a status marker comes from nmr-core's `STATUS_GLYPHS`. */
+export declare const RELEASE_GLYPHS: Readonly<Record<"plain" | "rich", Readonly<Record<"bump" | "dryRun" | "tag", import("@williamthorsen/toolbelt.terminal/candidate").Glyph>>>>;
+export type ReleaseGlyphName = keyof (typeof RELEASE_GLYPHS)['rich'];

package/dist/esm/glyphs.js

@@ -0,0 +1,6 @@
+import { defineGlyphSet } from '@williamthorsen/nmr-core';
+export const RELEASE_GLYPHS = defineGlyphSet({
+    bump: { plain: 'BUMP', rich: '📦' },
+    dryRun: { plain: '', rich: '🔍' },
+    tag: { plain: 'TAG', rich: '🔖' },
+});

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

@@ -1,6 +1,8 @@
+import { type StreamStyles } from '@williamthorsen/nmr-core';
 interface InitOptions {
     dryRun: boolean;
     force: boolean;
+    styles: StreamStyles;
     withConfig: boolean;
 }
 /**
@@ -9,5 +11,5 @@ interface InitOptions {
  * Checks eligibility, detects repo type, scaffolds files, and prints next steps.
  * Returns the process exit code (0 for success, 1 for failure).
  */
-export declare function initCommand({ dryRun, force, withConfig }: InitOptions): number;
+export declare function initCommand({ dryRun, force, styles, withConfig }: InitOptions): number;
 export {};

package/dist/esm/init/initCommand.js

@@ -1,36 +1,36 @@
-import { printError, printStep, printSuccess, reportWriteResult } from '@williamthorsen/nmr-core';
+import { printError, printStep, printSuccess, reportWriteResult, } from '@williamthorsen/nmr-core';
 import { describeError } from '@williamthorsen/toolbelt.errors';
 import { hasPackageJson, isGitRepo, usesPnpm } from "./checks.js";
 import { detectRepoType } from "./detectRepoType.js";
 import { scaffoldFiles } from "./scaffold.js";
-function runRequiredCheck(label, result) {
+function runRequiredCheck(label, result, styles) {
     if (result.ok) {
-        printSuccess(label);
+        printSuccess(label, styles.stdout);
         return true;
     }
-    printError(result.message ?? `${label} failed`);
+    printError(result.message ?? `${label} failed`, styles.stderr);
     return false;
 }
-function checkEligibility() {
+function checkEligibility(styles) {
     printStep('Checking eligibility');
-    if (!runRequiredCheck('Git repository detected', isGitRepo()))
+    if (!runRequiredCheck('Git repository detected', isGitRepo(), styles))
         return false;
-    if (!runRequiredCheck('package.json found', hasPackageJson()))
+    if (!runRequiredCheck('package.json found', hasPackageJson(), styles))
         return false;
-    if (!runRequiredCheck('pnpm detected', usesPnpm()))
+    if (!runRequiredCheck('pnpm detected', usesPnpm(), styles))
         return false;
     return true;
 }
-export function initCommand({ dryRun, force, withConfig }) {
+export function initCommand({ dryRun, force, styles, withConfig }) {
     if (dryRun) {
         console.info('[dry-run mode]');
     }
     let eligible;
     try {
-        eligible = checkEligibility();
+        eligible = checkEligibility(styles);
     }
     catch (error) {
-        printError(`Eligibility check failed: ${describeError(error)}`);
+        printError(`Eligibility check failed: ${describeError(error)}`, styles.stderr);
         return 1;
     }
     if (!eligible)
@@ -41,21 +41,21 @@ export function initCommand({ dryRun, force, withConfig }) {
         repoType = detectRepoType();
     }
     catch (error) {
-        printError(`Failed to detect repo type: ${describeError(error)}`);
+        printError(`Failed to detect repo type: ${describeError(error)}`, styles.stderr);
         return 1;
     }
-    printSuccess(`Detected: ${repoType}`);
+    printSuccess(`Detected: ${repoType}`, styles.stdout);
     printStep('Scaffolding files');
     let results;
     try {
         results = scaffoldFiles({ repoType, dryRun, overwrite: force, withConfig });
     }
     catch (error) {
-        printError(`Failed to scaffold files: ${describeError(error)}`);
+        printError(`Failed to scaffold files: ${describeError(error)}`, styles.stderr);
         return 1;
     }
     for (const result of results) {
-        reportWriteResult(result, dryRun);
+        reportWriteResult(result, dryRun, styles);
     }
     if (results.some((r) => r.outcome === 'failed')) {
         return 1;

package/dist/esm/loadValidatedConfig.d.ts

@@ -1,3 +1,4 @@
+import { type OutputStyle } from '@williamthorsen/nmr-core';
 import type { ReleaseKitConfig } from './types.js';
 /**
  * Outcome of loading and validating the consumer config file. `missing` is not reported
@@ -15,4 +16,4 @@ export type LoadValidatedConfigResult = {
  * Load `.config/release-kit.config.ts` and validate it against the shared schema,
  * reporting load failures and validation errors to stderr.
  */
-export declare function loadValidatedConfig(): Promise<LoadValidatedConfigResult>;
+export declare function loadValidatedConfig(stderrStyle: OutputStyle): Promise<LoadValidatedConfigResult>;

package/dist/esm/loadValidatedConfig.js

@@ -1,8 +1,8 @@
-import { reportError } from '@williamthorsen/nmr-core';
+import { printError, reportError } from '@williamthorsen/nmr-core';
 import { describeError } from '@williamthorsen/toolbelt.errors';
 import { loadConfig } from "./loadConfig.js";
 import { validateConfig } from "./validateConfig.js";
-export async function loadValidatedConfig() {
+export async function loadValidatedConfig(stderrStyle) {
     let raw;
     try {
         raw = await loadConfig();
@@ -19,7 +19,7 @@ export async function loadValidatedConfig() {
     if (errors.length > 0) {
         process.stderr.write('Invalid config:\n');
         for (const err of errors) {
-            process.stderr.write(`  ❌ ${err}\n`);
+            printError(err, stderrStyle);
         }
         return { status: 'invalid' };
     }

package/dist/esm/parseCommitMessage.d.ts

@@ -15,10 +15,9 @@ export type PolicyViolationSurface = 'prefix' | 'body';
 /**
  * Callback invoked when `parseCommitMessage` detects a `!`-policy violation.
  *
- * Two-tier policy: at write-time (commit-msg hook, OOS for ticket #355), violations are
- * rejected outright; at release-time (this parser), violations are warn-and-continue so
- * legacy log entries don't block releases. Callers (`decideRelease`, `releasePrepareMono`,
- * etc.) collect callback invocations and surface them in the release report.
+ * The parser warns and continues on a violation, so legacy log entries don't block releases.
+ * Callers (`decideRelease`, `releasePrepareMono`, etc.) collect callback invocations and
+ * surface them in the release report.
  */
 export type PolicyViolationHandler = (commit: Commit, type: string, surface: PolicyViolationSurface) => void;
 /** Optional configuration for `parseCommitMessage` beyond the core inputs. */
@@ -47,6 +46,6 @@ export interface ParseCommitMessageOptions {
  * `!`-policy enforcement is **release-time tolerant**: when the resolved type's policy
  * forbids `!`, the marker is dropped from the parse (`breaking: false`) and
  * `onPolicyViolation` is invoked. When the policy requires `!`, a bare type triggers the
- * same warning path. The strict write-time gate (commit-msg hook) is out of scope.
+ * same warning path.
  */
 export declare function parseCommitMessage(message: string, hash: string, workTypes: Record<string, WorkTypeConfig>, scopeAliases?: Record<string, string>, options?: ParseCommitMessageOptions): ParsedCommit | undefined;

package/dist/esm/prepareCommand.d.ts

@@ -1,3 +1,4 @@
+import { type StreamStyles } from '@williamthorsen/nmr-core';
 import type { ReleaseType } from './types.js';
 export declare const prepareFlagSchema: {
     dryRun: {
@@ -49,4 +50,4 @@ export declare function parseArgs(argv: string[]): {
  * 4. Delegates to `releasePrepare` or `releasePrepareMono` to compute the release plan.
  * 5. Applies the plan, runs the format command, and prints the result via `reportPrepare`.
  */
-export declare function prepareCommand(argv: string[]): Promise<void>;
+export declare function prepareCommand(argv: string[], styles: StreamStyles): Promise<void>;

package/dist/esm/prepareCommand.js

@@ -1,11 +1,12 @@
 import { execSync } from 'node:child_process';
-import { parseArgsOrExit, reportError } from '@williamthorsen/nmr-core';
+import { formatGlyphLine, formatStatusLine, parseArgsOrExit, printError, reportError, } from '@williamthorsen/nmr-core';
 import { describeError } from '@williamthorsen/toolbelt.errors';
 import { assertCleanWorkingTree } from "./assertCleanWorkingTree.js";
 import { buildDependencyGraph } from "./buildDependencyGraph.js";
 import { discoverWorkspaces } from "./discoverWorkspaces.js";
 import { dim } from "./format.js";
 import { getCommitsSinceTarget } from "./getCommitsSinceTarget.js";
+import { RELEASE_GLYPHS } from "./glyphs.js";
 import { loadConfig, mergeMonorepoConfig, mergeSinglePackageConfig, readRootPackageVersion } from "./loadConfig.js";
 import { RELEASE_SUMMARY_FILE, RELEASE_TAGS_FILE } from "./releaseFiles.js";
 import { applyReleasePlan } from "./releasePlan.js";
@@ -72,7 +73,7 @@ export function parseArgs(argv) {
         withReleaseNotes: flags.withReleaseNotes,
     };
 }
-export async function prepareCommand(argv) {
+export async function prepareCommand(argv, styles) {
     const { dryRun, force, noGitChecks, bumpOverride, only, setVersion, withReleaseNotes } = parseArgs(argv);
     const options = {
         force,
@@ -81,7 +82,7 @@ export async function prepareCommand(argv) {
         ...(withReleaseNotes && { withReleaseNotes: true }),
     };
     if (dryRun) {
-        console.info('\n🔍 DRY RUN — no files will be modified\n');
+        console.info(`\n${formatGlyphLine(RELEASE_GLYPHS, styles.stdout, 'dryRun', 'DRY RUN — no files will be modified')}\n`);
     }
     if (!dryRun && !noGitChecks) {
         try {
@@ -92,7 +93,7 @@ export async function prepareCommand(argv) {
             process.exit(1);
         }
     }
-    const userConfig = await loadAndValidateConfig();
+    const userConfig = await loadAndValidateConfig(styles.stderr);
     let discoveredPaths;
     try {
         discoveredPaths = await discoverWorkspaces();
@@ -102,13 +103,13 @@ export async function prepareCommand(argv) {
         process.exit(1);
     }
     if (discoveredPaths === undefined) {
-        runSinglePackageMode(userConfig, options, only, dryRun);
+        runSinglePackageMode(userConfig, options, only, dryRun, styles.stdout);
     }
     else {
-        runMonorepoMode(discoveredPaths, userConfig, options, only, setVersion, dryRun);
+        runMonorepoMode(discoveredPaths, userConfig, options, only, setVersion, dryRun, styles.stdout);
     }
 }
-function runSinglePackageMode(userConfig, options, only, dryRun) {
+function runSinglePackageMode(userConfig, options, only, dryRun, style) {
     if (only !== undefined) {
         reportError('--only is only supported for monorepo configurations');
         process.exit(1);
@@ -119,9 +120,9 @@ function runSinglePackageMode(userConfig, options, only, dryRun) {
         process.exit(1);
     }
     const config = mergeSinglePackageConfig(userConfig);
-    runAndReport(() => releasePrepare(config, options), dryRun);
+    runAndReport(() => releasePrepare(config, options), dryRun, style);
 }
-function runMonorepoMode(discoveredPaths, userConfig, options, only, setVersion, dryRun) {
+function runMonorepoMode(discoveredPaths, userConfig, options, only, setVersion, dryRun, style) {
     let config;
     try {
         const rootPackage = readRootPackageVersion();
@@ -177,9 +178,9 @@ function runMonorepoMode(discoveredPaths, userConfig, options, only, setVersion,
             process.exit(1);
         }
     }
-    runAndReport(() => releasePrepareMono(config, { ...options, ...(only !== undefined && { only }) }), dryRun);
+    runAndReport(() => releasePrepareMono(config, { ...options, ...(only !== undefined && { only }) }), dryRun, style);
 }
-async function loadAndValidateConfig() {
+async function loadAndValidateConfig(stderrStyle) {
     let rawConfig;
     try {
         rawConfig = await loadConfig();
@@ -195,16 +196,16 @@ async function loadAndValidateConfig() {
     if (errors.length > 0) {
         process.stderr.write('Invalid config:\n');
         for (const err of errors) {
-            process.stderr.write(`  ❌ ${err}\n`);
+            printError(err, stderrStyle);
         }
         process.exit(1);
     }
     for (const warning of warnings) {
-        console.warn(`  ⚠️  ${warning}`);
+        console.warn(`  ${formatStatusLine(stderrStyle, 'warning', warning)}`);
     }
     return config;
 }
-function runAndReport(computePlan, dryRun) {
+function runAndReport(computePlan, dryRun, style) {
     let plan;
     try {
         plan = computePlan();
@@ -215,7 +216,7 @@ function runAndReport(computePlan, dryRun) {
         process.exit(1);
     }
     if (dryRun) {
-        process.stdout.write(reportPrepare(plan, { applied: false }) + '\n');
+        process.stdout.write(reportPrepare(plan, { applied: false, style }) + '\n');
         reportPlanFiles(plan, true);
         return;
     }
@@ -227,7 +228,7 @@ function runAndReport(computePlan, dryRun) {
         process.exit(1);
     }
     const formatError = runFormatCommand(plan.formatCommand);
-    process.stdout.write(reportPrepare(plan, { applied: true, ...(formatError !== undefined && { formatError }) }) + '\n');
+    process.stdout.write(reportPrepare(plan, { applied: true, style, ...(formatError !== undefined && { formatError }) }) + '\n');
     reportPlanFiles(plan, false);
     if (formatError !== undefined) {
         reportError(`The format command failed, but the release is prepared and ${RELEASE_TAGS_FILE} is written. ` +

package/dist/esm/publishCommand.d.ts

@@ -1,5 +1,6 @@
+import { type StreamStyles } from '@williamthorsen/nmr-core';
 /**
  * Orchestrate the CLI `publish` command: parse flags, discover workspaces, resolve tags from HEAD,
  * detect the package manager, validate `--tags`, and publish each tag with inject/restore lifecycle.
  */
-export declare function publishCommand(argv: string[]): Promise<void>;
+export declare function publishCommand(argv: string[], styles: StreamStyles): Promise<void>;

package/dist/esm/publishCommand.js

@@ -16,7 +16,7 @@ const publishFlagSchema = {
     provenance: { long: '--provenance', type: 'boolean' },
     tags: { long: '--tags', type: 'string' },
 };
-export async function publishCommand(argv) {
+export async function publishCommand(argv, styles) {
     const parsed = parseArgsOrExit(argv, publishFlagSchema);
     const { dryRun, noGitChecks, provenance } = parsed.flags;
     if (!dryRun && !noGitChecks) {
@@ -39,7 +39,7 @@ export async function publishCommand(argv) {
         return;
     }
     const packageManager = detectPackageManager();
-    const { releaseNotes, changelogJsonOutputPath, sectionOrder } = await resolveReleaseNotesConfig();
+    const { releaseNotes, changelogJsonOutputPath, sectionOrder } = await resolveReleaseNotesConfig(styles.stderr);
     const shouldInject = releaseNotes.shouldInjectIntoReadme;
     console.info(dryRun ? '[dry-run] Would publish:' : 'Publishing:');
     for (const { tag, workspacePath } of publishableTags) {

package/dist/esm/reportPrepare.d.ts

@@ -1,3 +1,4 @@
+import { type OutputStyle } from '@williamthorsen/nmr-core';
 import type { PrepareResult } from './types.js';
 /** How the plan was carried out, which decides the tense the report is rendered in. */
 export interface ReportPrepareOptions {
@@ -5,6 +6,7 @@ export interface ReportPrepareOptions {
     applied: boolean;
     /** The format command's failure message, when it ran and failed. */
     formatError?: string;
+    style: OutputStyle;
 }
 /**
  * Format a release plan into styled terminal output.