@afoures/auto-release 0.2.10 → 0.2.12

package/dist/lib/change-file.mjs

@@ -29,34 +29,24 @@ var ChangeFile = class {
 };
 async function save_change_file(change_file, to) {
 	const file_path = join(to, change_file.filename);
-	await write_file(file_path, change_file.summary);
+	const text = change_file.summary.split("\n").map((line) => line.slice(2)).join("\n");
+	await write_file(file_path, text);
 	return file_path;
 }
 async function parse_change_file(path) {
 	const filename = basename(path);
 	const match = CHANGE_FILENAME_REGEX.exec(filename);
 	if (!match) return /* @__PURE__ */ new Error(`Invalid change filename format: ${path} (expected: <kind>.<slug>.md)`);
-	const content = await read_file(path);
-	if (content === null) return /* @__PURE__ */ new Error(`Change file is missing: ${path}`);
-	const non_empty_lines = content.split("\n").filter((line) => line.trim() !== "");
-	if (non_empty_lines.length === 0) return /* @__PURE__ */ new Error("Change file is empty");
-	const first_line = non_empty_lines[0].trim();
-	if (non_empty_lines.length === 1) return new ChangeFile({
-		slug: match.groups.slug,
-		kind: match.groups.kind,
-		summary: first_line
-	});
-	const remaining_lines = non_empty_lines.slice(1);
-	const invalid_lines = [];
-	remaining_lines.forEach((line, index) => {
-		if (!line.trim().match(/^[-*+]\s/)) invalid_lines.push(index + 2);
-	});
-	if (invalid_lines.length > 0) return /* @__PURE__ */ new Error(`Change file ${path} has invalid format: lines ${invalid_lines.join(", ")} should be list items (starting with -, *, or +)`);
-	const summary = [first_line, ...remaining_lines].join("\n");
+	let file_content = await read_file(path);
+	file_content = file_content?.trim() ?? null;
+	if (file_content === null) return /* @__PURE__ */ new Error(`Change file is missing: ${path}`);
+	if (!file_content) return /* @__PURE__ */ new Error("Change file is empty");
+	const [title, ...rest] = file_content.split("\n");
+	const text = [`- ${title}`, ...rest.map((line) => `  ${line}`)].join("\n");
 	return new ChangeFile({
 		slug: match.groups.slug,
 		kind: match.groups.kind,
-		summary
+		summary: text
 	});
 }
 async function find_change_files(folder, { allowed_kinds }) {
@@ -66,7 +56,10 @@ async function find_change_files(folder, { allowed_kinds }) {
 	for (const filename of files) {
 		const file_path = join(folder, filename);
 		const change_file_or_error = await parse_change_file(file_path);
-		if (change_file_or_error instanceof Error) continue;
+		if (change_file_or_error instanceof Error) {
+			warnings.push(`Change file ${file_path} is invalid: ${change_file_or_error.message}`);
+			continue;
+		}
 		const change_file = change_file_or_error;
 		if (!allowed_kinds.includes(change_file.kind)) {
 			warnings.push(`Change file ${file_path} has an invalid kind: ${change_file.kind}`);

package/dist/lib/commands/check.mjs

@@ -72,7 +72,7 @@ const check = create_command({
 		const valid = errors.length === 0;
 		if (valid) logger.success("All validations passed!");
 		else {
-			logger.error("Validation failed:");
+			logger.error("Detected errors:");
 			errors.forEach((err) => logger.error(`  ${err}`));
 		}
 		if (valid) return {
@@ -81,7 +81,7 @@ const check = create_command({
 		};
 		else return {
 			status: "error",
-			error: errors.join("; ")
+			error: "Validation failed"
 		};
 	}
 });

package/dist/lib/commands/generate-release-pr.mjs

@@ -1,14 +1,12 @@
 import { create_command } from "../cli.mjs";
 import { create_logger } from "../utils/logger.mjs";
-import { delete_file, read_file, write_file } from "../utils/fs.mjs";
+import { delete_all_files_from_folder, read_file, write_file } from "../utils/fs.mjs";
 import { find_nearest_config } from "../config.mjs";
 import { find_change_files } from "../change-file.mjs";
 import { diff, reset } from "../utils/git.mjs";
 import { compute_current_version } from "../utils/version.mjs";
+import { parse_markdown } from "../utils/mdast.mjs";
 import { join } from "node:path";
-import { fromMarkdown } from "mdast-util-from-markdown";
-import { gfmFromMarkdown } from "mdast-util-gfm";
-import { gfm } from "micromark-extension-gfm";
 
 //#region src/lib/commands/generate-release-pr.ts
 const generate_release_pr = create_command({
@@ -47,7 +45,8 @@ const generate_release_pr = create_command({
 			message: "No apps to release"
 		};
 		for (const app of filtered_applications) {
-			const changes = await find_change_files(join(config.changes_dir, app.name), { allowed_kinds: app.versioning.allowed_changes });
+			const changes_dir = join(config.changes_dir, app.name);
+			const changes = await find_change_files(changes_dir, { allowed_kinds: app.versioning.allowed_changes });
 			if (changes.warnings.length > 0) for (const warning of changes.warnings) logger.warn(warning);
 			const current_version = await compute_current_version(app, { get_file_content: (file_path) => read_file(file_path) }) ?? app.versioning.initial_version;
 			const next_version = app.versioning.bump({
@@ -66,14 +65,11 @@ const generate_release_pr = create_command({
 			for (const [kind, kind_changes] of changes_by_kind.entries()) {
 				const label = display_map[kind]?.plural ?? display_map[kind]?.singular ?? kind;
 				message_lines.push(`\n${label}:`);
-				for (const change of kind_changes) message_lines.push(`  • ${change.summary}`);
+				for (const change of kind_changes) message_lines.push(`  ${change.summary}`);
 			}
 			logger.note(`Release ${app.name} ${next_version}`, message_lines.join("\n"));
 			if (dry_run) continue;
-			for (const change of changes.list) {
-				const change_file_path = join(config.changes_dir, app.name, change.filename);
-				await delete_file(change_file_path);
-			}
+			await delete_all_files_from_folder(changes_dir);
 			for (const component of app.components) for (const part of component.parts) {
 				const initial_content = await read_file(part.file);
 				if (initial_content === null) continue;
@@ -81,11 +77,9 @@ const generate_release_pr = create_command({
 				await write_file(part.file, updated_content);
 			}
 			const formatter = app.versioning.formatter;
-			const changelog_as_mdast = fromMarkdown(await read_file(app.changelog) ?? "", {
-				extensions: [gfm()],
-				mdastExtensions: [gfmFromMarkdown()]
-			});
-			const changelog = formatter.transform_markdown(changelog_as_mdast);
+			const initial_changelog_content = await read_file(app.changelog);
+			const changelog_as_mdast = parse_markdown(initial_changelog_content ?? "");
+			const changelog = formatter.transform_markdown(changelog_as_mdast, initial_changelog_content ?? "");
 			const updated_changelog_content = formatter.format_changelog({
 				...changelog,
 				releases: [{

package/dist/lib/commands/manual-release.mjs

@@ -1,15 +1,13 @@
 import { create_command } from "../cli.mjs";
-import { delete_file, read_file, write_file } from "../utils/fs.mjs";
+import { delete_all_files_from_folder, read_file, write_file } from "../utils/fs.mjs";
 import { find_nearest_config } from "../config.mjs";
 import { find_change_files } from "../change-file.mjs";
 import { commit, create_tag, get_current_branch, get_head_and_parent_shas, get_staged_diff, has_uncommitted_changes, reset, stage_files, tag_exists } from "../utils/git.mjs";
 import { compute_current_version } from "../utils/version.mjs";
+import { parse_markdown } from "../utils/mdast.mjs";
 import { is_ci } from "../utils/branch-protection.mjs";
 import { cancel, confirm, intro, isCancel, log, note, outro, select, text } from "@clack/prompts";
 import { join } from "node:path";
-import { fromMarkdown } from "mdast-util-from-markdown";
-import { gfmFromMarkdown } from "mdast-util-gfm";
-import { gfm } from "micromark-extension-gfm";
 
 //#region src/lib/commands/manual-release.ts
 const manual_release = create_command({
@@ -128,14 +126,14 @@ const manual_release = create_command({
 			log.warn(`Could not check remote tag existence: ${error.message}`);
 			log.warn("Continuing with local tag check only...");
 		}
-		const changes_summary = changes.list.map((change) => `  • ${change.summary.split("\n").join("\n    ")}`).join("\n");
+		const changes_summary = changes.list.map((change) => `  ${change.summary.split("\n").join("\n  ")}`).join("\n");
 		note(`Manual release plan:
 - App: ${app_name}
 - Current version: ${current_version}
 - Next version: ${next_version}
 - Tag: ${tag}
 - Change files:
-${changes_summary}`, "Release details");
+${changes_summary || "  No changes in this release."}`, "Release details");
 		const proceed_confirmation = await confirm({
 			message: "Proceed with generating changelog and version bump?",
 			initialValue: false
@@ -146,12 +144,9 @@ ${changes_summary}`, "Release details");
 		}
 		const files_to_stage = [];
 		const changes_dir = join(config.changes_dir, app_name);
-		for (const change of changes.list) {
-			const change_file_path = join(changes_dir, change.filename);
-			await delete_file(change_file_path);
-			files_to_stage.push(change_file_path);
-		}
-		log.success("Deleted change files");
+		const deleted_change_files = await delete_all_files_from_folder(changes_dir);
+		files_to_stage.push(...deleted_change_files);
+		log.success(`Deleted ${deleted_change_files.length} change file(s)`);
 		for (const component of app.components) for (const part of component.parts) {
 			const initial_content = await read_file(part.file);
 			if (initial_content === null) continue;
@@ -161,11 +156,9 @@ ${changes_summary}`, "Release details");
 		}
 		log.success("Updated component versions");
 		const formatter = app.versioning.formatter;
-		const changelog_as_mdast = fromMarkdown(await read_file(app.changelog) ?? "", {
-			extensions: [gfm()],
-			mdastExtensions: [gfmFromMarkdown()]
-		});
-		const changelog = formatter.transform_markdown(changelog_as_mdast);
+		const initial_changelog_content = await read_file(app.changelog);
+		const changelog_as_mdast = parse_markdown(initial_changelog_content ?? "");
+		const changelog = formatter.transform_markdown(changelog_as_mdast, initial_changelog_content ?? "");
 		const updated_changelog_content = formatter.format_changelog({
 			...changelog,
 			releases: [{
@@ -195,7 +188,7 @@ ${changes_summary}`, "Release details");
 		if (diff) note(diff, "Changes to be committed");
 		const confirm_commit = await confirm({
 			message: "Review the changes above. Proceed with commit?",
-			initialValue: true
+			initialValue: false
 		});
 		if (isCancel(confirm_commit) || !confirm_commit) {
 			await reset(root);

package/dist/lib/config.mjs

@@ -69,7 +69,7 @@ const CONFIG_CANDIDATES = [
 	"auto-release.config.ts",
 	"auto-release.config.mts",
 	"auto-release.config.cts",
-	"auto-release.config.ts",
+	"auto-release.config.js",
 	"auto-release.config.mjs",
 	"auto-release.config.cjs"
 ];

package/dist/lib/formatter.mjs

@@ -1,11 +1,7 @@
 import { ChangeFile } from "./change-file.mjs";
+import { as_text, to_plain_text } from "./utils/mdast.mjs";
 
 //#region src/lib/formatter.ts
-function to_plain_text(node) {
-	if ("children" in node && Array.isArray(node.children)) return node.children.map((child) => to_plain_text(child)).join("");
-	if ("value" in node && typeof node.value === "string") return node.value;
-	return "";
-}
 function normalize_label(label) {
 	return label.trim().toLowerCase();
 }
@@ -20,13 +16,6 @@ function resolve_change_kind({ heading_text, allowed_changes, display_map }) {
 	}
 	return null;
 }
-function extract_list_item_text(item) {
-	const [title, ...description] = to_plain_text(item).trim().split("\n").map((line) => line.trim()).filter(Boolean);
-	return {
-		title: title ?? "",
-		description
-	};
-}
 function create_empty_changelog() {
 	return {
 		root: {
@@ -46,7 +35,7 @@ function default_formatter({ allowed_changes, display_map }) {
 		return map;
 	}, {});
 	return {
-		transform_markdown(tree) {
+		transform_markdown(tree, original_text) {
 			const changelog = create_empty_changelog();
 			let current_release = null;
 			let current_kind = null;
@@ -55,7 +44,7 @@ function default_formatter({ allowed_changes, display_map }) {
 			};
 			for (const node of tree.children) {
 				if (node.type === "heading" && node.depth === 1) {
-					changelog.root.title = to_plain_text(node).trim();
+					changelog.root.title = as_text(node);
 					continue;
 				}
 				if (node.type === "heading" && node.depth === 2) {
@@ -78,17 +67,19 @@ function default_formatter({ allowed_changes, display_map }) {
 				if (node.type === "list" && current_release) {
 					const kind_for_items = current_kind ?? allowed_changes[0] ?? "default";
 					for (const item of node.children) {
-						const { title } = extract_list_item_text(item);
-						if (!title) continue;
+						const start = item.position?.start.offset ?? 0;
+						const end = item.position?.end.offset ?? 0;
+						const summary = original_text.slice(start, end).trim();
+						if (!summary) continue;
 						current_release.changes.push(new ChangeFile({
 							kind: kind_for_items,
-							summary: title
+							summary
 						}));
 					}
 					continue;
 				}
 				if (!current_release && node.type === "paragraph") {
-					const text = to_plain_text(node).trim();
+					const text = as_text(node);
 					if (text) changelog.root.description.push(text);
 				}
 			}
@@ -97,10 +88,12 @@ function default_formatter({ allowed_changes, display_map }) {
 		},
 		format_changelog(changelog, context) {
 			const lines = [];
-			if (changelog.root.title) lines.push(`# ${changelog.root.title}`);
-			else lines.push(`# \`${context.app.name}\` Changelog`);
-			if (changelog.root.description.length > 0) lines.push(changelog.root.description.join("\n"));
-			else lines.push(`This is the changelog for \`${context.app.name}\`.`);
+			if (changelog.root.title) lines.push(changelog.root.title);
+			else lines.push(`# \`${context.app.name}\` changelog`);
+			if (changelog.root.description.length > 0) {
+				console.log(changelog.root.description);
+				lines.push(changelog.root.description.join("\n"));
+			} else lines.push(`This is the changelog for \`${context.app.name}\`.`);
 			for (const release of changelog.releases) {
 				const release_lines = [`## ${release.version}`, ""];
 				for (const change_kind of allowed_changes) {
@@ -109,9 +102,9 @@ function default_formatter({ allowed_changes, display_map }) {
 					const labels = resolved_display_map[change_kind];
 					const heading = labels?.plural ?? labels?.singular ?? change_kind;
 					release_lines.push(`### ${heading}`, "");
-					for (const change of kind_changes) release_lines.push(`- ${change.summary.split("\n").join("\n  ")}`, "");
+					for (const change of kind_changes) release_lines.push(change.summary, "");
 				}
-				if (release.changes.length === 0) release_lines.push("No changes in this release.");
+				if (release.changes.length === 0) release_lines.push("No changes in this release.", "");
 				lines.push(release_lines.join("\n"));
 			}
 			return lines.join("\n\n");
@@ -138,7 +131,10 @@ function default_formatter({ allowed_changes, display_map }) {
 				const heading = labels?.plural ?? labels?.singular ?? kind;
 				lines.push("");
 				lines.push(`## ${heading}`);
-				for (const change of items) lines.push(`- ${change.summary}`);
+				for (const change of items) {
+					lines.push(change.summary);
+					lines.push("");
+				}
 			}
 			if (grouped.size === 0) {
 				lines.push("");

package/dist/lib/utils/fs.mjs

@@ -30,6 +30,16 @@ async function delete_file(path) {
 		throw new Error(`Failed to delete file ${path}`, { cause: error });
 	}
 }
+async function delete_all_files_from_folder(folder) {
+	const files = await list_files(folder);
+	const deleted_files = [];
+	for (const file of files) {
+		const file_path = join(folder, file);
+		await delete_file(file_path);
+		deleted_files.push(file_path);
+	}
+	return deleted_files;
+}
 async function list_files(dir, options) {
 	try {
 		const files = await readdir(dir);
@@ -61,4 +71,4 @@ async function list_files(dir, options) {
 }
 
 //#endregion
-export { delete_file, exists, list_files, read_file, write_file };
+export { delete_all_files_from_folder, exists, list_files, read_file, write_file };

package/dist/lib/utils/git.mjs

@@ -194,7 +194,7 @@ async function get_staged_diff(cwd) {
 	const options = cwd ? { cwd } : void 0;
 	try {
 		const { stdout } = await exec("git diff --cached --stat", options);
-		return stdout.trim();
+		return stdout;
 	} catch {
 		return "";
 	}

package/dist/lib/utils/mdast.mjs

@@ -0,0 +1,27 @@
+import { toMarkdown } from "mdast-util-to-markdown";
+import { gfmFromMarkdown, gfmToMarkdown } from "mdast-util-gfm";
+import { fromMarkdown } from "mdast-util-from-markdown";
+import { gfm } from "micromark-extension-gfm";
+
+//#region src/lib/utils/mdast.ts
+function as_text(node, options) {
+	return toMarkdown(node, {
+		extensions: [gfmToMarkdown()],
+		bullet: "-",
+		...options
+	}).trim();
+}
+function parse_markdown(text) {
+	return fromMarkdown(text, {
+		extensions: [gfm()],
+		mdastExtensions: [gfmFromMarkdown()]
+	});
+}
+function to_plain_text(node) {
+	if ("children" in node && Array.isArray(node.children)) return node.children.map((child) => to_plain_text(child)).join("");
+	if ("value" in node && typeof node.value === "string") return node.value;
+	return "";
+}
+
+//#endregion
+export { as_text, parse_markdown, to_plain_text };

package/dist/lib/versioning/types.d.mts

@@ -17,7 +17,7 @@ type Formatter<change_kinds extends string = string, parsed_changelog extends {
    * Transform the mdast tree into a custom changelog data structure.
    * @param tree - The markdown tree to transform
    */
-  transform_markdown(tree: Root): parsed_changelog;
+  transform_markdown(tree: Root, original_text: string): parsed_changelog;
   /**
    * Format the changelog data into markdown.
    * The changelog releases will be sorted by version in ascending order automatically.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@afoures/auto-release",
-  "version": "0.2.10",
+  "version": "0.2.12",
   "description": "A file based release management tool for monorepos",
   "homepage": "https://github.com/afoures/auto-release#readme",
   "bugs": {