@williamthorsen/release-kit 5.1.0 → 5.2.0

package/dist/esm/types.d.ts

@@ -3,6 +3,7 @@ export type ChangelogAudience = 'all' | 'dev';
 export interface ChangelogItem {
     description: string;
     body?: string;
+    breaking?: boolean;
 }
 export interface ChangelogSection {
     title: string;
@@ -37,6 +38,12 @@ export interface BumpResult {
     newVersion: string;
     files: string[];
 }
+export interface PolicyViolation {
+    commitHash: string;
+    commitSubject: string;
+    type: string;
+    surface: 'prefix' | 'body';
+}
 export interface ReleasedWorkspaceResult {
     status: 'released';
     name?: string;
@@ -44,6 +51,7 @@ export interface ReleasedWorkspaceResult {
     commitCount: number;
     parsedCommitCount?: number;
     unparseableCommits?: Commit[];
+    policyViolations?: PolicyViolation[];
     releaseType?: ReleaseType;
     currentVersion: string;
     newVersion: string;
@@ -62,6 +70,7 @@ export interface SkippedWorkspaceResult {
     commitCount: number;
     parsedCommitCount?: number;
     unparseableCommits?: Commit[];
+    policyViolations?: PolicyViolation[];
     skipReason: string;
 }
 export type WorkspacePrepareResult = ReleasedWorkspaceResult | SkippedWorkspaceResult;
@@ -71,6 +80,7 @@ export interface ReleasedProjectResult {
     commitCount: number;
     parsedCommitCount: number;
     unparseableCommits?: Commit[];
+    policyViolations?: PolicyViolation[];
     releaseType: ReleaseType;
     currentVersion: string;
     newVersion: string;
@@ -86,6 +96,7 @@ export interface SkippedProjectResult {
     commitCount: number;
     parsedCommitCount: number;
     unparseableCommits?: Commit[];
+    policyViolations?: PolicyViolation[];
     skipReason: string;
 }
 export type ProjectPrepareResult = ReleasedProjectResult | SkippedProjectResult;
@@ -113,6 +124,7 @@ export interface ReleaseKitConfig {
     workspaces?: WorkspaceOverride[];
     versionPatterns?: VersionPatterns;
     workTypes?: Record<string, WorkTypeConfig>;
+    breakingPolicies?: Record<string, 'forbidden' | 'optional' | 'required'>;
     formatCommand?: string;
     cliffConfigPath?: string;
     scopeAliases?: Record<string, string>;
@@ -152,6 +164,7 @@ export interface WorkspaceConfig {
     name: string;
     tagPrefix: string;
     workspacePath: string;
+    isPublishable: boolean;
     packageFiles: string[];
     changelogPaths: string[];
     paths: string[];
@@ -161,6 +174,7 @@ export interface MonorepoReleaseConfig {
     workspaces: WorkspaceConfig[];
     workTypes?: Record<string, WorkTypeConfig>;
     versionPatterns?: VersionPatterns;
+    breakingPolicies?: Record<string, 'forbidden' | 'optional' | 'required'>;
     formatCommand?: string;
     cliffConfigPath?: string;
     scopeAliases?: Record<string, string>;
@@ -174,6 +188,7 @@ export interface ReleaseConfig {
     changelogPaths: string[];
     workTypes?: Record<string, WorkTypeConfig>;
     versionPatterns?: VersionPatterns;
+    breakingPolicies?: Record<string, 'forbidden' | 'optional' | 'required'>;
     formatCommand?: string;
     cliffConfigPath?: string;
     scopeAliases?: Record<string, string>;

package/dist/esm/work-types.json

@@ -0,0 +1,127 @@
+{
+  "$schema": "./work-types.schema.json",
+  "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
+    }
+  ]
+}

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

@@ -0,0 +1,73 @@
+{
+  "$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"],
+  "additionalProperties": false,
+  "properties": {
+    "$schema": {
+      "type": "string",
+      "description": "Optional reference to this schema for IDE validation."
+    },
+    "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
+    }
+  },
+  "definitions": {
+    "workType": {
+      "type": "object",
+      "required": ["tier", "key", "aliases", "emoji", "label", "breakingPolicy"],
+      "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
+        },
+        "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/workTypesData.d.ts

@@ -0,0 +1,14 @@
+export interface WorkTypeEntry {
+    tier: string;
+    key: string;
+    aliases: string[];
+    emoji: string;
+    label: string;
+    breakingPolicy: 'forbidden' | 'optional' | 'required';
+    excludedFromChangelog?: boolean;
+}
+export interface WorkTypesData {
+    tiers: string[];
+    types: WorkTypeEntry[];
+}
+export declare const WORK_TYPES_DATA: WorkTypesData;

package/dist/esm/workTypesData.js

@@ -0,0 +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"
+    },
+    {
+      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
+    }
+  ]
+};
+export {
+  WORK_TYPES_DATA
+};

package/dist/esm/workTypesUtils.d.ts

@@ -0,0 +1,5 @@
+export declare function hasExpectedTopLevelShape(value: unknown): value is {
+    tiers: unknown[];
+    types: unknown[];
+};
+export declare function errorMessage(error: unknown): string;

package/dist/esm/workTypesUtils.js

@@ -0,0 +1,16 @@
+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 {
+  errorMessage,
+  hasExpectedTopLevelShape
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@williamthorsen/release-kit",
-  "version": "5.1.0",
+  "version": "5.2.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",
@@ -37,7 +37,7 @@
     "js-yaml": "4.1.1",
     "json-stringify-pretty-compact": "4.0.0",
     "semver": "7.7.4",
-    "@williamthorsen/nmr-core": "0.3.0"
+    "@williamthorsen/nmr-core": "0.3.1"
   },
   "devDependencies": {
     "@types/js-yaml": "4.0.9",
@@ -52,9 +52,12 @@
     "registry": "https://registry.npmjs.org"
   },
   "scripts": {
+    "build:post": "node scripts/copy-work-types.js",
     "test": "pnpm exec vitest --config=vitest.standalone.config.ts",
     "test:coverage": "pnpm exec vitest --config=vitest.standalone.config.ts --coverage",
     "test:integration": "pnpm exec vitest --config=vitest.integration.config.ts",
-    "test:watch": "pnpm exec vitest --config=vitest.standalone.config.ts --watch"
+    "test:watch": "pnpm exec vitest --config=vitest.standalone.config.ts --watch",
+    "work-types:check": "pnpm exec release-kit work-types check",
+    "work-types:sync": "pnpm exec release-kit work-types sync"
   }
 }

package/dist/esm/version.d.ts

@@ -1 +0,0 @@
-export declare const VERSION = "5.1.0";

package/dist/esm/version.js

@@ -1,4 +0,0 @@
-const VERSION = "5.1.0";
-export {
-  VERSION
-};