@williamthorsen/release-kit 11.0.0 → 13.0.0

package/dist/esm/getCommitsSinceTarget.d.ts

@@ -1,21 +0,0 @@
-import type { Commit } from './types.js';
-/**
- * Gets commits since the latest baseline tag matching any of the given prefixes.
- *
- * Uses `git log` to retrieve commit messages and hashes between the closest reachable
- * baseline tag and HEAD. When no tag matches any prefix, all commits reachable from HEAD
- * are returned.
- *
- * Callers must pass at least one prefix; the single-prefix case is the common one (the
- * workspace's derived prefix). Multiple prefixes are used to include historical tag prefixes
- * from `legacyIdentities`.
- *
- * @param tagPrefixes - Tag prefixes to search as a union (e.g., `['core-v', 'old-core-v']`).
- * @param paths - Optional glob patterns to filter commits by path (appended after `--` in `git log`).
- *   Path patterns use POSIX-style forward slashes; Windows compatibility is not guaranteed.
- * @returns An object with the found tag (if any) and the list of commits.
- */
-export declare function getCommitsSinceTarget(tagPrefixes: readonly string[], paths?: string[]): {
-    tag: string | undefined;
-    commits: Commit[];
-};

package/dist/esm/getCommitsSinceTarget.js

@@ -1,66 +0,0 @@
-import { execFileSync } from 'node:child_process';
-import { GIT_OUTPUT_LIMIT } from '@williamthorsen/nmr-core';
-import { chainError } from '@williamthorsen/toolbelt.errors/candidate';
-const FIELD_SEPARATOR = '\u{1F}';
-function isNoTagError(err) {
-    return typeof err === 'object' && err !== null && 'status' in err && err.status === 128;
-}
-function findLatestTag(tagPrefixes) {
-    if (tagPrefixes.length === 0) {
-        throw new Error('findLatestTag: tagPrefixes must contain at least one entry');
-    }
-    const matchArgs = tagPrefixes.map((prefix) => `--match=${prefix}*`);
-    try {
-        const tagResult = execFileSync('git', ['describe', '--tags', '--abbrev=0', ...matchArgs], {
-            encoding: 'utf8',
-            maxBuffer: GIT_OUTPUT_LIMIT,
-            stdio: ['pipe', 'pipe', 'pipe'],
-        }).trim();
-        return tagResult || undefined;
-    }
-    catch (error) {
-        if (isNoTagError(error)) {
-            return undefined;
-        }
-        throw chainError(`Failed to run 'git describe'`, error);
-    }
-}
-const RELEASE_COMMIT_PREFIX = 'release:';
-function parseLogOutput(logOutput) {
-    const commits = [];
-    for (const line of logOutput.split('\n')) {
-        const trimmedLine = line.trim();
-        if (trimmedLine === '') {
-            continue;
-        }
-        const [message, hash] = trimmedLine.split(FIELD_SEPARATOR);
-        if (message !== undefined && hash !== undefined && !message.startsWith(RELEASE_COMMIT_PREFIX)) {
-            commits.push({ message, hash });
-        }
-    }
-    return commits;
-}
-export function getCommitsSinceTarget(tagPrefixes, paths) {
-    const tag = findLatestTag(tagPrefixes);
-    const range = tag === undefined ? 'HEAD' : `${tag}..HEAD`;
-    const format = `%s${FIELD_SEPARATOR}%H`;
-    const args = ['log', range, `--pretty=format:${format}`];
-    if (paths !== undefined && paths.length > 0) {
-        args.push('--', ...paths);
-    }
-    let logOutput;
-    try {
-        logOutput = execFileSync('git', args, {
-            encoding: 'utf8',
-            maxBuffer: GIT_OUTPUT_LIMIT,
-            stdio: ['pipe', 'pipe', 'pipe'],
-        }).trim();
-    }
-    catch (error) {
-        throw chainError(`Failed to run 'git log' for range '${range}'`, error);
-    }
-    if (logOutput === '') {
-        return { tag, commits: [] };
-    }
-    return { tag, commits: parseLogOutput(logOutput) };
-}

package/dist/esm/resolveCliffConfigPath.d.ts

