@williamthorsen/release-kit 10.8.0 → 11.0.0

package/dist/esm/checkWorkTypesDrift.js

@@ -1,117 +0,0 @@
-import { readFileSync } from 'node:fs';
-import { dirname, resolve } from 'node:path';
-import { fileURLToPath } from 'node:url';
-import { formatErrorLine } from '@williamthorsen/nmr-core';
-import { describeError } from '@williamthorsen/toolbelt.errors';
-import { buildFetchInit, hasExpectedTopLevelShape } from "./workTypesUtils.js";
-export const UPSTREAM_WORK_TYPES_URL = 'https://raw.githubusercontent.com/williamthorsen/codeassembly/main/packages/agents/content/skills/_data/work-types.json';
-function resolveDefaultLocalPath() {
-    const moduleDir = dirname(fileURLToPath(import.meta.url));
-    return resolve(moduleDir, 'work-types.json');
-}
-export async function checkWorkTypesDrift(dependencies = {}) {
-    const localPath = dependencies.localPath ?? resolveDefaultLocalPath();
-    const fetcher = dependencies.fetch ?? globalThis.fetch;
-    const url = dependencies.upstreamUrl ?? UPSTREAM_WORK_TYPES_URL;
-    const localContent = readFileSync(localPath, 'utf8');
-    let localJson;
-    try {
-        localJson = JSON.parse(localContent);
-    }
-    catch (error) {
-        return {
-            exitCode: 3,
-            message: `Local work-types.json is not valid JSON: ${describeError(error)}`,
-        };
-    }
-    const fetchInit = buildFetchInit();
-    let response;
-    try {
-        response = fetchInit === undefined ? await fetcher(url) : await fetcher(url, fetchInit);
-    }
-    catch (error) {
-        return {
-            exitCode: 2,
-            message: formatErrorLine(`Failed to fetch upstream work-types.json: ${describeError(error)}`),
-        };
-    }
-    if (response.status === 404) {
-        return {
-            exitCode: 0,
-            message: `Upstream work-types.json not found at ${url}; skipping drift check.`,
-        };
-    }
-    if (!response.ok) {
-        return {
-            exitCode: 2,
-            message: formatErrorLine(`Failed to fetch upstream work-types.json: HTTP ${response.status} ${response.statusText}`),
-        };
-    }
-    const upstreamText = await response.text();
-    let upstreamJson;
-    try {
-        upstreamJson = JSON.parse(upstreamText);
-    }
-    catch (error) {
-        return {
-            exitCode: 3,
-            message: `Upstream work-types.json is not valid JSON: ${describeError(error)}`,
-        };
-    }
-    if (!hasExpectedTopLevelShape(upstreamJson)) {
-        return {
-            exitCode: 3,
-            message: 'Upstream work-types.json does not match the expected schema shape (missing `tiers` or `types`).',
-        };
-    }
-    const normalisedLocal = stripLocalOnlyFields(localJson);
-    if (deepEqual(normalisedLocal, upstreamJson)) {
-        return {
-            exitCode: 0,
-            message: 'Local work-types.json matches upstream.',
-        };
-    }
-    return {
-        exitCode: 1,
-        message: `Drift detected. Local and upstream work-types.json differ. Run \`nmr work-types:sync\` to update from upstream.\nLocal:    ${localPath}\nUpstream: ${url}`,
-    };
-}
-function stripLocalOnlyFields(value) {
-    if (typeof value !== 'object' || value === null || Array.isArray(value)) {
-        return value;
-    }
-    const record = { ...value };
-    delete record['$schema'];
-    return record;
-}
-function deepEqual(a, b) {
-    if (a === b)
-        return true;
-    if (typeof a !== typeof b)
-        return false;
-    if (a === null || b === null)
-        return a === b;
-    if (Array.isArray(a) && Array.isArray(b)) {
-        if (a.length !== b.length)
-            return false;
-        for (let i = 0; i < a.length; i++) {
-            if (!deepEqual(a[i], b[i]))
-                return false;
-        }
-        return true;
-    }
-    if (typeof a === 'object' && typeof b === 'object' && !Array.isArray(a) && !Array.isArray(b)) {
-        const aRecord = { ...a };
-        const bRecord = { ...b };
-        const aKeys = Object.keys(aRecord);
-        const bKeys = Object.keys(bRecord);
-        if (aKeys.length !== bKeys.length)
-            return false;
-        for (const key of aKeys) {
-            if (!deepEqual(aRecord[key], bRecord[key]))
-                return false;
-        }
-        return true;
-    }
-    return false;
-}

