Add a new parsing engine, supporting repos without Releases

As a result, add support for svelte-preprocess, rollup-plugin-svelte and prettier-plugin-svelte

Author: WarningImHack3r

README.md

@@ -34,12 +34,12 @@ If you think I missed a package, you can either open an issue or directly contri
 - Must be by the Svelte team or their members
 - Must be on GitHub
 - Must _not_ be an internal package used only by the Svelte team
-- Must have releases on GitHub
+- Must either have releases on GitHub or at least have tags and a `CHANGELOG.md` file at the root of the repository
 
 ### How to contribute
 
 Fork the repo, edit the `/src/routes/+layout.ts` file, and open a PR.  
-**If the repo is not from the `sveltejs` organization, please open an issue instead.**
+**If the repo is not in the `sveltejs` GitHub organization, please open an issue instead.**
 
 The code architecture is made to be as flexible as possible, here's how it works:
 
@@ -54,13 +54,15 @@ const repos: Record<Tab, { name: string; repos: Repo[] }> = {
                 ...
             },
             {
+                changesMode: "releases", // Optional line, the way to get the changes; either "releases" or "changelog", defaults to "releases"
                 repoName: "your-repo", // The name of the repo on GitHub, as it appears in the URL: https://github.com/sveltejs/your-repo
                 dataFilter: ({ tag_name }) => true, // Optional line, return false to exclude a version from its tag name
-                versionFromTag: tag => "..." // Return the version from the tag name; must be a valid semver
+                versionFromTag: tag => "...", // Return the version from the tag name; must be a valid semver
+                changelogContentsReplacer: contents => contents, // Optional line, replace the contents of the changelog file before parsing it; only used if `changesMode` is "changelog"
             }
         ]
     }
 };
 ```
 
-And that's it! The rest of the site will automatically adapt to the new package(s).
+And that's it! The site will automatically adapt to the new package(s).

src/lib/news/news.json

@@ -15,6 +15,11 @@
 			"id": 2,
 			"content": "Manual token authentication is no more: you can now use the new, shiny \"Login with GitHub\" button!",
 			"endDate": "2024-09-09"
+		},
+		{
+			"id": 3,
+			"content": "New! Improved engine brings support for svelte-preprocess, rollup-plugin-svelte and prettier-plugin-svelte",
+			"endDate": "2024-09-09"
 		}
 	]
 }

src/lib/parsers/changelog-parser.ts

@@ -0,0 +1,194 @@
+// Gently stolen from https://github.com/fl-client/changelog-parser as this “fixed” version
+// is not available on npm.
+// Removed the `filePath` option as I don't need it, bring in the types and fix the linting errors.
+
+const EOL = "\n";
+
+// patterns
+const semver = /\[?v?([\w.-]+\.[\w.-]+[a-zA-Z0-9])]?/;
+const date = /.* \(?(\d\d?\d?\d?[-/.]\d\d?[-/.]\d\d?\d?\d?)\)?.*/;
+const subhead = /^###/;
+const listItem = /^[*-]/;
+
+type Changelog = {
+	title: string;
+	description: string;
+	versions: {
+		version: string | null;
+		title: string;
+		date: string | null;
+		body: string;
+		parsed: Record<string, string[]>;
+	}[];
+};
+
+type PrivateVersion = Changelog["versions"][number] & {
+	_private?: {
+		activeSubhead: string | null;
+	};
+};
+
+type ProcessingData = {
+	log: Changelog;
+	current: PrivateVersion | null;
+};
+
+/**
+ * Changelog parser.
+ *
+ * @param text changelog text
+ * @param callback optional callback
+ * @returns parsed changelog object
+ */
+export default function parseChangelog(
+	text: string,
+	callback?: (error: string | null, result?: Changelog) => void
+): Promise<Changelog> {
+	const changelog = parse(text);
+
+	if (typeof callback === "function") {
+		changelog.then(log => callback(null, log)).catch((err: string) => callback(err));
+	}
+
+	// otherwise, invoke callback
+	return changelog;
+}
+
+/**
+ * Internal parsing logic.
+ *
+ * @param text the changelog text
+ * @returns the parsed changelog object
+ */
+function parse(text: string): Promise<Changelog> {
+	let data: ReturnType<typeof handleLine> = {
+		log: {
+			title: "",
+			description: "",
+			versions: []
+		},
+		current: null
+	};
+
+	return new Promise(resolve => {
+		function done() {
+			// push last version into log
+			if (data.current) {
+				pushCurrent(data);
+			}
+
+			// clean up description
+			data.log.description = clean(data.log.description);
+
+			resolve(data.log);
+		}
+
+		if (text) {
+			text.split(/\r\n?|\n/gm).forEach(line => (data = handleLine(line, data)));
+			done();
+		}
+	});
+}
+
+/**
+ * Handles each line and mutates the data object (bound to `this`) as needed.
+ *
+ * @param line line from the changelog file
+ * @param data the current processing data
+ */
+function handleLine(line: string, data: ProcessingData): ProcessingData {
+	// skip line if it's a link label
+	if (RegExp(/^\[[^[\]]*] *?:/).exec(line)) return data;
+
+	// set the title if it's there
+	if (!data.log.title && RegExp(/^# ?[^#]/).exec(line)) {
+		data.log.title = line.substring(1).trim();
+		return data;
+	}
+
+	// new version found!
+	if (RegExp(/^##? ?[^#]/).exec(line)) {
+		if (data.current?.title) pushCurrent(data);
+
+		data.current = versionFactory();
+
+		if (semver.exec(line)) data.current.version = semver.exec(line)?.at(1) ?? null;
+
+		data.current.title = line.substring(2).trim();
+
+		if (data.current.title && date.exec(data.current.title))
+			data.current.date = date.exec(data.current.title)?.at(1) ?? null;
+
+		return data;
+	}
+
+	// deal with body or description content
+	if (data.current) {
+		data.current.body += line + EOL;
+
+		// handle case where current line is a 'subhead':
+		// - 'handleize' subhead.
+		// - add subhead to 'parsed' data if not already present.
+		if (subhead.exec(line)) {
+			const key = line.replace("###", "").trim();
+
+			if (!data.current.parsed[key]) {
+				data.current.parsed[key] = [];
+				data.current._private ||= { activeSubhead: key };
+			}
+		}
+
+		// handle case where current line is a 'list item':
+		if (listItem.exec(line)) {
+			// add line to 'catch all' array
+			data.current.parsed._?.push(line);
+
+			// add line to 'active subhead' if applicable (eg. 'Added', 'Changed', etc.)
+			if (data.current._private?.activeSubhead) {
+				data.current.parsed[data.current._private.activeSubhead]?.push(line);
+			}
+		}
+	} else {
+		data.log.description = (data.log.description || "") + line + EOL;
+	}
+
+	return data;
+}
+
+function versionFactory(): PrivateVersion {
+	return {
+		version: null,
+		title: "",
+		date: null,
+		body: "",
+		parsed: {
+			_: []
+		},
+		_private: {
+			activeSubhead: null
+		}
+	};
+}
+
+function pushCurrent(data: ProcessingData) {
+	if (!data.current) return;
+	// remove private properties
+	delete data.current._private;
+
+	data.current.body = clean(data.current.body);
+	data.log.versions.push(data.current);
+}
+
+function clean(str: string) {
+	if (!str) return "";
+
+	return (
+		str
+			// trim
+			.trim()
+			// remove leading newlines
+			.replace(new RegExp("[" + EOL + "]*"), "")
+			// remove trailing newlines
+			.replace(new RegExp("[" + EOL + "]*$"), "")
+	);
+}

src/lib/types.ts

@@ -1,4 +1,10 @@
 export type Repo = {
+	/**
+	 * Mode to fetch the releases of the repo.
+	 * - `releases`: Fetches from the Releases page
+	 * - `changelog`: Fetches the changelog of the repo, if available
+	 */
+	changesMode?: "releases" | "changelog";
 	/**
 	 * Repository name on GitHub
 	 */
@@ -17,6 +23,14 @@ export type Repo = {
 	 * @param tag The tag name to extract the version from
 	 */
 	versionFromTag: (tag: string) => string;
+	/**
+	 * Replaces the contents of the changelog file.
+	 * Only used when `changesMode` is set to `changelog`.
+	 * By default, no replacement is performed.
+	 *
+	 * @param file The contents of the changelog file
+	 */
+	changelogContentsReplacer?: (file: string) => string;
 };
 
 export const availableTabs = ["svelte", "kit", "others"] as const;

src/routes/+layout.ts

@@ -55,6 +55,22 @@ const repos: Record<Tab, { name: string; repos: Repo[] }> = {
 			{
 				repoName: "svelte-devtools",
 				versionFromTag: tag => tag.replace(/^v/, "")
+			},
+			{
+				changesMode: "changelog",
+				repoName: "svelte-preprocess",
+				versionFromTag: tag => tag.replace(/^v/, ""),
+				changelogContentsReplacer: file => file.replace(/^# \[/gm, "## [")
+			},
+			{
+				changesMode: "changelog",
+				repoName: "rollup-plugin-svelte",
+				versionFromTag: tag => tag.replace(/^v/, "")
+			},
+			{
+				changesMode: "changelog",
+				repoName: "prettier-plugin-svelte",
+				versionFromTag: tag => tag.replace(/^v/, "")
 			}
 		]
 	}