@@ -1,11 +0,0 @@
-/**
- * Resolve the git-cliff configuration file path.
- *
- * Checks candidates in order: explicit `cliffConfigPath` -> `.config/git-cliff.toml` ->
- * `cliff.toml` -> bundled `cliff.toml.template`. Returns the first path that exists,
- * or throws if even the bundled template cannot be found.
- *
- * When an explicit `cliffConfigPath` is provided, it is returned as-is without checking
- * existence, preserving current behavior (git-cliff reports the error if the file is missing).
- */
-export declare function resolveCliffConfigPath(cliffConfigPath: string | undefined, metaUrl: string): string;

package/dist/esm/resolveCliffConfigPath.js

@@ -1,20 +0,0 @@
-import { existsSync } from 'node:fs';
-import { resolve } from 'node:path';
-import { findPackageRoot } from '@williamthorsen/nmr-core';
-export function resolveCliffConfigPath(cliffConfigPath, metaUrl) {
-    if (cliffConfigPath !== undefined) {
-        return cliffConfigPath;
-    }
-    const candidates = ['.config/git-cliff.toml', 'cliff.toml'];
-    for (const candidate of candidates) {
-        if (existsSync(candidate)) {
-            return candidate;
-        }
-    }
-    const root = findPackageRoot(metaUrl);
-    const bundledPath = resolve(root, 'cliff.toml.template');
-    if (existsSync(bundledPath)) {
-        return bundledPath;
-    }
-    throw new Error(`Could not resolve a git-cliff config file. Searched: ${candidates.join(', ')}, and bundled template at ${bundledPath}`);
-}

package/dist/esm/resolveReleaseNotesConfig.d.ts

@@ -1,26 +0,0 @@
-import type { OutputStyle } from '@williamthorsen/nmr-core';
-import type { ReleaseNotesConfig } from './types.js';
-export interface ResolvedReleaseNotesConfig {
-    releaseNotes: ReleaseNotesConfig;
-    changelogJsonOutputPath: string;
-    /** Section titles in priority order, derived from the merged workTypes record. */
-    sectionOrder: string[];
-}
-export interface ResolveReleaseNotesConfigOptions {
-    /** Config file to read, relative to the working directory. Defaults to `CONFIG_FILE_PATH`. */
-    configPath?: string;
-}
-/**
- * Loads and validates the release-kit config, resolving the release-notes settings it carries.
- *
- * An unusable config reports to stderr and calls `process.exit(1)`, whether the file failed to load or failed
- * validation, and whether it was named by the caller or the default one. Both callers are CLI commands whose
- * whole behavior depends on the resolved config, so neither could proceed on derived defaults without silently
- * dropping a configured `releaseNotes.shouldInjectIntoReadme`, `changelogJson.outputPath`, or `workTypes`.
- * An absent default config is a supported state and resolves to the defaults.
- */
-export declare function resolveReleaseNotesConfig(stderrStyle: OutputStyle, options?: ResolveReleaseNotesConfigOptions): Promise<ResolvedReleaseNotesConfig>;
-/** Extract section headers in declaration order from a merged workTypes record. */
-export declare function deriveSectionOrder(workTypes: Record<string, {
-    header: string;
-}>): string[];

package/dist/esm/resolveReleaseNotesConfig.js

@@ -1,29 +0,0 @@
-import { DEFAULT_CHANGELOG_JSON_CONFIG, DEFAULT_RELEASE_NOTES_CONFIG } from "./defaults.js";
-import { resolveWorkTypes } from "./loadConfig.js";
-import { loadValidatedConfig, reportConfigProblem, reportConfigWarnings } from "./loadValidatedConfig.js";
-export async function resolveReleaseNotesConfig(stderrStyle, options = {}) {
-    const result = await loadValidatedConfig(options.configPath);
-    if (result.status === 'invalid') {
-        reportConfigProblem(result.problem, stderrStyle);
-        process.exit(1);
-    }
-    if (result.status === 'missing') {
-        return {
-            releaseNotes: { ...DEFAULT_RELEASE_NOTES_CONFIG },
-            changelogJsonOutputPath: DEFAULT_CHANGELOG_JSON_CONFIG.outputPath,
-            sectionOrder: deriveSectionOrder(resolveWorkTypes()),
-        };
-    }
-    reportConfigWarnings(result.warnings, stderrStyle);
-    const { config } = result;
-    return {
-        releaseNotes: {
-            shouldInjectIntoReadme: config.releaseNotes?.shouldInjectIntoReadme ?? DEFAULT_RELEASE_NOTES_CONFIG.shouldInjectIntoReadme,
-        },
-        changelogJsonOutputPath: config.changelogJson?.outputPath ?? DEFAULT_CHANGELOG_JSON_CONFIG.outputPath,
-        sectionOrder: deriveSectionOrder(resolveWorkTypes(config.workTypes)),
-    };
-}
-export function deriveSectionOrder(workTypes) {
-    return Object.values(workTypes).map((entry) => entry.header);
-}