package/dist/esm/syncWorkTypes.d.ts

@@ -1,28 +0,0 @@
-/** Outcome of a sync operation. */
-export interface SyncResult {
-    /**
-     * Process exit code semantics:
-     * - `0` — sync succeeded (file may be unchanged).
-     * - `2` — network error or local write failure.
-     * - `3` — schema mismatch (upstream JSON does not parse or fails the shape check).
-     */
-    exitCode: 0 | 2 | 3;
-    message: string;
-}
-/** Minimal injection seam so unit tests can substitute a deterministic fetcher. */
-export interface SyncWorkTypesDependencies {
-    /** Absolute path of the local `work-types.json`. Defaults to the bundled file. */
-    localPath?: string;
-    /** HTTP fetcher. Defaults to global `fetch`. */
-    fetch?: typeof globalThis.fetch;
-    /** Override the upstream URL (used by tests). */
-    upstreamUrl?: string;
-}
-/**
- * Fetch the upstream `work-types.json`, validate its top-level shape, and overwrite the
- * locally-bundled copy with the formatted upstream contents.
- *
- * Output is reformatted to match the local file's conventions (2-space indent, trailing
- * newline) so subsequent diffs are content-driven, not whitespace-driven.
- */
-export declare function syncWorkTypes(dependencies?: SyncWorkTypesDependencies): Promise<SyncResult>;

package/dist/esm/syncWorkTypes.js

@@ -1,94 +0,0 @@
-import { readFileSync, writeFileSync } from 'node:fs';
-import { dirname, resolve } from 'node:path';
-import { fileURLToPath } from 'node:url';
-import { formatErrorLine } from '@williamthorsen/nmr-core';
-import { describeError } from '@williamthorsen/toolbelt.errors';
-import { UPSTREAM_WORK_TYPES_URL } from "./checkWorkTypesDrift.js";
-import { isRecord } from "./typeGuards.js";
-import { buildFetchInit, hasExpectedTopLevelShape } from "./workTypesUtils.js";
-function resolveDefaultLocalPath() {
-    const moduleDir = dirname(fileURLToPath(import.meta.url));
-    return resolve(moduleDir, 'work-types.json');
-}
-function extractLocalSchemaUrl(content) {
-    let parsed;
-    try {
-        parsed = JSON.parse(content);
-    }
-    catch {
-        return undefined;
-    }
-    if (!isRecord(parsed)) {
-        return undefined;
-    }
-    const schema = parsed['$schema'];
-    return typeof schema === 'string' ? schema : undefined;
-}
-export async function syncWorkTypes(dependencies = {}) {
-    const localPath = dependencies.localPath ?? resolveDefaultLocalPath();
-    const fetcher = dependencies.fetch ?? globalThis.fetch;
-    const url = dependencies.upstreamUrl ?? UPSTREAM_WORK_TYPES_URL;
-    const fetchInit = buildFetchInit();
-    let response;
-    try {
-        response = fetchInit === undefined ? await fetcher(url) : await fetcher(url, fetchInit);
-    }
-    catch (error) {
-        return {
-            exitCode: 2,
-            message: formatErrorLine(`Failed to fetch upstream work-types.json: ${describeError(error)}`),
-        };
-    }
-    if (!response.ok) {
-        return {
-            exitCode: 2,
-            message: formatErrorLine(`Failed to fetch upstream work-types.json: HTTP ${response.status} ${response.statusText}`),
-        };
-    }
-    const upstreamText = await response.text();
-    let upstreamJson;
-    try {
-        upstreamJson = JSON.parse(upstreamText);
-    }
-    catch (error) {
-        return {
-            exitCode: 3,
-            message: `Upstream work-types.json is not valid JSON: ${describeError(error)}`,
-        };
-    }
-    if (!hasExpectedTopLevelShape(upstreamJson)) {
-        return {
-            exitCode: 3,
-            message: 'Upstream work-types.json does not match the expected schema shape (missing `tiers` or `types`).',
-        };
-    }
-    let priorContent;
-    try {
-        priorContent = readFileSync(localPath, 'utf8');
-    }
-    catch {
-        priorContent = undefined;
-    }
-    const localSchemaUrl = priorContent !== undefined ? extractLocalSchemaUrl(priorContent) : undefined;
-    const outputJson = localSchemaUrl !== undefined ? { $schema: localSchemaUrl, ...upstreamJson } : upstreamJson;
-    const formatted = `${JSON.stringify(outputJson, null, 2)}\n`;
-    if (priorContent === formatted) {
-        return {
-            exitCode: 0,
-            message: `Local work-types.json already matches upstream (${localPath}).`,
-        };
-    }
-    try {
-        writeFileSync(localPath, formatted, 'utf8');
-    }
-    catch (error) {
-        return {
-            exitCode: 2,
-            message: formatErrorLine(`Failed to write ${localPath}: ${describeError(error)}`),
-        };
-    }
-    return {
-        exitCode: 0,
-        message: `Synced work-types.json from ${url} → ${localPath}.`,
-    };
-}

