@ucdjs/release-scripts 0.1.0-beta.33 → 0.1.0-beta.34

package/dist/index.mjs

@@ -1,21 +1,98 @@
 import { t as Eta } from "./eta-BV8TCRDW.mjs";
 import { Console, Context, Data, Effect, Layer, Schema } from "effect";
+import process from "node:process";
 import path from "node:path";
 import { Command, CommandExecutor } from "@effect/platform";
 import { NodeCommandExecutor, NodeFileSystem } from "@effect/platform-node";
 import * as CommitParser from "commit-parser";
-import process from "node:process";
 import semver from "semver";
 import fs from "node:fs/promises";
 import prompts from "prompts";
 
+//#region src/options.ts
+const DEFAULT_PR_BODY_TEMPLATE = `## Summary\n\nThis PR contains the following changes:\n\n- Updated package versions\n- Updated changelogs\n\n## Packages\n\nThe following packages will be released:\n\n{{packages}}`;
+const DEFAULT_CHANGELOG_TEMPLATE = `# Changelog\n\n{{releases}}`;
+const DEFAULT_TYPES = {
+	feat: {
+		title: "🚀 Features",
+		color: "green"
+	},
+	fix: {
+		title: "🐞 Bug Fixes",
+		color: "red"
+	},
+	refactor: {
+		title: "🔧 Code Refactoring",
+		color: "blue"
+	},
+	perf: {
+		title: "🏎 Performance",
+		color: "orange"
+	},
+	docs: {
+		title: "📚 Documentation",
+		color: "purple"
+	},
+	style: {
+		title: "🎨 Styles",
+		color: "pink"
+	}
+};
+function normalizeReleaseScriptsOptions(options) {
+	const { workspaceRoot = process.cwd(), githubToken = "", repo: fullRepo, packages = true, branch = {}, globalCommitMode = "dependencies", pullRequest = {}, changelog = {}, types = {}, dryRun = false, npm = {}, prompts = {} } = options;
+	const token = githubToken.trim();
+	if (!token) throw new Error("GitHub token is required. Pass it in via options.");
+	if (!fullRepo || !fullRepo.trim() || !fullRepo.includes("/")) throw new Error("Repository (repo) is required. Specify in 'owner/repo' format (e.g., 'octocat/hello-world').");
+	const [owner, repo] = fullRepo.split("/");
+	if (!owner || !repo) throw new Error(`Invalid repo format: "${fullRepo}". Expected format: "owner/repo" (e.g., "octocat/hello-world").`);
+	const normalizedPackages = typeof packages === "object" && !Array.isArray(packages) ? {
+		exclude: packages.exclude ?? [],
+		include: packages.include ?? [],
+		excludePrivate: packages.excludePrivate ?? false
+	} : packages;
+	const isCI = process.env.CI === "true" || process.env.GITHUB_ACTIONS === "true";
+	return {
+		dryRun,
+		workspaceRoot,
+		githubToken: token,
+		owner,
+		repo,
+		packages: normalizedPackages,
+		branch: {
+			release: branch.release ?? "release/next",
+			default: branch.default ?? "main"
+		},
+		globalCommitMode,
+		pullRequest: {
+			title: pullRequest.title ?? "chore: release new version",
+			body: pullRequest.body ?? DEFAULT_PR_BODY_TEMPLATE
+		},
+		changelog: {
+			enabled: changelog.enabled ?? true,
+			template: changelog.template ?? DEFAULT_CHANGELOG_TEMPLATE,
+			emojis: changelog.emojis ?? true
+		},
+		types: options.types ? {
+			...DEFAULT_TYPES,
+			...types
+		} : DEFAULT_TYPES,
+		npm: {
+			otp: npm.otp,
+			provenance: npm.provenance ?? true
+		},
+		prompts: { versions: prompts.versions ?? !isCI }
+	};
+}
+var ReleaseScriptsOptions = class extends Context.Tag("@ucdjs/release-scripts/ReleaseScriptsOptions")() {};
+
+//#endregion
 //#region src/utils/changelog-formatters.ts
 const eta$1 = new Eta();
 /**
 * Pure function to parse commits into changelog entries
 */
 function parseCommits(commits) {
-	return commits.filter((commit) => commit.isConventional).map((commit) => ({
+	return commits.filter((commit) => commit.isConventional).filter((commit) => commit.type !== "chore").map((commit) => ({
 		type: commit.type || "other",
 		scope: commit.scope,
 		description: commit.description,
@@ -25,6 +102,11 @@ function parseCommits(commits) {
 		references: commit.references.map((ref) => ({
 			type: ref.type,
 			value: ref.value
+		})),
+		authors: commit.authors.map((author) => ({
+			name: author.name,
+			email: author.email,
+			profile: author.profile
 		}))
 	}));
 }
@@ -43,10 +125,7 @@ function groupByType(entries) {
 /**
 * Changelog template for Eta rendering
 */
-const CHANGELOG_TEMPLATE = `# <%= it.packageName %> v<%= it.version %>
-
-**Previous version**: \`<%= it.previousVersion %>\`
-**New version**: \`<%= it.version %>\`
+const CHANGELOG_ENTRY_TEMPLATE = `## <%= it.version %>
 
 <% if (it.entries.length === 0) { %>
 *No conventional commits found.*
@@ -55,25 +134,58 @@ const CHANGELOG_TEMPLATE = `# <%= it.packageName %> v<%= it.version %>
 <% const typeOrder = ["breaking", "feat", "fix", "perf", "docs", "style", "refactor", "test", "build", "ci", "chore"]; %>
 <% const typeLabels = {
   breaking: "💥 Breaking Changes",
-  feat: "✨ Features",
-  fix: "🐛 Bug Fixes",
+  feat: "🚀 Features",
+  fix: "🐞 Bug Fixes",
   perf: "⚡ Performance",
-  docs: "📝 Documentation",
-  style: "💄 Styling",
-  refactor: "♻️ Refactoring",
-  test: "✅ Tests",
-  build: "📦 Build",
-  ci: "👷 CI",
-  chore: "🔧 Chores"
+  docs: "Documentation",
+  style: "Styling",
+  refactor: "Refactoring",
+  test: "Tests",
+  build: "Build",
+  ci: "CI",
+  chore: "Chores"
+}; %>
+
+<% const formatAuthor = (entry) => {
+  const author = entry.authors && entry.authors.length > 0 ? entry.authors[0] : null;
+  if (!author) return "unknown";
+  if (author.profile && author.profile.includes("github.com/")) {
+    const username = author.profile.split("github.com/")[1];
+    return "@" + username;
+  }
+  return author.name || "unknown";
+}; %>
+
+<% const commitUrl = (hash) => it.repo ? "https://github.com/" + it.repo + "/commit/" + hash : ""; %>
+
+<% const formatLine = (entry) => {
+  const authorText = formatAuthor(entry);
+  const commitLink = commitUrl(entry.hash);
+  const hashPart = commitLink
+    ? " [<samp>(" + entry.shortHash + ")</samp>](" + commitLink + ")"
+    : " <samp>(" + entry.shortHash + ")</samp>";
+  return entry.description + " &nbsp;-&nbsp; by " + authorText + hashPart;
 }; %>
 
 <% for (const type of typeOrder) { %>
 <% const entries = groups.get(type); %>
 <% if (entries && entries.length > 0) { %>
-## <%= typeLabels[type] || type.charAt(0).toUpperCase() + type.slice(1) %>
+### &nbsp;&nbsp;&nbsp;<%= typeLabels[type] || type.charAt(0).toUpperCase() + type.slice(1) %>
 
-<% for (const entry of entries) { %>
-- <% if (entry.scope) { %>**<%= entry.scope %>**: <% } %><%= entry.description %><% if (entry.references.length > 0) { %> (<%= entry.references.map(r => "#" + r.value).join(", ") %>)<% } %> (\`<%= entry.shortHash %>\`)
+<% const unscoped = entries.filter(e => !e.scope); %>
+<% const scoped = entries.filter(e => e.scope); %>
+
+<% for (const entry of unscoped) { %>
+- <%= formatLine(entry) %>
+<% } %>
+
+<% const scopes = [...new Set(scoped.map(e => e.scope))]; %>
+<% for (const scope of scopes) { %>
+- **<%= scope %>**:
+  <% const scopeEntries = scoped.filter(e => e.scope === scope); %>
+  <% for (const entry of scopeEntries) { %>
+  - <%= formatLine(entry) %>
+  <% } %>
 <% } %>
 
 <% } %>
@@ -81,37 +193,56 @@ const CHANGELOG_TEMPLATE = `# <%= it.packageName %> v<%= it.version %>
 
 <% for (const [type, entries] of groups) { %>
 <% if (!typeOrder.includes(type)) { %>
-## <%= type.charAt(0).toUpperCase() + type.slice(1) %>
+### &nbsp;&nbsp;&nbsp;<%= type.charAt(0).toUpperCase() + type.slice(1) %>
 
 <% for (const entry of entries) { %>
-- <% if (entry.scope) { %>**<%= entry.scope %>**: <% } %><%= entry.description %> (\`<%= entry.shortHash %>\`)
+- <%= formatLine(entry) %>
 <% } %>
 
 <% } %>
 <% } %>
+
+<% if (it.repo) { %>
+##### &nbsp;&nbsp;&nbsp;&nbsp;[View changes on GitHub](https://github.com/<%= it.repo %>/compare/v<%= it.previousVersion %>...v<%= it.version %>)
+<% } %>
 <% } %>`;
 /**
 * Pure function to format changelog as markdown
 */
-function formatChangelogMarkdown(changelog) {
+function formatChangelogEntryMarkdown(changelog) {
 	const groups = groupByType(changelog.entries);
-	return eta$1.renderString(CHANGELOG_TEMPLATE, {
+	return eta$1.renderString(CHANGELOG_ENTRY_TEMPLATE, {
 		packageName: changelog.packageName,
 		version: changelog.version,
 		previousVersion: changelog.previousVersion,
 		entries: changelog.entries,
-		groupedEntries: groups
+		groupedEntries: groups,
+		repo: changelog.repo
 	});
 }
+function appendChangelogEntry(existingContent, changelogEntry, packageName) {
+	const entry = changelogEntry.trim();
+	if (!entry) return existingContent ?? `# ${packageName}\n`;
+	if (!existingContent || existingContent.trim() === "") return `# ${packageName}\n\n${entry}\n`;
+	const lines = existingContent.split("\n");
+	const firstLine = lines[0]?.trim() ?? "";
+	if (!firstLine.startsWith("# ")) return `# ${packageName}\n\n${entry}\n\n${existingContent.trim()}\n`;
+	let insertIndex = 1;
+	while (insertIndex < lines.length && lines[insertIndex]?.trim() === "") insertIndex++;
+	const rest = lines.slice(insertIndex).join("\n").trim();
+	if (rest) return `${firstLine}\n\n${entry}\n\n${rest}\n`;
+	return `${firstLine}\n\n${entry}\n`;
+}
 /**
 * Pure function to create a changelog object
 */
-function createChangelog(packageName, version, previousVersion, commits) {
+function createChangelog(packageName, version, previousVersion, commits, repo) {
 	return {
 		packageName,
 		version,
 		previousVersion,
-		entries: parseCommits(commits)
+		entries: parseCommits(commits),
+		repo
 	};
 }
 
@@ -119,12 +250,19 @@ function createChangelog(packageName, version, previousVersion, commits) {
 //#region src/services/changelog.service.ts
 var ChangelogService = class extends Effect.Service()("@ucdjs/release-scripts/ChangelogService", {
 	effect: Effect.gen(function* () {
+		const config = yield* ReleaseScriptsOptions;
 		function generateChangelog(pkg, newVersion, commits) {
 			return Effect.gen(function* () {
-				const changelog = createChangelog(pkg.name, newVersion, pkg.version, commits);
+				const changelog = createChangelog(pkg.name, newVersion, pkg.version, commits, `${config.owner}/${config.repo}`);
+				const entryMarkdown = formatChangelogEntryMarkdown(changelog);
 				return {
 					changelog,
-					markdown: formatChangelogMarkdown(changelog),
+					markdown: appendChangelogEntry(yield* Effect.tryPromise({
+						try: async () => {
+							return await (await import("node:fs/promises")).readFile(`${pkg.path}/CHANGELOG.md`, "utf-8");
+						},
+						catch: (err) => err
+					}).pipe(Effect.catchAll(() => Effect.succeed(""))), entryMarkdown, pkg.name),
 					filePath: `${pkg.path}/CHANGELOG.md`
 				};
 			});
@@ -213,83 +351,6 @@ var NPMError = class extends Data.TaggedError("NPMError") {};
 var PublishError = class extends Data.TaggedError("PublishError") {};
 var TagError = class extends Data.TaggedError("TagError") {};
 
-//#endregion
-//#region src/options.ts
-const DEFAULT_PR_BODY_TEMPLATE = `## Summary\n\nThis PR contains the following changes:\n\n- Updated package versions\n- Updated changelogs\n\n## Packages\n\nThe following packages will be released:\n\n{{packages}}`;
-const DEFAULT_CHANGELOG_TEMPLATE = `# Changelog\n\n{{releases}}`;
-const DEFAULT_TYPES = {
-	feat: {
-		title: "🚀 Features",
-		color: "green"
-	},
-	fix: {
-		title: "🐞 Bug Fixes",
-		color: "red"
-	},
-	refactor: {
-		title: "🔧 Code Refactoring",
-		color: "blue"
-	},
-	perf: {
-		title: "🏎 Performance",
-		color: "orange"
-	},
-	docs: {
-		title: "📚 Documentation",
-		color: "purple"
-	},
-	style: {
-		title: "🎨 Styles",
-		color: "pink"
-	}
-};
-function normalizeReleaseScriptsOptions(options) {
-	const { workspaceRoot = process.cwd(), githubToken = "", repo: fullRepo, packages = true, branch = {}, globalCommitMode = "dependencies", pullRequest = {}, changelog = {}, types = {}, dryRun = false, npm = {}, prompts = {} } = options;
-	const token = githubToken.trim();
-	if (!token) throw new Error("GitHub token is required. Pass it in via options.");
-	if (!fullRepo || !fullRepo.trim() || !fullRepo.includes("/")) throw new Error("Repository (repo) is required. Specify in 'owner/repo' format (e.g., 'octocat/hello-world').");
-	const [owner, repo] = fullRepo.split("/");
-	if (!owner || !repo) throw new Error(`Invalid repo format: "${fullRepo}". Expected format: "owner/repo" (e.g., "octocat/hello-world").`);
-	const normalizedPackages = typeof packages === "object" && !Array.isArray(packages) ? {
-		exclude: packages.exclude ?? [],
-		include: packages.include ?? [],
-		excludePrivate: packages.excludePrivate ?? false
-	} : packages;
-	const isCI = process.env.CI === "true" || process.env.GITHUB_ACTIONS === "true";
-	return {
-		dryRun,
-		workspaceRoot,
-		githubToken: token,
-		owner,
-		repo,
-		packages: normalizedPackages,
-		branch: {
-			release: branch.release ?? "release/next",
-			default: branch.default ?? "main"
-		},
-		globalCommitMode,
-		pullRequest: {
-			title: pullRequest.title ?? "chore: release new version",
-			body: pullRequest.body ?? DEFAULT_PR_BODY_TEMPLATE
-		},
-		changelog: {
-			enabled: changelog.enabled ?? true,
-			template: changelog.template ?? DEFAULT_CHANGELOG_TEMPLATE,
-			emojis: changelog.emojis ?? true
-		},
-		types: options.types ? {
-			...DEFAULT_TYPES,
-			...types
-		} : DEFAULT_TYPES,
-		npm: {
-			otp: npm.otp,
-			provenance: npm.provenance ?? true
-		},
-		prompts: { versions: prompts.versions ?? !isCI }
-	};
-}
-var ReleaseScriptsOptions = class extends Context.Tag("@ucdjs/release-scripts/ReleaseScriptsOptions")() {};
-
 //#endregion
 //#region src/services/git.service.ts
 var GitService = class extends Effect.Service()("@ucdjs/release-scripts/GitService", {
@@ -784,6 +845,9 @@ var WorkspaceService = class extends Effect.Service()("@ucdjs/release-scripts/Wo
 				message: `Invalid package.json for ${pkgPath}`,
 				cause: e,
 				operation: "readPackageJson"
+			})), Effect.map((validated) => ({
+				...json,
+				...validated
 			})))));
 		}
 		function writePackageJson(pkgPath, json) {
@@ -1176,8 +1240,18 @@ var VersionPromptService = class extends Effect.Service()("@ucdjs/release-script
 	effect: Effect.gen(function* () {
 		const config = yield* ReleaseScriptsOptions;
 		let applyToAllRemainingChoice = null;
+		let isCancelled = false;
 		function promptForVersion(pkg, conventionalBump, remainingCount) {
 			return Effect.async((resume) => {
+				if (isCancelled) {
+					resume(Effect.succeed({
+						newVersion: pkg.version,
+						bumpType: "none",
+						applyToAllRemaining: false,
+						cancelled: true
+					}));
+					return;
+				}
 				const allCommits = [...pkg.commits, ...pkg.globalCommits];
 				const prereleaseInfo = getPrereleaseInfo(pkg.version);
 				const commitCount = allCommits.length;
@@ -1189,7 +1263,8 @@ var VersionPromptService = class extends Effect.Service()("@ucdjs/release-script
 					const result = {
 						newVersion: applyToAllRemainingChoice.version === "custom" ? pkg.version : applyToAllRemainingChoice.version,
 						bumpType: applyToAllRemainingChoice.bumpType,
-						applyToAllRemaining: false
+						applyToAllRemaining: false,
+						cancelled: false
 					};
 					resume(Effect.succeed(result));
 					return;
@@ -1215,10 +1290,12 @@ var VersionPromptService = class extends Effect.Service()("@ucdjs/release-script
 					hint: "Use arrow keys to navigate, enter to select"
 				}).then(async (response) => {
 					if (!response.choice) {
+						isCancelled = true;
 						const result = {
 							newVersion: pkg.version,
 							bumpType: "none",
-							applyToAllRemaining: false
+							applyToAllRemaining: false,
+							cancelled: true
 						};
 						resume(Effect.succeed(result));
 						return;
@@ -1235,37 +1312,63 @@ var VersionPromptService = class extends Effect.Service()("@ucdjs/release-script
 							})),
 							initial: findDefaultIndex(applyOptions, conventionalBump)
 						});
-						if (applyResponse.choice) {
-							if (applyResponse.choice.version === "custom") {
-								const customVersion = await promptForCustomVersion(pkg.version);
-								if (customVersion) applyToAllRemainingChoice = {
-									version: customVersion,
-									bumpType: applyResponse.choice.bumpType
-								};
-							} else applyToAllRemainingChoice = applyResponse.choice;
-							const result = {
-								newVersion: applyToAllRemainingChoice?.version || pkg.version,
-								bumpType: applyToAllRemainingChoice?.bumpType || "none",
-								applyToAllRemaining: true
+						if (!applyResponse.choice) {
+							isCancelled = true;
+							resume(Effect.succeed({
+								newVersion: pkg.version,
+								bumpType: "none",
+								applyToAllRemaining: false,
+								cancelled: true
+							}));
+							return;
+						}
+						if (applyResponse.choice.version === "custom") {
+							const customVersion = await promptForCustomVersion(pkg.version);
+							if (!customVersion) {
+								isCancelled = true;
+								resume(Effect.succeed({
+									newVersion: pkg.version,
+									bumpType: "none",
+									applyToAllRemaining: false,
+									cancelled: true
+								}));
+								return;
+							}
+							applyToAllRemainingChoice = {
+								version: customVersion,
+								bumpType: applyResponse.choice.bumpType
 							};
-							resume(Effect.succeed(result));
-						} else promptForVersion(pkg, conventionalBump, remainingCount).pipe(Effect.runPromise).then((r) => resume(Effect.succeed(r)));
+						} else applyToAllRemainingChoice = applyResponse.choice;
+						const result = {
+							newVersion: applyToAllRemainingChoice?.version || pkg.version,
+							bumpType: applyToAllRemainingChoice?.bumpType || "none",
+							applyToAllRemaining: true,
+							cancelled: false
+						};
+						resume(Effect.succeed(result));
 						return;
 					}
 					let selectedVersion = response.choice.version;
-					let selectedBumpType = response.choice.bumpType;
+					const selectedBumpType = response.choice.bumpType;
 					if (selectedVersion === "custom") {
 						const customVersion = await promptForCustomVersion(pkg.version);
-						if (customVersion) selectedVersion = customVersion;
-						else {
-							selectedVersion = pkg.version;
-							selectedBumpType = "none";
+						if (!customVersion) {
+							isCancelled = true;
+							resume(Effect.succeed({
+								newVersion: pkg.version,
+								bumpType: "none",
+								applyToAllRemaining: false,
+								cancelled: true
+							}));
+							return;
 						}
+						selectedVersion = customVersion;
 					}
 					const result = {
 						newVersion: selectedVersion,
 						bumpType: selectedBumpType,
-						applyToAllRemaining: false
+						applyToAllRemaining: false,
+						cancelled: false
 					};
 					resume(Effect.succeed(result));
 				});
@@ -1276,6 +1379,7 @@ var VersionPromptService = class extends Effect.Service()("@ucdjs/release-script
 			isEnabled: config.prompts.versions,
 			resetApplyToAll: () => {
 				applyToAllRemainingChoice = null;
+				isCancelled = false;
 			}
 		};
 	}),
@@ -1479,6 +1583,8 @@ function constructPrepareProgram(config) {
 		const versionPrompt = yield* VersionPromptService;
 		const workspace = yield* WorkspaceService;
 		yield* git.workspace.assertWorkspaceReady;
+		const startingBranch = yield* git.branches.get;
+		if (startingBranch !== config.branch.default) return yield* Effect.fail(/* @__PURE__ */ new Error(`Prepare must be run on the default branch "${config.branch.default}". Current branch: "${startingBranch}"`));
 		let releasePullRequest = yield* github.getPullRequestByBranch(config.branch.release);
 		const isNewRelease = !releasePullRequest;
 		const branchExists = yield* git.branches.exists(config.branch.release);
@@ -1534,6 +1640,14 @@ function constructPrepareProgram(config) {
 					continue;
 				}
 				const result = yield* versionPrompt.promptForVersion(pkg, conventionalBump, remainingCount);
+				if (result.cancelled) {
+					yield* Console.log("\nCancelled by user.");
+					if (startingBranch !== (yield* git.branches.get)) {
+						yield* git.branches.checkout(startingBranch);
+						yield* Console.log(`Switched back to "${startingBranch}".`);
+					}
+					return yield* Effect.fail(/* @__PURE__ */ new Error("Release preparation cancelled."));
+				}
 				releases.push({
 					package: {
 						name: pkg.name,
@@ -1609,8 +1723,10 @@ ${releases.map((r) => `  - ${r.package.name}@${r.newVersion}`).join("\n")}`;
 			yield* Console.log("Pull request updated.");
 		}
 		yield* Console.log(`\nRelease preparation complete! View PR: #${releasePullRequest.number}`);
-		yield* git.branches.checkout(config.branch.default);
-		yield* Console.log(`Switched back to "${config.branch.default}".`);
+		if (startingBranch !== (yield* git.branches.get)) {
+			yield* git.branches.checkout(startingBranch);
+			yield* Console.log(`Switched back to "${startingBranch}".`);
+		}
 	});
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ucdjs/release-scripts",
-  "version": "0.1.0-beta.33",
+  "version": "0.1.0-beta.34",
   "description": "@ucdjs release scripts",
   "type": "module",
   "license": "MIT",