package/dist/esm/runGitCliff.d.ts

@@ -1,38 +0,0 @@
-/**
- * The exact `git-cliff` version every invocation resolves.
- *
- * npm's `git-cliff` trails the upstream release, so this pin normally sits behind the newest version cliff
- * itself reports. Bumping it is an edit to this line, once npm publishes the version you want.
- */
-export declare const GIT_CLIFF_VERSION = "2.13.1";
-/** The npx arguments that precede the cliff args at every invocation, and that the dry-run report renders. */
-export declare const GIT_CLIFF_NPX_ARGS: readonly string[];
-/**
- * Invokes `git-cliff` via `npx` and returns the output it produced.
- *
- * Single entry point for `git-cliff` invocations from `release-kit`. Owns three pieces of shared lifecycle
- * that would otherwise duplicate (and silently drift) across call sites: the npx flags, the spawned-process
- * environment, and the temp dir holding both the `.template`→`.toml` config copy and cliff's output file.
- *
- * Output is routed through `--output` to a temp file and read back. `--context` emits a workspace's
- * entire matching tag history on every run, so its size grows without bound with the repo;
- * a file accommodates that, while a pipe is bounded by `maxBuffer`.
- *
- * The npx spec names an exact version, which leaves npm no staleness to check, so `--prefer-offline` skips the
- * per-call registry revalidation round-trip (~2.5 s per invocation on a warm cache) without stranding the run
- * on whatever the cache happens to hold.
- *
- * Two env entries are set for the child. `npm_config_progress=false` suppresses npx's animated stderr spinner,
- * which otherwise renders as a transient flicker. `RUST_LOG=warn` drops cliff's INFO lines, among them the
- * crates.io update notice it emits on every invocation while npm trails upstream, and leaves warnings and errors
- * in place; an inherited `RUST_LOG` wins, so raising the level for debugging still works.
- *
- * The helper injects `--config <path>` and `--output <path>` itself — callers must NOT include either in `cliffArgs`.
- * `--output` is appended last so a caller that passes one anyway cannot redirect the output the helper then reads.
- * The caller is responsible for resolving the cliff config path (via `resolveCliffConfigPath`) before calling,
- * since the resolution depends on the caller's `import.meta.url`.
- *
- * Errors from `execFileSync` are not caught: callers wrap with site-specific messages.
- * The temp-dir cleanup runs in a `finally` so it still happens on throw.
- */
-export declare function runGitCliff(cliffConfigPath: string, cliffArgs: readonly string[]): string;

package/dist/esm/runGitCliff.js

@@ -1,25 +0,0 @@
-import { execFileSync } from 'node:child_process';
-import { copyFileSync, mkdtempSync, readFileSync, rmSync } from 'node:fs';
-import { tmpdir } from 'node:os';
-import { join } from 'node:path';
-export const GIT_CLIFF_VERSION = '2.13.1';
-export const GIT_CLIFF_NPX_ARGS = ['--prefer-offline', '--yes', `git-cliff@${GIT_CLIFF_VERSION}`];
-export function runGitCliff(cliffConfigPath, cliffArgs) {
-    const tempDir = mkdtempSync(join(tmpdir(), 'cliff-'));
-    try {
-        let configPath = cliffConfigPath;
-        if (cliffConfigPath.endsWith('.template')) {
-            configPath = join(tempDir, 'cliff.toml');
-            copyFileSync(cliffConfigPath, configPath);
-        }
-        const outputPath = join(tempDir, 'output.json');
-        execFileSync('npx', [...GIT_CLIFF_NPX_ARGS, '--config', configPath, ...cliffArgs, '--output', outputPath], {
-            stdio: ['ignore', 'ignore', 'inherit'],
-            env: { ...process.env, npm_config_progress: 'false', RUST_LOG: process.env['RUST_LOG'] ?? 'warn' },
-        });
-        return readFileSync(outputPath, 'utf8');
-    }
-    finally {
-        rmSync(tempDir, { recursive: true, force: true });
-    }
-}