package/dist/esm/work-types.json

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

package/dist/esm/work-types.schema.json

@@ -1,110 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "https://github.com/williamthorsen/node-monorepo-tools/raw/main/packages/release-kit/src/work-types.schema.json",
-  "title": "Work types",
-  "description": "Canonical taxonomy of commit work types used by release-kit. Drives section ordering, audience classification, and the `!` (breaking) policy. The structured single-source-of-truth for everything that previously lived in `DEFAULT_WORK_TYPES` and `cliff.toml.template` group definitions.",
-  "type": "object",
-  "required": ["tiers", "types", "markers", "version"],
-  "additionalProperties": false,
-  "properties": {
-    "$schema": {
-      "type": "string",
-      "description": "Optional reference to this schema for IDE validation."
-    },
-    "version": {
-      "type": "string",
-      "description": "Semantic version of the data shape. Bumped when the structure changes in a way that breaks downstream consumers.",
-      "pattern": "^\\d+\\.\\d+\\.\\d+$"
-    },
-    "tiers": {
-      "type": "array",
-      "description": "Render tiers in canonical order. Each entry's `tier` field must reference one of these names.",
-      "items": { "type": "string", "minLength": 1 },
-      "minItems": 1,
-      "uniqueItems": true
-    },
-    "types": {
-      "type": "array",
-      "description": "Work-type entries in canonical render order (tier order, then row order within tier).",
-      "items": { "$ref": "#/definitions/workType" },
-      "minItems": 1
-    },
-    "markers": {
-      "type": "object",
-      "description": "Orthogonal section markers used by downstream renderers (PR descriptions, changelogs, release notes). Keyed by marker name; values describe the rendering inputs (emoji + label). Markers are cross-cutting — they are not tied to a specific work type.",
-      "required": ["breaking"],
-      "properties": {
-        "breaking": { "$ref": "#/definitions/marker" }
-      },
-      "additionalProperties": { "$ref": "#/definitions/marker" }
-    }
-  },
-  "definitions": {
-    "marker": {
-      "type": "object",
-      "description": "Rendering inputs for a single marker. Stored as plain text; consumers apply their own formatting (e.g., bolding, prefix punctuation) at construction time.",
-      "required": ["emoji", "label"],
-      "additionalProperties": false,
-      "properties": {
-        "emoji": {
-          "type": "string",
-          "description": "Decorative emoji rendered as the prefix of the marker.",
-          "minLength": 1
-        },
-        "label": {
-          "type": "string",
-          "description": "Human-readable marker label. Plain text; consumers add their own emphasis (e.g., bold) when constructing the rendered form.",
-          "minLength": 1
-        }
-      }
-    },
-    "workType": {
-      "type": "object",
-      "required": ["tier", "key", "aliases", "emoji", "label", "breakingPolicy", "description"],
-      "additionalProperties": false,
-      "properties": {
-        "tier": {
-          "type": "string",
-          "description": "Render tier this entry belongs to. Must match one of the names in the top-level `tiers` array."
-        },
-        "key": {
-          "type": "string",
-          "description": "Canonical work-type identifier (e.g. `feat`, `fix`). Must be globally unique across all entries.",
-          "minLength": 1,
-          "pattern": "^[a-z][a-z0-9]*$"
-        },
-        "aliases": {
-          "type": "array",
-          "description": "Alternate identifiers that resolve to this work type. Must be globally unique and not collide with any `key`.",
-          "items": { "type": "string", "minLength": 1, "pattern": "^[a-z][a-z0-9]*$" },
-          "uniqueItems": true
-        },
-        "emoji": {
-          "type": "string",
-          "description": "Decorative emoji rendered as the prefix of the section heading.",
-          "minLength": 1
-        },
-        "label": {
-          "type": "string",
-          "description": "Human-readable section label (rendered as `${emoji} ${label}` in changelogs and release notes).",
-          "minLength": 1
-        },
-        "description": {
-          "type": "string",
-          "description": "The changes that the type covers, read by an agent choosing a type for a change.",
-          "minLength": 1
-        },
-        "breakingPolicy": {
-          "type": "string",
-          "description": "Policy governing the `!` (breaking) marker for this type. `forbidden`: `!` is a policy violation. `optional`: `!` is allowed. `required`: bare type is a policy violation; only the `!` form is accepted.",
-          "enum": ["forbidden", "optional", "required"]
-        },
-        "excludedFromChangelog": {
-          "type": "boolean",
-          "description": "When `true`, this type's commits never appear in any changelog or release note. Currently only `fmt` sets this. Default: `false`.",
-          "default": false
-        }
-      }
-    }
-  }
-}

