fix: oversights, re-add vanilla guide

Author: zlataovce

src/components/ConfigNode.astro

@@ -1,17 +1,6 @@
 ---
 import { render } from "../utils/markdown";
-
-interface LeafData {
-  description: string;
-  default?: string;
-}
-
-interface MessageData {
-  message: string;
-  color?: string;
-}
-
-type Data = { [key: string]: Data } | LeafData | MessageData;
+import type { Data } from "../utils/config";
 
 interface Props {
   data: Data;
@@ -49,7 +38,7 @@ const formatDefault = (value?: string): Default => {
 <div class:list={["not-content", "node", root && "node-root"]}>
   {
     Object.entries(data).map(([key, value]) => {
-      const displayKey = key.replace(/^_+/, ""); // remove leading underscores, used for duplicating keys
+      const displayKey = key.replace(/_+$/, ""); // remove trailing underscores, used for duplicating keys
       const childPath = [...path, key.replace(/-/g, "_")];
 
       const def = formatDefault(value.default);

src/config/paper/paper-world-defaults.yml

@@ -1039,6 +1039,12 @@ tick-rates:
           Sets the sensor tick rate of an entity. -1 uses Vanilla. See timings
           for the names. Might change between updates!
 unsupported-settings:
+  inline-docs-warning:
+    color: red
+    message: >-
+      **Unsupported settings**<br />
+      The following settings are provided by Paper but are not officially
+      supported. Use them at your own risk and they may be removed at any time.
   disable-world-ticking-when-empty:
     vanilla: "true"
     default: "false"

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

@@ -4,6 +4,15 @@ description: This page lists all changes that result in a different experience t
 slug: paper/vanilla
 ---
 
+import ConfigNode from "/src/components/ConfigNode.astro";
+import { filterVanilla } from "/src/utils/config";
+import { parse } from "yaml";
+
+import ServerPropertiesYML from "/src/config/paper/server-properties.yml?raw";
+import PaperWorldDefaultsYML from "/src/config/paper/paper-world-defaults.yml?raw";
+import PaperGlobalYML from "/src/config/paper/paper-global.yml?raw";
+import SpigotYML from "/src/config/paper/spigot.yml?raw";
+
 Due to the way the Bukkit API is implemented in Paper, the gameplay experience between Vanilla and Paper can have inconsistencies.
 This can be furthered by efforts to fix bugs present in Vanilla Minecraft.
 Whilst many people may not notice the inconsistencies, there are situations where they become problematic.
@@ -23,16 +32,16 @@ Unfortunately, it currently is not possible to get a 100% Vanilla experience in
 
 :::
 ## server.properties
-{/* <ConfigDocBlock data={ServerProperties} showVanillaValues={true}/> */}
+<ConfigNode data={filterVanilla(parse(ServerPropertiesYML))} separator="=" />
 
 ## paper-world-defaults.yml
-{/* <ConfigDocBlock data={VanillaWorldDefaults} showVanillaValues={true}/> */}
+<ConfigNode data={filterVanilla(parse(PaperWorldDefaultsYML))} />
 
 ## paper-global.yml
-{/* <ConfigDocBlock data={VanillaGlobalDefaults} showVanillaValues={true}/> */}
+<ConfigNode data={filterVanilla(parse(PaperGlobalYML))} />
 
 ## spigot.yml
-{/* <ConfigDocBlock data={SpigotChanges} showVanillaValues={true}/> */}
+<ConfigNode data={filterVanilla(parse(SpigotYML))} />
 
 ## Further considerations
 

src/utils/config.ts

@@ -0,0 +1,44 @@
+export interface LeafData {
+  description: string;
+  default?: string;
+}
+
+export interface MessageData {
+  message: string;
+  color?: string;
+}
+
+export type Data = { [key: string]: Data } | LeafData | MessageData;
+
+interface VanillaLeafData extends LeafData {
+  vanilla?: string;
+}
+
+type VanillaData = { [key: string]: Data } | VanillaLeafData | MessageData;
+
+// replaces "default" values with "vanilla" values, removes them if no "vanilla" value is defined
+export const filterVanilla = (input: VanillaData): Data | null => {
+  if ("message" in input) {
+    return input; // MessageData
+  }
+
+  if ("description" in input) {
+    const leaf = input as LeafData;
+    if ("vanilla" in leaf) {
+      leaf.default = (leaf as VanillaLeafData).vanilla!;
+      return leaf;
+    }
+
+    return null; // remove key
+  }
+
+  const result: { [key: string]: Data } = {};
+  for (const key in input) {
+    const converted = filterVanilla(input[key]);
+    if (converted !== null) {
+      result[key] = converted;
+    }
+  }
+
+  return Object.keys(result).length > 0 ? result : null;
+};