ci: add custom changelog formatter (#90)

* ci: add custom changelog formatter

* add changeset to ensure custom generator runs

Author: dominikg

.changeset/angry-emus-study.md

@@ -0,0 +1,5 @@
+---
+'@sveltejs/vite-plugin-svelte': patch
+---
+
+customize changelog format

.changeset/config.json

@@ -1,11 +1,11 @@
 {
   "$schema": "https://unpkg.com/@changesets/[email protected]/schema.json",
-  "changelog": ["@changesets/changelog-github", { "repo": "sveltejs/vite-plugin-svelte" }],
+  "changelog": ["scripts/changelog-github-custom.js", { "repo": "sveltejs/vite-plugin-svelte" }],
   "commit": false,
   "linked": [],
   "access": "public",
   "baseBranch": "main",
   "updateInternalDependencies": "patch",
-  "ignore": ["playground**"]
+  "ignore": ["playground**","e2e-test**"]
 }
 

package.json

@@ -23,8 +23,8 @@
     "prepare": "husky install"
   },
   "devDependencies": {
-    "@changesets/changelog-github": "^0.4.0",
     "@changesets/cli": "^2.16.0",
+    "@changesets/get-github-info": "^0.5.0",
     "@types/fs-extra": "^9.0.12",
     "@types/jest": "^26.0.24",
     "@types/node": "^16.3.0",
@@ -33,6 +33,7 @@
     "@typescript-eslint/parser": "^4.28.2",
     "chalk": "^4.1.1",
     "cross-env": "^7.0.3",
+    "dotenv": "^10.0.0",
     "enquirer": "^2.3.6",
     "esbuild": "^0.12.15",
     "eslint": "^7.30.0",

pnpm-lock.yaml

@@ -0,0 +1,109 @@
+// based on https://github.com/atlassian/changesets/blob/main/packages/changelog-github/src/index.ts
+// modifications to improve readability:
+// - removed thanks notes. We're thanking contributors in the PRs or acknowledge their work in different ways
+// - moved issue links to end of first line
+
+import { config } from 'dotenv';
+import { getInfo, getInfoFromPullRequest } from '@changesets/get-github-info';
+
+config();
+
+const changelogFunctions = {
+	getDependencyReleaseLine: async (changesets, dependenciesUpdated, options) => {
+		if (!options.repo) {
+			throw new Error(
+				'Please provide a repo to this changelog generator like this:\n"changelog": ["@changesets/changelog-github", { "repo": "org/repo" }]'
+			);
+		}
+		if (dependenciesUpdated.length === 0) return '';
+
+		const changesetLink = `- Updated dependencies [${(
+			await Promise.all(
+				changesets.map(async (cs) => {
+					if (cs.commit) {
+						let { links } = await getInfo({
+							repo: options.repo,
+							commit: cs.commit
+						});
+						return links.commit;
+					}
+				})
+			)
+		)
+			.filter((_) => _)
+			.join(', ')}]:`;
+
+		const updatedDepenenciesList = dependenciesUpdated.map(
+			(dependency) => `  - ${dependency.name}@${dependency.newVersion}`
+		);
+
+		return [changesetLink, ...updatedDepenenciesList].join('\n');
+	},
+	getReleaseLine: async (changeset, type, options) => {
+		if (!options || !options.repo) {
+			throw new Error(
+				'Please provide a repo to this changelog generator like this:\n"changelog": ["@changesets/changelog-github", { "repo": "org/repo" }]'
+			);
+		}
+
+		let prFromSummary;
+		let commitFromSummary;
+		let usersFromSummary;
+
+		const replacedChangelog = changeset.summary
+			.replace(/^\s*(?:pr|pull|pull\s+request):\s*#?(\d+)/im, (_, pr) => {
+				let num = Number(pr);
+				if (!isNaN(num)) prFromSummary = num;
+				return '';
+			})
+			.replace(/^\s*commit:\s*([^\s]+)/im, (_, commit) => {
+				commitFromSummary = commit;
+				return '';
+			})
+			.replace(/^\s*(?:author|user):\s*@?([^\s]+)/gim, (_, user) => {
+				usersFromSummary.push(user);
+				return '';
+			})
+			.trim();
+
+		const [firstLine, ...futureLines] = replacedChangelog.split('\n').map((l) => l.trimRight());
+
+		const links = await (async () => {
+			if (prFromSummary !== undefined) {
+				let { links } = await getInfoFromPullRequest({
+					repo: options.repo,
+					pull: prFromSummary
+				});
+				if (commitFromSummary) {
+					links = {
+						...links,
+						commit: `[\`${commitFromSummary}\`](https://github.com/${options.repo}/commit/${commitFromSummary})`
+					};
+				}
+				return links;
+			}
+			const commitToFetchFrom = commitFromSummary || changeset.commit;
+			if (commitToFetchFrom) {
+				let { links } = await getInfo({
+					repo: options.repo,
+					commit: commitToFetchFrom
+				});
+				return links;
+			}
+			return {
+				commit: null,
+				pull: null,
+				user: null
+			};
+		})();
+
+		const suffix = [
+			links.pull === null ? '' : ` (${links.pull})`,
+			links.commit === null ? '' : ` (${links.commit})`
+		].join('');
+
+		return `\n\n- ${firstLine}${suffix}\n${futureLines.map((l) => `  ${l}`).join('\n')}`;
+	}
+};
+
+export default changelogFunctions;