package/dist/esm/workTypesUtils.d.ts

@@ -1,22 +0,0 @@
-/**
- * Shared helpers for the work-types canonical-source tooling.
- *
- * Both `checkWorkTypesDrift` and `syncWorkTypes` need to validate the upstream JSON's top-level
- * shape and render unknown errors as strings. Keeping a single copy here avoids byte-for-byte
- * duplication between the two entry points.
- */
-/** Sanity-check that the parsed upstream JSON carries the expected top-level shape. */
-export declare function hasExpectedTopLevelShape(value: unknown): value is {
-    tiers: unknown[];
-    types: unknown[];
-};
-/**
- * Build the `init` argument for `fetch` to reach codeassembly's canonical work-types files.
- *
- * Returns `{ headers: { Authorization: 'Bearer <token>' } }` when `GITHUB_TOKEN` is set in the
- * environment; returns `undefined` otherwise so the call site stays byte-identical to an
- * unauthenticated request. Centralised here so `checkWorkTypesDrift` and `syncWorkTypes`
- * cannot diverge on auth handling. Tests stub the env via `vi.stubEnv` rather than parameter
- * injection, so this reads `process.env` directly.
- */
-export declare function buildFetchInit(): RequestInit | undefined;

package/dist/esm/workTypesUtils.js

@@ -1,16 +0,0 @@
-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);
-}
-export function buildFetchInit() {
-    const token = process.env['GITHUB_TOKEN'];
-    if (token === undefined || token === '') {
-        return undefined;
-    }
-    return { headers: { Authorization: `Bearer ${token}` } };
-}