keepachangelog-fmt 0.1.0

package/README.md

@@ -0,0 +1,23 @@
+# tsdown-starter
+
+A starter for creating a TypeScript package.
+
+## Development
+
+- Install dependencies:
+
+```bash
+npm install
+```
+
+- Run the unit tests:
+
+```bash
+npm run test
+```
+
+- Build the library:
+
+```bash
+npm run build
+```

package/dist/index.d.mts

@@ -0,0 +1 @@
+export { };

package/dist/index.mjs

@@ -0,0 +1,154 @@
+import fs from "node:fs/promises";
+//#region src/constants.ts
+const RELEASE_HEADING_REGEX = /^## \[(.+)\](?=(?: - (\d{4}-\d{2}-\d{2})?\s?(?:\((.+)\))?)?$)/;
+//#endregion
+//#region src/parse.ts
+const SECTION_TITLES = [
+	"Added",
+	"Changed",
+	"Removed",
+	"Fixed"
+];
+const isTitleHeading = (line) => line.startsWith("# ");
+const isReleaseHeading = (line) => line.startsWith("## [");
+const isSectionHeading = (line) => line.startsWith("### ") && SECTION_TITLES.includes(line.replace("### ", ""));
+const isEmptyLine = (line) => line === "";
+const isValidPreambleLine = (line) => !isTitleHeading(line) && !isReleaseHeading(line) && !isSectionHeading(line);
+const isBullet = (line) => line.startsWith("- ");
+const removeTrailingNewLines = (lines) => {
+	let newArray = [...lines];
+	while (isEmptyLine(newArray[0])) newArray = newArray.slice(1);
+	while (isEmptyLine(newArray[newArray.length - 1])) newArray = newArray.slice(0, -1);
+	return newArray;
+};
+function parse(text) {
+	const changelog = {
+		type: "changelog",
+		title: "# Changelog",
+		preamble: [],
+		releases: []
+	};
+	const lines = text.split("\n");
+	let lineNumber = 0;
+	const parseTitle = () => {
+		const titleLine = lines[lineNumber];
+		if (isTitleHeading(titleLine)) {
+			changelog.title = titleLine;
+			lineNumber++;
+		}
+	};
+	const parsePreamble = () => {
+		while (lineNumber < lines.length) {
+			const line = lines[lineNumber];
+			if (!isValidPreambleLine(line)) break;
+			changelog.preamble.push(line);
+			lineNumber++;
+		}
+		changelog.preamble = removeTrailingNewLines(changelog.preamble);
+	};
+	const parseChanges = () => {
+		const changes = [];
+		while (lineNumber < lines.length) {
+			const line = lines[lineNumber];
+			if (isEmptyLine(line)) {
+				lineNumber++;
+				continue;
+			}
+			if (!isBullet(line)) break;
+			changes.push({
+				type: "change",
+				text: [line.replace("- ", "")]
+			});
+			lineNumber++;
+		}
+		return changes;
+	};
+	const parseSection = () => {
+		const title = lines[lineNumber].replace("### ", "");
+		lineNumber++;
+		return {
+			type: "section",
+			title,
+			changes: parseChanges()
+		};
+	};
+	const parseSections = () => {
+		const sections = [];
+		while (lineNumber < lines.length) {
+			const line = lines[lineNumber];
+			if (isEmptyLine(line)) {
+				lineNumber++;
+				continue;
+			}
+			if (!isSectionHeading(line)) break;
+			sections.push(parseSection());
+		}
+		return sections;
+	};
+	const parseRelease = () => {
+		const line = lines[lineNumber];
+		const matches = RELEASE_HEADING_REGEX.exec(line.trim());
+		if (!matches) throw new Error(`Invalid release heading on line ${lineNumber}: "${line}"`);
+		const [_, version, date, label] = matches;
+		lineNumber++;
+		const release = {
+			type: "release",
+			version,
+			date,
+			label,
+			sections: parseSections()
+		};
+		changelog.releases.push(release);
+	};
+	const parseReleases = () => {
+		while (lineNumber < lines.length) {
+			const line = lines[lineNumber];
+			if (isEmptyLine(line)) {
+				lineNumber++;
+				continue;
+			}
+			if (!isReleaseHeading(line)) {
+				lineNumber++;
+				break;
+			}
+			parseRelease();
+		}
+	};
+	parseTitle();
+	parsePreamble();
+	parseReleases();
+	return changelog;
+}
+//#endregion
+//#region src/format.ts
+function format(changelog) {
+	const preambleText = changelog.preamble.length !== 0 ? `\n\n${changelog.preamble.join("\n")}\n` : "";
+	const releasesText = changelog.releases.map((release) => {
+		let title = `## [${release.version.trim()}]`;
+		if (release.date || release.label) {
+			title += " -";
+			if (release.date) title += ` ${release.date}`;
+			if (release.label) title += ` (${release.label.trim()})`;
+		}
+		const sections = release.sections.map((section) => {
+			const title = `### ${section.title.trim()}`;
+			const changes = section.changes.map((change) => {
+				const line = change.text[0].trim();
+				return `- ${line}${line[line.length - 1] === "." ? "" : "."}`;
+			}).join("\n");
+			if (changes === "") return title;
+			return `${title}\n\n${changes}`;
+		}).join("\n\n");
+		return `${title}\n\n${sections}`;
+	}).join("\n\n\n");
+	return `${changelog.title}${preambleText}\n\n${releasesText}\n`;
+}
+//#endregion
+//#region src/index.ts
+async function main() {
+	const formatted = format(parse(await fs.readFile("CHANGELOG.md", { encoding: "utf8" })));
+	await fs.writeFile("CHANGELOG.md", formatted, { encoding: "utf8" });
+}
+main();
+//#endregion
+export {};

package/package.json

@@ -0,0 +1,33 @@
+{
+	"name": "keepachangelog-fmt",
+	"type": "module",
+	"version": "0.1.0",
+	"description": "A formatter for changelogs following the \"keep a changelog\" format.",
+	"author": "Bram <bram@brams.dev>",
+	"license": "MIT",
+	"exports": {
+		".": "./dist/index.mjs",
+		"./package.json": "./package.json"
+	},
+	"files": [
+		"dist"
+	],
+	"scripts": {
+		"build": "tsdown",
+		"dev": "tsdown --watch",
+		"test": "vitest",
+		"typecheck": "tsc --noEmit",
+		"release": "bumpp",
+		"prepublishOnly": "pnpm run build",
+		"publish": "npm publish",
+		"format": "bun run src/index.ts"
+	},
+	"devDependencies": {
+		"@types/node": "^25.5.0",
+		"@typescript/native-preview": "7.0.0-dev.20260328.1",
+		"bumpp": "^11.0.1",
+		"tsdown": "^0.21.7",
+		"typescript": "^6.0.2",
+		"vitest": "^4.1.3"
+	}
+}