Skip to content

Commit f5c71bb

Browse files
committed
Cleanup
1 parent 46f7cf6 commit f5c71bb

File tree

4 files changed

+24
-21
lines changed

4 files changed

+24
-21
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ of a few ways:
148148
%%_MAJ_MIN_PAT_MC_%% - Major-Minor-Patch Paper Version (E.g. 1.20.4)
149149
%%_MAJ_MIN_VEL_%% - Major Velocity Version (E.g. 3.1.0)
150150
%%_MAJ_MIN_PAT_VEL_%% - Major-Minor-Patch Velocity Version (E.g. 3.1.1-SNAPSHOT)
151-
%%_USERDEV_VER_%% - Latest Paperweight-Userdev Version (E.g. 1.7.3)
151+
%%_MAJ_MIN_PAT_USERDEV_%% - Latest Paperweight-Userdev Version (E.g. 1.7.3)
152152
````
153153

154154
When the major version of the software changes, the docs will still need to have a "snapshot" created to keep documentation

docs/paper/dev/getting-started/userdev.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Portal](https://plugins.gradle.org/plugin/io.papermc.paperweight.userdev).
4848
<VersionFormattedCode language={"kotlin"} title={"build.gradle.kts"}>
4949
```
5050
plugins {
51-
id("io.papermc.paperweight.userdev") version "%%_USERDEV_VER_%%"
51+
id("io.papermc.paperweight.userdev") version "%%_MAJ_MIN_PAT_USERDEV_%%"
5252
}
5353
```
5454
</VersionFormattedCode>

src/components/versioning/VersionFormattedCode.tsx

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import React, { useEffect, useRef, useState } from "react";
22
import CodeBlock from "@docusaurus/theme-classic/lib/theme/CodeBlock";
3-
import { getProjectVersion, VersionType, getUserdevVersion } from "../../util/versionUtils";
3+
import { getProjectVersion, VersionType } from "../../util/versionUtils";
44
import { useDocsVersion } from "@docusaurus/plugin-content-docs/client";
55

66
export default function VersionFormattedCode({
@@ -47,7 +47,10 @@ export default function VersionFormattedCode({
4747
await getProjectVersion("velocity", versionMeta)
4848
);
4949

50-
code = code.replace(/%%_USERDEV_VER_%%/g, await getUserdevVersion().value());
50+
code = code.replace(
51+
/%%_MAJ_MIN_PAT_USERDEV_%%/g,
52+
await getProjectVersion("userdev", versionMeta)
53+
);
5154

5255
if (mounted.current) {
5356
setFormattedCode({ code, inline });

src/util/versionUtils.ts

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -22,20 +22,32 @@ class ExpiringValue<T> {
2222
}
2323
}
2424

25+
const requestHeaders = { "User-Agent": "PaperMC-Docs" };
26+
2527
const createProjectVersionsValue = (
2628
project: string,
2729
ttl: number = 5 * 60 * 1000
2830
): ExpiringValue<string[]> => {
2931
return new ExpiringValue(ttl, async () => {
30-
const result = await fetch(`https://api.papermc.io/v2/projects/${project}`).then((r) =>
31-
r.json()
32-
);
32+
const result = await fetch(`https://api.papermc.io/v2/projects/${project}`, {
33+
headers: requestHeaders,
34+
}).then((r) => r.json());
3335

3436
return result.versions;
3537
});
3638
};
3739

38-
export type Project = "paper" | "velocity";
40+
const createUserdevVersionsValue = (ttl: number = 5 * 60 * 1000): ExpiringValue<string[]> => {
41+
return new ExpiringValue(ttl, async () => {
42+
const json = await fetch("https://api.github.com/repos/PaperMC/paperweight/tags", {
43+
headers: requestHeaders,
44+
}).then((r) => r.json());
45+
46+
return json.map((e) => e.name.substring(1)).reverse();
47+
});
48+
};
49+
50+
export type Project = "paper" | "velocity" | "userdev";
3951

4052
export enum VersionType {
4153
Major,
@@ -48,6 +60,7 @@ export enum VersionType {
4860
const projects: Record<Project, ExpiringValue<string[]>> = {
4961
paper: createProjectVersionsValue("paper"),
5062
velocity: createProjectVersionsValue("velocity"),
63+
userdev: createUserdevVersionsValue(),
5164
};
5265

5366
export interface DocusaurusVersion {
@@ -86,16 +99,3 @@ export const getProjectVersion = async (
8699

87100
return version;
88101
};
89-
90-
export const getUserdevVersion = (ttl: number = 5 * 60 * 1000): ExpiringValue<string> => {
91-
return new ExpiringValue(ttl, async () => {
92-
const response = await fetch("https://api.github.com/repos/PaperMC/paperweight/tags");
93-
94-
if (!response.ok) {
95-
return "<insert_latest_version>";
96-
}
97-
98-
const json = await response.json();
99-
return json[0].name.substring(1);
100-
});
101-
};

0 commit comments

Comments
 (0)