refactor: Improve project versioning (#391)

zlataovce · web-flow · commit c3691927baf7 · 2024-05-13T22:00:01.000+01:00
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -109,12 +109,12 @@ of a few ways:
    This component is used to embed the current version of the software into the documentation. An example of this would be:
 
    ```jsx
-   <SoftwareVersion versionType={"maj-min"}/> // E.g 1.19.2
-   <SoftwareVersion versionType={"maj"}/> // E.g 1.19
-   <SoftwareVersion versionType={"max"}/> // E.g 1.20.4
+   <SoftwareVersion versionType={"maj-min-pat"}/> // e.g. 1.19.2
+   <SoftwareVersion versionType={"maj-min"}/> // e.g. 1.19
+   <SoftwareVersion versionType={"maj"}/> // e.g. 1
 
-   // You can set the project name to be used for the versioning:
-   <SoftwareVersion versionType={"maj-min"} project={"velocity"}/> // Project defaults to Paper
+   // You can set the project name to be used for the versioning (defaults to paper):
+   <SoftwareVersion versionType={"maj-min-pat"} project={"velocity"}/> // e.g. 3.3.0-SNAPSHOT
    ```
 
 2. `Javadoc` component
@@ -137,17 +137,17 @@ of a few ways:
    version: '1.0'
    main: io.papermc.testplugin.TestPlugin
    description: Paper Test Plugin
-   api-version: '%%_MAJ_MC_%%'
+   api-version: '%%_MAJ_MIN_PAT_MC_%%'
    bootstrapper: io.papermc.testplugin.TestPluginBootstrap
    loader: io.papermc.testplugin.TestPluginLoader
    ```⠀
    </VersionFormattedCode>
 
    // The possible placeholders are:
-   %%_MAJ_MC_%%  - Major Paper Version (E.g. 1.20)
-   %%_MAJ_MIN_MC_%% - Major-Minor Paper Version (E.g. 1.20.4)
-   %%_MAJ_VEL_%% - Major Velocity Version (E.g. 3.3)
-   %%_MAJ_MIN_VEL_%% - Major-Minor Velocity Version (E.g. 3.3.0)
+   %%_MAJ_MIN_MC_%%  - Major-Minor Paper Version (E.g. 1.20)
+   %%_MAJ_MIN_PAT_MC_%% - Major-Minor-Patch Paper Version (E.g. 1.20.4)
+   %%_MAJ_MIN_VEL_%% - Major Velocity Version (E.g. 3.1.0)
+   %%_MAJ_MIN_PAT_VEL_%% - Major-Minor-Patch Velocity Version (E.g. 3.1.1-SNAPSHOT)
    ````
 
 When the major version of the software changes, the docs will still need to have a "snapshot" created to keep documentation
diff --git a/config-specs/paper/spigot.yml b/config-specs/paper/spigot.yml
@@ -65,7 +65,7 @@ messages:
       than the client version.
 
       The message is formatted with legacy "&" style formatting, and "\\n" for
-      newlines. Additionally, it replaces {0} with "%%_MAJ_MIN_MC_%%" (the current server
+      newlines. Additionally, it replaces {0} with "%%_MAJ_MIN_PAT_MC_%%" (the current server
       version)
   outdated-server:
     default: "Outdated server! I'm still on {0}"
@@ -74,7 +74,7 @@ messages:
       than the client version.
 
       The message is formatted with legacy "&" style formatting, and "\\n" for
-      newlines. Additionally, it replaces {0} with "%%_MAJ_MIN_MC_%%" (the current server
+      newlines. Additionally, it replaces {0} with "%%_MAJ_MIN_PAT_MC_%%" (the current server
       version)
   restart:
     default: Server is restarting
diff --git a/docs/misc/downloads-api.mdx b/docs/misc/downloads-api.mdx
@@ -42,7 +42,7 @@ This will get the latest available Minecraft version for the given project.
 #!/usr/bin/env sh
 
 PROJECT="paper"
-MINECRAFT_VERSION="%%_MAJ_MIN_MC_%%"
+MINECRAFT_VERSION="%%_MAJ_MIN_PAT_MC_%%"
 
 LATEST_BUILD=$(curl -s https://api.papermc.io/v2/projects/${PROJECT}/versions/${MINECRAFT_VERSION}/builds | \
     jq '.builds | map(select(.channel == "default") | .build) | .[-1]')
@@ -64,7 +64,7 @@ This will get the latest stable build for the given project and Minecraft versio
 #!/usr/bin/env sh
 
 PROJECT="paper"
-MINECRAFT_VERSION="%%_MAJ_MIN_MC_%%"
+MINECRAFT_VERSION="%%_MAJ_MIN_PAT_MC_%%"
 
 LATEST_BUILD=$(curl -s https://api.papermc.io/v2/projects/${PROJECT}/versions/${MINECRAFT_VERSION}/builds | \
     jq -r '.builds | map(select(.channel == "default") | .build) | .[-1]')
diff --git a/docs/paper/dev/getting-started/paper-plugins.mdx b/docs/paper/dev/getting-started/paper-plugins.mdx
@@ -31,7 +31,7 @@ name: Paper-Test-Plugin
 version: '1.0'
 main: io.papermc.testplugin.TestPlugin
 description: Paper Test Plugin
-api-version: '%%_MAJ_MC_%%'
+api-version: '%%_MAJ_MIN_PAT_MC_%%'
 bootstrapper: io.papermc.testplugin.TestPluginBootstrap
 loader: io.papermc.testplugin.TestPluginLoader
 ```
diff --git a/docs/paper/dev/getting-started/plugin-yml.mdx b/docs/paper/dev/getting-started/plugin-yml.mdx
@@ -33,7 +33,7 @@ main: io.papermc.testplugin.ExamplePlugin
 description: An example plugin
 author: PaperMC
 website: https://papermc.io
-api-version: '%%_MAJ_MC_%%'
+api-version: '%%_MAJ_MIN_PAT_MC_%%'
 ```
 </VersionFormattedCode>
 
@@ -92,8 +92,8 @@ This will be shown in the plugin info commands.
 
 The version of the Paper API that your plugin is using. This doesn't include the minor version.
 Servers with a version lower than the version specified here will refuse to load the plugin.
-The valid versions are 1.13 - <SoftwareVersion versionType={"maj-min"}/>.
-- <VersionFormattedCode>`api-version: '%%_MAJ_MIN_MC_%%'`</VersionFormattedCode>
+The valid versions are 1.13 - <SoftwareVersion versionType={"maj-min-pat"}/>.
+- <VersionFormattedCode>`api-version: '%%_MAJ_MIN_PAT_MC_%%'`</VersionFormattedCode>
 
 :::info
 
diff --git a/docs/paper/dev/getting-started/project-setup.mdx b/docs/paper/dev/getting-started/project-setup.mdx
@@ -37,7 +37,7 @@ repositories {
 }
 
 dependencies {
-    compileOnly("io.papermc.paper:paper-api:%%_MAJ_MIN_MC_%%-R0.1-SNAPSHOT")
+    compileOnly("io.papermc.paper:paper-api:%%_MAJ_MIN_PAT_MC_%%-R0.1-SNAPSHOT")
 }
 
 java {
diff --git a/docs/paper/dev/getting-started/userdev.mdx b/docs/paper/dev/getting-started/userdev.mdx
@@ -73,7 +73,7 @@ file.
 ```
 dependencies {
     // Other Dependencies
-    paperweight.paperDevBundle("%%_MAJ_MIN_MC_%%-R0.1-SNAPSHOT")
+    paperweight.paperDevBundle("%%_MAJ_MIN_PAT_MC_%%-R0.1-SNAPSHOT")
 }
 ```
 </VersionFormattedCode>
diff --git a/docs/paper/dev/misc/debugging.mdx b/docs/paper/dev/misc/debugging.mdx
@@ -49,7 +49,7 @@ These will go after the `java` command and before `-jar`. Once you have done thi
 
 <VersionFormattedCode language={"bash"}>
 ```
-java -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=*:5005 -jar paper-%%_MAJ_MIN_MC_%%.jar nogui
+java -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=*:5005 -jar paper-%%_MAJ_MIN_PAT_MC_%%.jar nogui
 ```
 </VersionFormattedCode>
 
diff --git a/docs/paper/dev/misc/internal-code.mdx b/docs/paper/dev/misc/internal-code.mdx
@@ -82,10 +82,10 @@ with one of the following methods:
 
 <VersionFormattedCode language={"java"}>
 ```
-// Example value: %%_MAJ_MIN_MC_%%
+// Example value: %%_MAJ_MIN_PAT_MC_%%
 String minecraftVersion = Bukkit.getServer().getMinecraftVersion();
 
-// Example value: %%_MAJ_MIN_MC_%%-R0.1-SNAPSHOT
+// Example value: %%_MAJ_MIN_PAT_MC_%%-R0.1-SNAPSHOT
 String bukkitVersion = Bukkit.getServer().getBukkitVersion();
 
 // Example value for 1.20.1: 3465
diff --git a/docs/velocity/admin/reference/server-compatibility.mdx b/docs/velocity/admin/reference/server-compatibility.mdx
@@ -11,7 +11,7 @@ we can.
 
 ## Compatible game versions
 
-As of this writing, Velocity is compatible with Minecraft 1.7.2 through <SoftwareVersion versionType={"max"}/>.
+As of this writing, Velocity is compatible with Minecraft 1.7.2 through <SoftwareVersion/>.
 
 ## Vanilla setups
 
diff --git a/docs/velocity/dev/getting-started/creating-your-first-plugin.mdx b/docs/velocity/dev/getting-started/creating-your-first-plugin.mdx
@@ -41,9 +41,9 @@ Now we have created our project, we need configure our build system.
 
 ### Dependency
 
-| Group ID              | Artifact ID    | Version                                                          |
-|-----------------------|----------------|------------------------------------------------------------------|
-| `com.velocitypowered` | `velocity-api` | <VersionFormattedCode>`%%_MAJ_MIN_VEL_%%`</VersionFormattedCode> |
+| Group ID              | Artifact ID    | Version                                                              |
+|-----------------------|----------------|----------------------------------------------------------------------|
+| `com.velocitypowered` | `velocity-api` | <VersionFormattedCode>`%%_MAJ_MIN_PAT_VEL_%%`</VersionFormattedCode> |
 
 ### Javadocs
 
@@ -77,7 +77,7 @@ system's documentation ([Gradle](https://docs.gradle.org/current/userguide/userg
         <dependency>
             <groupId>com.velocitypowered</groupId>
             <artifactId>velocity-api</artifactId>
-            <version>%%_MAJ_MIN_VEL_%%</version>
+            <version>%%_MAJ_MIN_PAT_VEL_%%</version>
             <scope>provided</scope>
         </dependency>
     </dependencies>
@@ -98,8 +98,8 @@ repositories {
 }
 
 dependencies {
-    compileOnly("com.velocitypowered:velocity-api:%%_MAJ_MIN_VEL_%%")
-    annotationProcessor("com.velocitypowered:velocity-api:%%_MAJ_MIN_VEL_%%")
+    compileOnly("com.velocitypowered:velocity-api:%%_MAJ_MIN_PAT_VEL_%%")
+    annotationProcessor("com.velocitypowered:velocity-api:%%_MAJ_MIN_PAT_VEL_%%")
 }
 ```
 </VersionFormattedCode>
@@ -117,8 +117,8 @@ repositories {
 }
 
 dependencies {
-    compileOnly 'com.velocitypowered:velocity-api:%%_MAJ_MIN_VEL_%%'
-    annotationProcessor 'com.velocitypowered:velocity-api:%%_MAJ_MIN_VEL_%%'
+    compileOnly 'com.velocitypowered:velocity-api:%%_MAJ_MIN_PAT_VEL_%%'
+    annotationProcessor 'com.velocitypowered:velocity-api:%%_MAJ_MIN_PAT_VEL_%%'
 }
 ```
 </VersionFormattedCode>
diff --git a/package.json b/package.json
@@ -31,7 +31,6 @@
     "@fontsource/jetbrains-mono": "5.0.20",
     "@iconify/react": "4.1.1",
     "@mdx-js/react": "3.0.1",
-    "axios": "1.6.8",
     "clsx": "2.1.0",
     "docusaurus-plugin-sass": "^0.2.5",
     "js-yaml": "4.1.0",
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/src/components/versioning/Javadoc.tsx b/src/components/versioning/Javadoc.tsx
@@ -1,24 +1,33 @@
 import React, { useEffect, useState } from "react";
 import { getProperty } from "../Property";
-import SoftwareVersionFetcher from "../../minecraft-versioning/SoftwareVersionFetcher";
+import {
+  getProjectVersion,
+  VersionType,
+  type Project,
+  type DocusaurusVersion,
+} from "../../util/versionUtils";
+import { useDocsVersion } from "@docusaurus/theme-common/internal";
 
-type TargetResolver = (module?: string) => Promise<string>;
+type TargetResolver = (
+  currentVersion: DocusaurusVersion | null,
+  module?: string
+) => Promise<string>;
 
-const createProjectTarget = (project: string, majorOnly: boolean = false): TargetResolver => {
-  return async () => {
-    let version = await SoftwareVersionFetcher.getMajorVersion(project);
-    if (majorOnly) {
-      version = version.split(".")[0] + ".0.0";
-    }
+const createProjectTarget = (
+  project: Project,
+  versionType: VersionType = VersionType.MajorMinorPatch
+): TargetResolver => {
+  return async (currentVersion) => {
+    const version = await getProjectVersion(project, currentVersion, versionType);
 
     return `https://jd.papermc.io/${project}/${version}`;
   };
 };
 
 const targets: { [project: string]: TargetResolver } = {
   paper: createProjectTarget("paper"),
-  velocity: createProjectTarget("velocity", true),
-  java: async (module) => {
+  velocity: createProjectTarget("velocity", VersionType.MajorZeroed),
+  java: async (_, module) => {
     const version = getProperty("DOCS_JAVA") ?? "21";
 
     return `https://docs.oracle.com/en/java/javase/${version}/docs/api/${module || "java.base"}`;
@@ -35,11 +44,12 @@ const formatName = (name: string): string => {
 export default function Javadoc({ name, module, project = "paper", children }: JavadocProps) {
   const [href, setHref] = useState<string>(null);
 
+  const versionMeta = useDocsVersion();
   useEffect(() => {
     (async () => {
       const resolve = targets[project];
       if (resolve) {
-        const target = await resolve(module);
+        const target = await resolve(versionMeta, module);
 
         setHref(`${target}/${formatName(name)}`);
       }
@@ -52,6 +62,6 @@ export default function Javadoc({ name, module, project = "paper", children }: J
 interface JavadocProps {
   name: string;
   module?: string;
-  project?: "paper" | "velocity" | "java";
+  project?: Project | "java";
   children: any;
 }
diff --git a/src/components/versioning/SoftwareVersion.tsx b/src/components/versioning/SoftwareVersion.tsx
diff --git a/src/components/versioning/VersionFormattedCode.tsx b/src/components/versioning/VersionFormattedCode.tsx
diff --git a/src/minecraft-versioning/SoftwareVersionFetcher.tsx b/src/minecraft-versioning/SoftwareVersionFetcher.tsx
diff --git a/src/util/authorUtils.ts b/src/util/authorUtils.ts
diff --git a/src/util/versionUtils.ts b/src/util/versionUtils.ts

Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ repositories {`
`37`	`37`	`}`
`38`	`38`
`39`	`39`	`dependencies {`
`40`		`- compileOnly("io.papermc.paper:paper-api:%%_MAJ_MIN_MC_%%-R0.1-SNAPSHOT")`
	`40`	`+ compileOnly("io.papermc.paper:paper-api:%%_MAJ_MIN_PAT_MC_%%-R0.1-SNAPSHOT")`
`41`	`41`	`}`
`42`	`42`
`43`	`43`	`java {`
Original file line number	Diff line number	Diff line change
`@@ -73,7 +73,7 @@ file.`
`73`	`73`	```
`74`	`74`	`dependencies {`
`75`	`75`	`// Other Dependencies`
`76`		`- paperweight.paperDevBundle("%%_MAJ_MIN_MC_%%-R0.1-SNAPSHOT")`
	`76`	`+ paperweight.paperDevBundle("%%_MAJ_MIN_PAT_MC_%%-R0.1-SNAPSHOT")`
`77`	`77`	`}`
`78`	`78`	```
`79`	`79`	`</VersionFormattedCode>`