package/dist/esm/workTypesData.d.ts

@@ -1,50 +0,0 @@
-/**
- * Canonical work-types data: the runtime mirror of `work-types.json`.
- *
- * `work-types.json` is release-kit's copy of the codeassembly canonical. This `.ts` mirror exists for
- * runtime consumption: The compiler baseline does not enable JSON module imports, and a TS constant keeps
- * `breakingPolicy` typed as its three-value union.
- *
- * `nmr work-types:sync` updates only the JSON, so copy its change here by hand. A drift test
- * (`workTypesData.unit.test.ts`) asserts that this constant deep-equals the parsed contents of
- * `work-types.json`.
- */
-/** Schema for a single entry. */
-export interface WorkTypeEntry {
-    tier: string;
-    key: string;
-    aliases: string[];
-    emoji: string;
-    label: string;
-    description: string;
-    breakingPolicy: 'forbidden' | 'optional' | 'required';
-    excludedFromChangelog?: boolean;
-}
-/**
- * Schema for an orthogonal section marker (e.g., breaking-changes indicator).
- *
- * Stored as plain text — consumers add formatting (bold, prefix punctuation) when
- * constructing the rendered form. Keeps the SSOT format-agnostic across Markdown,
- * HTML, terminal, and plain-text consumers.
- */
-export interface MarkerEntry {
-    emoji: string;
-    label: string;
-}
-/** Schema for the full data. */
-export interface WorkTypesData {
-    /** Semantic version of the data shape, as declared by the upstream canonical. */
-    version: string;
-    tiers: string[];
-    types: WorkTypeEntry[];
-    /**
-     * Cross-cutting section markers keyed by marker name. The `breaking` marker is
-     * canonical and required; additional keys are permitted for forward-compatibility.
-     */
-    markers: {
-        [key: string]: MarkerEntry;
-        breaking: MarkerEntry;
-    };
-}
-/** Canonical work-types data, kept in lockstep with `work-types.json`. */
-export declare const WORK_TYPES_DATA: WorkTypesData;

package/dist/esm/workTypesData.js

