feat: Vanilla data files + some formatting changes (#570)

* vanilla data files + some formatting changes

* Apply review suggestions

Co-authored-by: zlataovce <[email protected]>

* punctuation

* Update src/config/paper/banned-ips-single.yml

Co-authored-by: Lulu13022002 <[email protected]>

* Update src/content/docs/paper/admin/reference/configuration/vanilla-data-files.mdx

Co-authored-by: Lulu13022002 <[email protected]>

* feat: modify ConfigNode for JSON schemas

---------

Co-authored-by: zlataovce <[email protected]>
Co-authored-by: Lulu13022002 <[email protected]>

Author: 3 people

astro.config.ts

@@ -86,6 +86,7 @@ export default defineConfig({
                             "paper/reference/spigot-configuration",
                             "paper/reference/bukkit-commands-configuration",
                             "paper/reference/server-properties",
+                            "paper/reference/vanilla-data-files",
                           ],
                         },
                         "paper/reference/paper-plugins",

src/components/ConfigNode.astro

@@ -2,25 +2,29 @@
 import { render } from "../utils/markdown";
 import type { Data } from "../utils/config";
 
+type Language = "yaml" | "json" | "properties";
+
 interface Props {
   data: Data;
-  separator?: string;
+  lang?: Language; // defaults to "yaml"
 
+  child?: boolean;
   path?: string[];
 }
 
-let { data, separator, path } = Astro.props;
+let { data, lang, child, path } = Astro.props;
 path = path ?? [];
 
-const root = path.length === 0;
+const json = lang === "json";
+const separator = lang === "properties" ? "=" : ": ";
 
 interface Default {
   value: string;
   inline: boolean;
 }
 const formatDefault = (value?: string): Default => {
   if (!value) value = "";
-  if (value.length > 2 && value.match(/^\[.+]$/)) {
+  if (!json && value.length > 2 && value.match(/^\[.+]$/)) {
     return {
       value: value
         .substring(1, value.length - 1)
@@ -35,40 +39,45 @@ const formatDefault = (value?: string): Default => {
 };
 ---
 
-<div class:list={["not-content", "node", root && "node-root"]}>
+<div class:list={["not-content", "node", json && "node-json", child || "node-root"]}>
+  {json && <p class="muted">{"{"}</p>}
   {
-    Object.entries(data).map(([key, value]) => {
-      const displayKey = key.replace(/_+$/, ""); // remove trailing underscores, used for duplicating keys
+    Object.entries(data).map(([key, rawValue], i, entries) => {
+      let displayKey = key.replace(/_+$/, ""); // remove trailing underscores, used for duplicating keys
+      if (json) displayKey = `"${displayKey}"`;
+
       const childPath = [...path, key.replace(/-/g, "_")];
+      const hasComma = json && i !== (entries.length - 1);
 
-      const def = formatDefault(value.default);
+      const { value, inline } = formatDefault(rawValue.default);
       return (
         <div>
-          {"message" in value ? (
+          {"message" in rawValue ? (
             <div
-              class="block message"
-              style={value.color ? `border-color: ${value.color}` : undefined}
-              set:html={render(value.message)}
+              class:list={["block", "message", rawValue.inline && "message-inline"]}
+              style={rawValue.color ? `border-color: ${rawValue.color}` : undefined}
+              set:html={render(rawValue.message)}
             />
-          ) : "description" in value ? (
+          ) : "description" in rawValue ? (
             <details id={childPath.join("_")}>
               <summary class="line notranslate" translate="no">
-                <span class="key">{displayKey}{separator ?? ": "}</span>{
-                  def.inline
-                    ? (<span class="value">{def.value}</span><a class="link" href={`#${childPath.join("_")}`}>#</a>)
-                    : (<a class="link" href={`#${childPath.join("_")}`}>#</a><p class="value">{def.value}</p>)
+                <span class="key">{displayKey}{separator}</span>{
+                  inline
+                    ? (<span class="value">{value}</span><>{hasComma && <span class="muted">,</span>}</><a class="link" href={`#${childPath.join("_")}`}>#</a>)
+                    : (<a class="link" href={`#${childPath.join("_")}`}>#</a><p class="value">{value}</p><>{hasComma && <span class="muted">,</span>}</>)
                 }
               </summary>
-              <div class="block" set:html={render(value.description)} />
+              <div class="block" set:html={render(rawValue.description)} />
             </details>
           ) : (
-            <span class="key notranslate" translate="no">{displayKey}:</span>
-            <Astro.self data={value} path={childPath} {separator} />
+            <span class="key notranslate" translate="no">{displayKey}{separator}</span>
+            <Astro.self child data={rawValue} path={childPath} {lang} />
           )}
         </div>
       );
     })
   }
+  {json && <p class="muted">{"}"}</p>}
 </div>
 
 <style>
@@ -78,6 +87,14 @@ const formatDefault = (value?: string): Default => {
     font-family: var(--__sl-font-mono);
   }
 
+  .node-json {
+    padding-left: 0;
+  }
+
+  .node-json > div {
+    padding-left: 1.25rem;
+  }
+
   .node-root {
     padding: 1rem;
     background-color: var(--sl-color-gray-6);
@@ -90,14 +107,13 @@ const formatDefault = (value?: string): Default => {
   }
 
   .key {
-    white-space: pre;
+    white-space: pre-wrap;
     color: var(--sl-color-text-accent);
   }
 
   .value {
     white-space: pre-wrap;
     color: var(--sl-color-text);
-    padding-right: 0.5rem;
   }
 
   .block {
@@ -109,14 +125,28 @@ const formatDefault = (value?: string): Default => {
     color: var(--sl-color-white);
     background-color: var(--sl-color-gray-5);
     border-left: 5px solid var(--sl-color-bg-accent);
+    white-space: pre-wrap;
   }
 
   .message {
     margin-left: 0;
   }
 
+  .message-inline {
+    margin: 0;
+    padding: 0;
+    color: var(--sl-color-gray-3);
+    background-color: unset;
+    border-left: none;
+  }
+
+  .muted {
+    color: var(--sl-color-gray-3);
+  }
+
   .link {
     opacity: 0;
+    padding-left: 0.5rem;
     transition: opacity 0.2s ease;
   }
 

src/config/paper/banned-ips-single.yml

@@ -0,0 +1,29 @@
+header:
+  message: This is a single entry in the root array found in banned-ips.json.
+ip:
+  description: |
+    The IP address representing the banned user.
+
+    For IPv4 the expected format is "x.x.x.x",
+
+    For IPv6 the expected format follows [RFC5952 Section 4](https://datatracker.ietf.org/doc/html/rfc5952#section-4),
+
+    For anything else, "\<unknown>" may be present (but its use is discouraged).
+  default: "an IPv4 or IPv6 address"
+created:
+  description: |
+    A timestamp of when the user was banned.
+    The expected format is "yyyy-MM-dd HH:mm:ss Z".
+  default: the ban creation time
+source:
+  description: A string representing the source of the ban.
+  default: '"(Unknown)"'
+expires:
+  description: |
+    A timestamp of when the ban expires, or "forever" if it does not expire.
+
+    The expected format is "yyyy-MM-dd HH:mm:ss Z".
+  default: '"forever"'
+reason:
+  description: The reason for the ban.
+  default: '"Banned by an operator."'

src/config/paper/banned-players-single.yml

@@ -0,0 +1,25 @@
+header:
+  message: This is a single entry in the root array found in banned-players.json.
+uuid:
+  description: The UUID representing the banned user.
+  default: the UUID of the banned user
+name:
+  description: The name of the banned user.
+  default: the name of the banned user
+created:
+  description: |
+    A timestamp of when the user was banned.
+    The expected format is "yyyy-MM-dd HH:mm:ss Z".
+  default: the ban creation time
+source:
+  description: A string representing the source of the ban.
+  default: '"(Unknown)"'
+expires:
+  description: |
+    A timestamp of when the ban expires, or "forever" if it does not expire.
+
+    The expected format is "yyyy-MM-dd HH:mm:ss Z".
+  default: '"forever"'
+reason:
+  description: The reason for the ban.
+  default: '"Banned by an operator."'

src/config/paper/eula.yml

@@ -0,0 +1,10 @@
+header:
+  message: |
+    #By changing the setting below to TRUE you are indicating your agreement to our EULA (https://aka.ms/MinecraftEULA).
+    #\<date\>
+  inline: true
+eula:
+  default: "false"
+  description: >-
+    Whether to accept the Minecraft EULA.
+    This must be set to "true" to run the server.

src/config/paper/ops-single.yml

@@ -0,0 +1,18 @@
+header:
+  message: This is a single entry in the root array found in ops.json.
+uuid:
+  description: The UUID representing the operator.
+  default: the UUID of the operator
+name:
+  description: The name of the operator.
+  default: the name of the operator
+level:
+  description: |
+    The level of the operator permissions.
+
+    The expected format is an integer between 0 and 4.
+  default: "0"
+
+bypassesPlayerLimit:
+  description: Whether this operator bypasses the player limit.
+  default: "false"

src/config/paper/paper-global.yml

@@ -461,7 +461,8 @@ unsupported-settings:
   inline-docs-warning:
     color: red
     message: >-
-      **Unsupported settings**<br />
+      **Unsupported settings**
+
       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.
   allow-headless-pistons:

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

@@ -1042,7 +1042,8 @@ unsupported-settings:
   inline-docs-warning:
     color: red
     message: >-
-      **Unsupported settings**<br />
+      **Unsupported settings**
+
       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:

src/config/paper/whitelist-single.yml

@@ -0,0 +1,8 @@
+header:
+  message: This is a single entry in the root array found in whitelist.json.
+uuid:
+  description: The UUID of the player on the whitelist.
+  default: the UUID of the player on the whitelist
+name:
+  description: The name of the player on the whitelist.
+  default: the name of the player on the whitelist

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

@@ -32,7 +32,7 @@ Unfortunately, it currently is not possible to get a 100% Vanilla experience in
 
 :::
 ## server.properties
-<ConfigNode data={filterVanilla(parse(ServerPropertiesYML))} separator="=" />
+<ConfigNode data={filterVanilla(parse(ServerPropertiesYML))} lang="properties" />
 
 ## paper-world-defaults.yml
 <ConfigNode data={filterVanilla(parse(PaperWorldDefaultsYML))} />