Housekeeping (FabricMC#534)

Author: its-miroma

.vitepress/bump.ts

@@ -3,7 +3,6 @@ import * as fs from "node:fs";
 import * as path from "node:path";
 import * as process from "node:process";
 import * as tinyglobby from "tinyglobby";
-
 import { getLocaleNames, getResolver, getSidebar } from "./config/i18n";
 
 const git = (...args: string[]) => {
@@ -78,6 +77,14 @@ for (const file of tinyglobby.globSync("**/*.md", {
 }
 const locales = getLocaleNames(`./versions/${oldVersion}/translated`);
 
+if (fs.existsSync(`./${newVersion}/`)) {
+  console.log(`Moving in files from '${newVersion}/'...`);
+  for (const file of tinyglobby.globSync("**/*", { cwd: `./${newVersion}`, onlyFiles: true })) {
+    fs.cpSync(`./${newVersion}/${file}`, `./${file}`);
+  }
+  fs.rmSync(`./${newVersion}`, { recursive: true });
+}
+
 console.log(`Creating sidebars at '.vitepress/sidebars/versioned/${oldVersion}.json'...`);
 for (const locale of locales) {
   fs.writeFileSync(

.vitepress/config/i18n.ts

@@ -1,10 +1,9 @@
 import * as fs from "node:fs";
 import * as path from "node:path";
 import * as tinyglobby from "tinyglobby";
-
 import Develop from "../sidebars/develop";
 import Players from "../sidebars/players";
-import { Fabric } from "../types";
+import { Fabric } from "../types.d";
 
 export const getLocaleNames = (translatedDir: string) => [
   "en_us",
@@ -265,7 +264,8 @@ export const getLocales = () => {
         version: {
           reminder: {
             latestVersion: resolver("version.reminder.latest_version"),
-            oldVersionMojang: resolver("version.reminder.old_version_mojang"),
+            oldVersion: resolver("version.reminder.old_version"),
+            newVersion: resolver("version.reminder.new_version"),
           },
 
           switcher: {

.vitepress/config/index.ts

@@ -1,11 +1,10 @@
 import snippetPlugin from "markdown-it-vuepress-code-snippet-enhanced";
-import * as fs from "node:fs";
 import * as path from "node:path";
 import * as process from "node:process";
 import { tabsMarkdownPlugin } from "vitepress-plugin-tabs";
 import defineVersionedConfig from "vitepress-versioning-plugin";
-
-import { Fabric } from "../types";
+import latestVersionPlugin from "../plugins/latestVersion";
+import { Fabric } from "../types.d";
 import { getLocales } from "./i18n";
 import { transformHead, transformItems } from "./transform";
 
@@ -26,14 +25,7 @@ const hostname =
       ? "http://fabric-docs.localhost:4173/"
       : env === "dev"
         ? "http://fabric-docs.localhost:5173/"
-        : process.env.DEPLOY_PRIME_URL!;
-
-const latestVersion = fs
-  .readFileSync(
-    path.resolve(import.meta.dirname, "..", "..", "reference", "latest", "build.gradle"),
-    "utf-8"
-  )
-  .match(/def minecraftVersion = "([^"]+)"/)![1];
+        : `${process.env.DEPLOY_PRIME_URL!}/`;
 
 // https://vitepress.dev/reference/site-config
 // https://www.npmjs.com/package/vitepress-versioning-plugin
@@ -78,15 +70,16 @@ export default defineVersionedConfig(
       image: { lazyLoading: true },
       languageAlias: { gradle: "groovy" },
       languages: [
-        async () =>
-          await import("syntax-mcfunction/mcfunction.tmLanguage.json", {
-            with: { type: "json" },
-          }).then((lang) => ({ ...(lang.default as any), name: "mcfunction" })),
-        async () =>
-          await import("syntax-java-bytecode/java-bytecode.tmLanguage.json", {
-            with: { type: "json" },
-          }).then((lang) => ({ ...(lang.default as any), name: "bytecode" })),
-      ],
+        ["mcfunction", "syntax-mcfunction/mcfunction.tmLanguage.json"],
+        ["bytecode", "syntax-java-bytecode/java-bytecode.tmLanguage.json"],
+      ].map(
+        ([name, path]) =>
+          async () =>
+            await import(path, { with: { type: "json" } }).then((lang) => ({
+              ...lang.default,
+              name,
+            }))
+      ),
       lineNumbers: true,
       shikiSetup: async (shiki) => {
         await shiki.loadTheme("github-light", "github-dark");
@@ -125,7 +118,6 @@ export default defineVersionedConfig(
 
     // Versioning plugin configuration.
     versioning: {
-      latestVersion,
       rewrites: { localePrefix: "translated" },
       sidebars: {
         sidebarContentProcessor: (s) =>
@@ -143,6 +135,10 @@ export default defineVersionedConfig(
           url.startsWith("/") ? `/${version}${/^[/].._..[/]/.test(url) ? url.slice(6) : url}` : url,
       },
     },
+
+    vite: {
+      plugins: [latestVersionPlugin()],
+    },
   },
   path.resolve(import.meta.dirname, "..")
 );

.vitepress/plugins/index.d.ts

@@ -0,0 +1,9 @@
+declare module "markdown-it-vuepress-code-snippet-enhanced" {
+  const snippetPlugin: (md: any) => void;
+  export default snippetPlugin;
+}
+
+declare module "virtual:fabric-docs:latest-version" {
+  const latestVersion: string;
+  export default latestVersion;
+}

.vitepress/plugins/latestVersion.ts

@@ -0,0 +1,36 @@
+import * as fs from "node:fs";
+import * as path from "node:path";
+import { Plugin } from "vitepress";
+
+export default (): Plugin => {
+  const name = "fabric-docs:latest-version";
+  const id = `virtual:${name}`;
+  const resolvedId = `\0${id}`;
+
+  const file = path.resolve(import.meta.dirname, "..", "..", "reference", "latest", "build.gradle");
+
+  return {
+    name,
+    enforce: "pre",
+
+    resolveId: {
+      filter: { id: new RegExp(`^${id}$`) },
+      handler() {
+        return resolvedId;
+      },
+    },
+
+    load: {
+      filter: { id: new RegExp(`^${resolvedId}$`) },
+      handler() {
+        this.addWatchFile(file);
+
+        const latestVersion = fs
+          .readFileSync(file, "utf-8")
+          .match(/def minecraftVersion = "([^"]+)"/)![1];
+
+        return `export default ${JSON.stringify(latestVersion)};`;
+      },
+    },
+  };
+};

.vitepress/sidebars/develop.ts

@@ -1,4 +1,4 @@
-import { Fabric } from "../types";
+import { Fabric } from "../types.d";
 
 export default [
   {
@@ -417,4 +417,4 @@ export default [
       },
     ],
   },
-] as Fabric.SidebarItem[];
+] satisfies Fabric.SidebarItem[];

.vitepress/sidebars/players.ts

@@ -1,4 +1,4 @@
-import { Fabric } from "../types";
+import { Fabric } from "../types.d";
 
 export default [
   {
@@ -44,4 +44,4 @@ export default [
       },
     ],
   },
-] as Fabric.SidebarItem[];
+] satisfies Fabric.SidebarItem[];

.vitepress/theme/components/AuthorsComponent.vue

@@ -1,9 +1,9 @@
 <script setup lang="ts">
+import { useBrowserLocation } from "@vueuse/core";
 import { useData } from "vitepress";
+import VPLink from "vitepress/dist/client/theme-default/components/VPLink.vue";
 import { computed } from "vue";
-
-import { useBrowserLocation } from "@vueuse/core";
-import { Fabric } from "../../types";
+import { Fabric } from "../../types.d";
 
 type Author = { name: string; noGitHub?: true };
 
@@ -36,32 +36,31 @@ const getImageSrc = (author: Author) =>
 <template>
   <h2 v-if="authors.length">{{ options.heading }}</h2>
   <div>
-    <component
+    <VPLink
       v-for="author in authors"
       :key="author.noGitHub ? `${author.name}!` : author.name"
-      :is="author.noGitHub ? 'span' : 'a'"
-      :href="`https://github.com/${author.name}`"
-      target="_blank"
+      :href="author.noGitHub ? undefined : `https://github.com/${author.name}`"
     >
       <img
         :title="author.noGitHub ? options.noGitHub.replace('%s', author.name) : author.name"
         :src="getImageSrc(author)"
         :alt="author.name"
         loading="lazy"
       />
-    </component>
+    </VPLink>
   </div>
 </template>
 
 <style scoped>
 h2 {
+  margin-top: 20px;
+  padding-top: 16px;
+  border-top: 1px solid var(--vp-c-divider);
+  font-size: 12px;
   font-weight: bold;
-  font-size: large;
-  margin-top: 16px;
-}
-
-.content-container > h2 {
-  display: none;
+  color: var(--vp-c-text-2);
+  letter-spacing: 0.06em;
+  text-transform: uppercase;
 }
 
 div {
@@ -87,6 +86,16 @@ div {
   }
 }
 
+.content-container {
+  h2 {
+    display: none;
+  }
+
+  div {
+    margin-bottom: 16px;
+  }
+}
+
 @media (min-width: 1280px) {
   .content-container > div {
     display: none;

.vitepress/theme/components/BannerComponent.vue

@@ -3,8 +3,7 @@ import { useElementSize } from "@vueuse/core";
 import { useData } from "vitepress";
 import VPLink from "vitepress/dist/client/theme-default/components/VPLink.vue";
 import { computed, ref, watch } from "vue";
-
-import { Fabric } from "../../types";
+import { Fabric } from "../../types.d";
 
 const data = useData();
 const banner = ref<HTMLElement>();

.vitepress/theme/components/DownloadEntry.vue

@@ -2,8 +2,7 @@
 import { useData } from "vitepress";
 import VPButton from "vitepress/dist/client/theme-default/components/VPButton.vue";
 import { computed, useSlots } from "vue";
-
-import { Fabric } from "../../types";
+import { Fabric } from "../../types.d";
 
 defineProps<{
   downloadURL: string;