feat(repos): transition to a built-in way to get the package names alongside the versions

Author: WarningImHack3r

README.md

@@ -63,9 +63,9 @@ Fork the repo, edit the `/src/lib/repositories.ts` file, and open a PR.
 The code architecture is made to be as flexible as possible, here's how it works:
 
 ```typescript
-const repos: Record<Tab, { name: string; repos: Repo[] }> = {
-    svelte: ...,
-    kit: ...,
+const repos = {
+    svelte: {/* ... */},
+    kit: {/* ... */},
     others: {
         name: "Other",
         repos: [
@@ -76,7 +76,7 @@ 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
+                metadataFromTag: tag => ["package-name", "2.4.3"], // Return the package name and version from the tag name; the version must be a valid semver without any leading "v"
                 changelogContentsReplacer: contents => contents, // Optional line, replace the contents of the changelog file before parsing it; only used if `changesMode` is "changelog"
             }
         ]

src/lib/repositories.ts

@@ -1,12 +1,12 @@
-import type { Repo, Tab } from "$lib/types";
+import type { RepoInfo, Category } from "$lib/types";
 
-const repos: Record<Tab, { name: string; repos: Repo[] }> = {
+const repos: Record<Category, { name: string; repos: RepoInfo[] }> = {
 	svelte: {
 		name: "Svelte",
 		repos: [
 			{
 				repoName: "svelte",
-				versionFromTag: tag => tag.substring(tag.indexOf("@") + 1)
+				metadataFromTag: splitByLastAt
 			}
 		]
 	},
@@ -16,7 +16,7 @@ const repos: Record<Tab, { name: string; repos: Repo[] }> = {
 			{
 				repoName: "kit",
 				dataFilter: ({ tag_name }) => tag_name.includes("/kit@"),
-				versionFromTag: tag => tag.substring(tag.lastIndexOf("@") + 1)
+				metadataFromTag: splitByLastAt
 			}
 		]
 	},
@@ -26,72 +26,111 @@ const repos: Record<Tab, { name: string; repos: Repo[] }> = {
 			{
 				repoName: "kit",
 				dataFilter: ({ tag_name }) => !tag_name.includes("/kit@"),
-				versionFromTag: tag => tag.substring(tag.lastIndexOf("@") + 1)
+				metadataFromTag: splitByLastAt
 			},
 			{
 				repoName: "cli",
-				versionFromTag: tag => tag.substring(tag.lastIndexOf("@") + 1)
+				metadataFromTag: splitByLastAt
 			},
 			{
 				repoName: "vite-plugin-svelte",
-				versionFromTag: tag => tag.substring(tag.lastIndexOf("@") + 1)
+				metadataFromTag: splitByLastAt
 			},
 			{
 				repoName: "eslint-plugin-svelte",
-				versionFromTag: tag =>
-					tag.includes("@") ? tag.substring(tag.lastIndexOf("@") + 1) : tag.replace(/^v/, "")
+				metadataFromTag(tag) {
+					if (tag.includes("@")) {
+						return splitByLastAt(tag);
+					}
+					return [this.repoName, tag.replace(/^v/, "")];
+				}
 			},
 			{
 				repoName: "eslint-config",
-				versionFromTag: tag => tag.replace(/^v/, "")
+				metadataFromTag(tag) {
+					return [this.repoName, tag.replace(/^v/, "")];
+				}
 			},
 			{
 				repoName: "svelte-eslint-parser",
-				versionFromTag: tag => tag.replace(/^v/, "")
+				metadataFromTag(tag) {
+					return [this.repoName, tag.replace(/^v/, "")];
+				}
 			},
 			{
 				repoName: "language-tools",
-				versionFromTag: tag => tag.substring(tag.lastIndexOf("-") + 1)
+				metadataFromTag: tag => {
+					const lastIndex = tag.lastIndexOf("-");
+					return [tag.substring(0, lastIndex), tag.substring(lastIndex + 1)];
+				}
 			},
 			{
 				repoName: "acorn-typescript",
-				versionFromTag: tag => tag.replace(/^v/, "")
+				metadataFromTag(tag) {
+					return [this.repoName, tag.replace(/^v/, "")];
+				}
 			},
 			{
 				repoName: "svelte-devtools",
-				versionFromTag: tag => tag.replace(/^v/, "")
+				metadataFromTag(tag) {
+					return [this.repoName, tag.replace(/^v/, "")];
+				}
 			},
 			{
 				changesMode: "changelog",
 				repoName: "svelte-preprocess",
-				versionFromTag: tag => tag.replace(/^v/, ""),
+				metadataFromTag(tag) {
+					return [this.repoName, tag.replace(/^v/, "")];
+				},
 				changelogContentsReplacer: file => file.replace(/^# \[/gm, "## [")
 			},
 			{
 				changesMode: "changelog",
 				repoName: "rollup-plugin-svelte",
-				versionFromTag: tag => tag.replace(/^v/, "")
+				metadataFromTag(tag) {
+					return [this.repoName, tag.replace(/^v/, "")];
+				}
 			},
 			{
 				changesMode: "changelog",
 				repoName: "prettier-plugin-svelte",
-				versionFromTag: tag => tag.replace(/^v/, "")
+				metadataFromTag(tag) {
+					return [this.repoName, tag.replace(/^v/, "")];
+				}
 			}
 		]
 	}
 };
 
+/**
+ * A convenience helper to split a string into two parts
+ * from its last occurrence of the `@` symbol.
+ *
+ * @param s the input string
+ * @returns an array of length 2 with the two split elements
+ */
+function splitByLastAt(s: string): [string, string] {
+	const lastIndex = s.lastIndexOf("@");
+	return [s.substring(0, lastIndex), s.substring(lastIndex + 1)];
+}
+
 type Entries<T> = {
 	[K in keyof T]: [K, T[K]];
 }[keyof T][];
 
 /**
- * Returns repositories as entries for ease of use
- * and iterating.
+ * Get all repositories as entries for ease of use
+ * and iteration.
  *
  * @example
- * const [id, { name, repos }] = getRepositories();
+ * const [id, { name, repos }] = repositories;
  */
-export function getRepositories() {
-	return Object.entries(repos) as unknown as Entries<typeof repos>;
-}
+export const repositories = Object.entries(repos) as unknown as Entries<typeof repos>;
+
+/**
+ * Get all a record of all GitHub repositories
+ * from the collection.
+ */
+export const githubRepos = {
+	sveltejs: [...new Set(repositories.flatMap(([, { repos }]) => repos.map(r => r.repoName)))]
+};

src/lib/types.ts

@@ -1,6 +1,6 @@
 import type { GitHubRelease } from "$lib/server/github-cache";
 
-export type Repo = {
+export type RepoInfo = {
 	/**
 	 * Mode to fetch the releases of the repo.
 	 * - `releases`: Fetches from the Releases page
@@ -16,23 +16,26 @@ export type Repo = {
 	 * If it returns false, the release is filtered out.
 	 *
 	 * @param release The release to filter
+	 * @returns whether we want to keep the release
 	 */
 	dataFilter?: (release: GitHubRelease) => boolean;
 	/**
-	 * Extracts the version from the tag name.
+	 * Extracts the package name and version from the tag name.
 	 *
-	 * @param tag The tag name to extract the version from
+	 * @param tag The tag name to extract the name and version from
+	 * @returns an array with the package name, and the package version
 	 */
-	versionFromTag: (tag: string) => string;
+	metadataFromTag: (tag: string) => [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
+	 * @returns the modified contents
 	 */
 	changelogContentsReplacer?: (file: string) => string;
 };
 
-export const availableTabs = ["svelte", "kit", "others"] as const;
-export type Tab = (typeof availableTabs)[number];
+export const availableCategory = ["svelte", "kit", "others"] as const;
+export type Category = (typeof availableCategory)[number];

src/routes/+layout.ts

@@ -1,8 +1,8 @@
 import { injectSpeedInsights } from "@vercel/speed-insights/sveltekit";
-import { getRepositories } from "$lib/repositories";
+import { repositories } from "$lib/repositories";
 
 injectSpeedInsights();
 
 export function load() {
-	return { repos: getRepositories() };
+	return { repos: repositories };
 }

src/routes/cron/+server.ts

@@ -1,17 +1,14 @@
 import { error, type RequestHandler } from "@sveltejs/kit";
 import { CRON_SECRET } from "$env/static/private";
 import { svelteGitHubCache } from "$lib/server/github-cache";
-import { getRepositories } from "$lib/repositories";
+import { githubRepos } from "$lib/repositories";
 
 export const GET: RequestHandler = async ({ request }) => {
 	if (request.headers.get("Authorization") !== `Bearer ${CRON_SECRET}`) {
 		error(401);
 	}
 
-	const allRepos = new Set(
-		getRepositories().flatMap(([, { repos }]) => repos.map(r => r.repoName))
-	);
-	for (const repo of allRepos) {
+	for (const repo of githubRepos.sveltejs) {
 		await svelteGitHubCache.fetchAndCacheReleases(repo);
 	}