@@ -1,145 +0,0 @@
-export const WORK_TYPES_DATA = {
-    version: '1.1.0',
-    tiers: ['public', 'internal', 'process'],
-    types: [
-        {
-            tier: 'public',
-            key: 'feat',
-            aliases: ['feature'],
-            emoji: '🎉',
-            label: 'Features',
-            description: 'A change that gives consumers a new capability or extends an existing one.',
-            breakingPolicy: 'optional',
-        },
-        {
-            tier: 'public',
-            key: 'drop',
-            aliases: [],
-            emoji: '🪦',
-            label: 'Removed',
-            description: 'A change that removes a capability or surface on which consumers depend.',
-            breakingPolicy: 'required',
-        },
-        {
-            tier: 'public',
-            key: 'deprecate',
-            aliases: [],
-            emoji: '🗑️',
-            label: 'Deprecated',
-            description: 'A change that marks a capability or surface for removal while the capability or surface keeps working.',
-            breakingPolicy: 'forbidden',
-        },
-        {
-            tier: 'public',
-            key: 'fix',
-            aliases: ['bugfix'],
-            emoji: '🐛',
-            label: 'Bug fixes',
-            description: 'A change that corrects behavior that consumers meet and that differs from what was intended.',
-            breakingPolicy: 'optional',
-        },
-        {
-            tier: 'public',
-            key: 'sec',
-            aliases: ['security'],
-            emoji: '🔒',
-            label: 'Security',
-            description: 'A change that closes a vulnerability or hardens a consumer-facing surface against attack.',
-            breakingPolicy: 'optional',
-        },
-        {
-            tier: 'public',
-            key: 'perf',
-            aliases: ['performance'],
-            emoji: '⚡',
-            label: 'Performance',
-            description: 'A change that reduces the time, memory, or other resources that consumer-facing work uses, without changing its result.',
-            breakingPolicy: 'optional',
-        },
-        {
-            tier: 'internal',
-            key: 'internal',
-            aliases: ['utility'],
-            emoji: '🏗️',
-            label: 'Internal features',
-            description: 'A change that adds or extends a capability that consumers do not use directly, such as a helper or an internal module.',
-            breakingPolicy: 'forbidden',
-        },
-        {
-            tier: 'internal',
-            key: 'refactor',
-            aliases: [],
-            emoji: '♻️',
-            label: 'Refactoring',
-            description: 'A change that restructures existing code without changing its behavior.',
-            breakingPolicy: 'forbidden',
-        },
-        {
-            tier: 'internal',
-            key: 'tests',
-            aliases: ['test'],
-            emoji: '🧪',
-            label: 'Tests',
-            description: 'A change confined to tests, test fixtures, or test helpers, including one that unblocks a build or a type check.',
-            breakingPolicy: 'forbidden',
-        },
-        {
-            tier: 'process',
-            key: 'tooling',
-            aliases: [],
-            emoji: '⚙️',
-            label: 'Tooling',
-            description: 'A change to the tools used to develop the project: build, lint, formatting, and release configuration, and development scripts.',
-            breakingPolicy: 'forbidden',
-        },
-        {
-            tier: 'process',
-            key: 'ci',
-            aliases: [],
-            emoji: '👷',
-            label: 'CI',
-            description: 'A change to continuous-integration workflows and their configuration.',
-            breakingPolicy: 'forbidden',
-        },
-        {
-            tier: 'process',
-            key: 'deps',
-            aliases: ['dep'],
-            emoji: '📦',
-            label: 'Dependencies',
-            description: 'A change that adds, removes, or upgrades a dependency, including its lockfile and version-catalog entries.',
-            breakingPolicy: 'forbidden',
-        },
-        {
-            tier: 'process',
-            key: 'ai',
-            aliases: [],
-            emoji: '🤖',
-            label: 'Agentic support',
-            description: "A change to guidance on working in the repository itself, such as its `AGENTS.md` or a repo-local skill, or to the repository's agent configuration.",
-            breakingPolicy: 'forbidden',
-        },
-        {
-            tier: 'process',
-            key: 'docs',
-            aliases: ['doc'],
-            emoji: '📚',
-            label: 'Documentation',
-            description: 'A change to documentation for human readers, such as a README, a guide, or a code comment.',
-            breakingPolicy: 'forbidden',
-        },
-        {
-            tier: 'process',
-            key: 'fmt',
-            aliases: [],
-            emoji: '🎨',
-            label: 'Formatting',
-            description: 'A change to formatting alone, such as whitespace or line wrapping, that leaves the content unchanged.',
-            breakingPolicy: 'forbidden',
-            excludedFromChangelog: true,
-        },
-    ],
-    markers: {
-        breaking: { emoji: '🚨', label: 'Breaking' },
-    },
-};

package/schemas/label-map.json

@@ -1,24 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "title": "label-map",
-  "description": "Maps commit-prefix scopes and types to GitHub label names. Consumed by agent skills, CI tooling, and any script that needs to translate commit conventions into label operations.",
-  "type": "object",
-  "required": ["types", "scopes"],
-  "additionalProperties": false,
-  "properties": {
-    "$schema": {
-      "type": "string",
-      "description": "JSON Schema reference for editor support."
-    },
-    "types": {
-      "type": "object",
-      "description": "Maps commit-type prefix (e.g., `feat`) to GitHub label name (e.g., `feature`).",
-      "additionalProperties": { "type": "string" }
-    },
-    "scopes": {
-      "type": "object",
-      "description": "Maps commit-scope prefix (e.g., `audit`) to GitHub label name (e.g., `scope:audit`).",
-      "additionalProperties": { "type": "string" }
-    }
-  }
-}