chore: miscellaneous improvements, bump dependencies

- uses the GitHub token for userdev version fetching
- orders the page cards in the same order as the sidebar
- adds base paths for Vanilla config nodes to prevent future ID conflicts
- cuts down on git command spawns
- bumps dependencies

Author: zlataovce

package.json

@@ -13,25 +13,25 @@
   },
   "dependencies": {
     "@astrojs/markdown-remark": "^6.3.1",
-    "@astrojs/starlight": "^0.34.0",
-    "@astrojs/svelte": "^7.0.10",
+    "@astrojs/starlight": "^0.34.2",
+    "@astrojs/svelte": "^7.0.13",
     "@fontsource/jetbrains-mono": "^5.2.5",
-    "@fontsource/poppins": "^5.2.5",
-    "astro": "^5.7.2",
+    "@fontsource/poppins": "^5.2.6",
+    "astro": "^5.7.10",
     "astro-d2": "^0.7.0",
     "sharp": "^0.34.1",
     "starlight-contributor-list": "^0.3.0",
     "starlight-links-validator": "^0.16.0",
     "starlight-sidebar-topics": "^0.6.0",
     "starlight-sidebar-topics-dropdown": "^0.5.1",
-    "svelte": "^5.27.0",
+    "svelte": "^5.28.2",
     "typescript": "^5.8.3",
     "unist-util-visit": "^5.0.0",
     "yaml": "^2.7.1"
   },
   "devDependencies": {
     "@types/mdast": "^4.0.4",
-    "@types/node": "^22.14.1",
+    "@types/node": "^22.15.3",
     "prettier": "3.5.3",
     "prettier-plugin-astro": "0.14.1",
     "prettier-plugin-organize-imports": "^4.1.0",

patches/@astrojs__starlight@0.34.0.patch patches/@astrojs__starlight@0.34.2.patchpatches/@astrojs__starlight@0.34.0.patch renamed to patches/@astrojs__starlight@0.34.2.patch

@@ -1,2 +1,2 @@
 patchedDependencies:
-  '@astrojs/starlight@0.34.0': patches/@astrojs__starlight@0.34.0.patch
+  '@astrojs/starlight@0.34.2': patches/@astrojs__starlight@0.34.2.patch

pnpm-lock.yaml

@@ -1,15 +1,16 @@
 ---
 import { CardGrid, LinkCard } from "@astrojs/starlight/components";
 import { getCollection } from "astro:content";
+import { flattenEntries } from "../utils/sidebar";
 
 interface Props {
   path?: string;
 }
 
-const { path } = Astro.props;
+let { path } = Astro.props;
 
-const realPath = path ?? Astro.locals.starlightRoute.entry.filePath;
-const parent = realPath.substring(0, realPath.lastIndexOf("/") + 1);
+path = path ?? Astro.locals.starlightRoute.entry.filePath;
+const parent = path.substring(0, path.lastIndexOf("/") + 1);
 
 interface Page {
   title: string;
@@ -18,8 +19,9 @@ interface Page {
   group: boolean;
 }
 
+const entries = flattenEntries(Astro.locals.starlightRoute.sidebar);
 const pages: Page[] = (await getCollection(Astro.locals.starlightRoute.entry.collection))
-  .filter((p) => p.filePath!.startsWith(parent) && p.filePath !== realPath)
+  .filter((p) => p.filePath!.startsWith(parent) && p.filePath !== path)
   .filter((p) => {
     const rel = p.filePath!.substring(parent.length);
 
@@ -31,8 +33,7 @@ const pages: Page[] = (await getCollection(Astro.locals.starlightRoute.entry.col
     href: `/${p.id}`,
     group: p.filePath!.includes("index"),
   }))
-  .sort((a, b) => a.title.localeCompare(b.title))
-  .sort((a, b) => (a.group === b.group ? 0 : a.group ? -1 : 1));
+  .sort((a, b) => entries.findIndex((e) => e.label === a.title) - entries.findIndex((e) => e.label === b.title));
 ---
 
 <CardGrid>

pnpm-workspace.yaml

@@ -32,16 +32,16 @@ Unfortunately, it currently is not possible to get a 100% Vanilla experience in
 
 :::
 ## server.properties
-<ConfigNode data={filterVanilla(parse(ServerPropertiesYML))} lang="properties" />
+<ConfigNode data={filterVanilla(parse(ServerPropertiesYML))} lang="properties" path={["server_properties"]} />
 
 ## paper-world-defaults.yml
-<ConfigNode data={filterVanilla(parse(PaperWorldDefaultsYML))} />
+<ConfigNode data={filterVanilla(parse(PaperWorldDefaultsYML))} path={["paper_world_defaults"]} />
 
 ## paper-global.yml
-<ConfigNode data={filterVanilla(parse(PaperGlobalYML))} />
+<ConfigNode data={filterVanilla(parse(PaperGlobalYML))} path={["paper_global"]} />
 
 ## spigot.yml
-<ConfigNode data={filterVanilla(parse(SpigotYML))} />
+<ConfigNode data={filterVanilla(parse(SpigotYML))} path={["spigot"]} />
 
 ## Further considerations
 

src/components/PageCards.astro

@@ -10,31 +10,28 @@ export interface CommitInfo {
   committer: CommitterInfo;
 }
 
-const token = process.env.GITHUB_TOKEN;
-
-const options: RequestInit = token
+export const GITHUB_OPTIONS: RequestInit = process.env.GITHUB_TOKEN
   ? {
       headers: {
         Accept: "application/vnd.github+json",
-        "User-Agent": "papermc-docs/author",
-        Authorization: `Bearer ${token}`,
+        "User-Agent": "PaperMC/docs (https://docs.papermc.io)",
+        Authorization: `Bearer ${process.env.GITHUB_TOKEN}`,
       },
     }
   : {
       headers: {
         Accept: "application/vnd.github+json",
-        "User-Agent": "papermc-docs/author",
+        "User-Agent": "PaperMC/docs (https://docs.papermc.io)",
       },
     };
 
 export const REPO = "PaperMC/docs";
 const cache = new Map<string, CommitterInfo>();
 
 export const getCommitInfo = async (filePath: string): Promise<CommitInfo | null> => {
-  let email: string, hash: string;
+  let hash: string, email: string, name: string;
   try {
-    email = execSync(`git log -1 --pretty="format:%ae" -- "${filePath}"`).toString();
-    hash = execSync(`git log -1 --pretty="format:%H" -- "${filePath}"`).toString();
+    [hash, email, name] = execSync(`git log -1 --format="%H,%ae,%an" -- "${filePath}"`).toString().trim().split(",", 3);
   } catch (e) {
     return null;
   }
@@ -44,16 +41,9 @@ export const getCommitInfo = async (filePath: string): Promise<CommitInfo | null
     return { hash, committer: cached };
   }
 
-  let name: string;
-  try {
-    name = execSync(`git log -1 --pretty="format:%an" -- "${filePath}"`).toString();
-  } catch (e) {
-    return null;
-  }
-
   const info: CommitterInfo = { name, href: `mailto:${email}` };
 
-  const res = await fetch(`https://api.github.com/repos/${REPO}/commits/${hash}`, options);
+  const res = await fetch(`https://api.github.com/repos/${REPO}/commits/${hash}`, GITHUB_OPTIONS);
   if (res.ok) {
     const commit = await res.json();
     info.href = commit.author.html_url;

src/content/docs/paper/admin/how-to/vanilla.mdx

@@ -0,0 +1,24 @@
+export interface SidebarLink {
+  type: "link";
+  label: string;
+  href: string;
+}
+
+export interface SidebarGroup {
+  type: "group";
+  label: string;
+  entries: (SidebarLink | SidebarGroup)[];
+}
+
+export type SidebarEntry = SidebarLink | SidebarGroup;
+
+export const flattenEntries = (entries: SidebarEntry[], result: SidebarEntry[] = []): SidebarEntry[] => {
+  for (const entry of entries) {
+    result.push(entry);
+    if (entry.type === "group") {
+      flattenEntries(entry.entries, result);
+    }
+  }
+
+  return result;
+};

src/utils/git.ts

@@ -1,3 +1,5 @@
+import { GITHUB_OPTIONS } from "./git";
+
 // this is resolved on build-time, not by the client
 
 interface Latest {
@@ -48,7 +50,7 @@ interface Tag {
   name: string;
 }
 
-const userdevVersions: string[] = await fetch("https://api.github.com/repos/PaperMC/paperweight/tags")
+const userdevVersions: string[] = await fetch("https://api.github.com/repos/PaperMC/paperweight/tags", GITHUB_OPTIONS)
   .then((r) => (r.ok ? r.json() : [{ name: "v0.0.0" }]))
   .then((tags: Tag[]) => tags.map((t) => t.name.substring(1)));