chore: run React migration codemods, fix TypeScript errors

zlataovce · zlataovce · commit e20b753e9f97 · 2025-04-06T15:25:45.000+02:00
diff --git a/config/sidebar.folia.ts b/config/sidebar.folia.ts
@@ -51,4 +51,4 @@ const folia: SidebarsConfig = {
   ],
 };
 
-export = folia;
+export default folia;
diff --git a/config/sidebar.misc.ts b/config/sidebar.misc.ts
@@ -37,4 +37,4 @@ const misc: SidebarsConfig = {
   ],
 };
 
-export = misc;
+export default misc;
diff --git a/config/sidebar.paper.ts b/config/sidebar.paper.ts
@@ -231,4 +231,4 @@ const paper: SidebarsConfig = {
   ],
 };
 
-export = paper;
+export default paper;
diff --git a/config/sidebar.velocity.ts b/config/sidebar.velocity.ts
@@ -116,4 +116,4 @@ const velocity: SidebarsConfig = {
   ],
 };
 
-export = velocity;
+export default velocity;
diff --git a/config/sidebar.waterfall.ts b/config/sidebar.waterfall.ts
@@ -16,4 +16,4 @@ const waterfall: SidebarsConfig = {
   ],
 };
 
-export = waterfall;
+export default waterfall;
diff --git a/docusaurus.config.ts b/docusaurus.config.ts
@@ -15,7 +15,7 @@ import {
 } from "./src/util/authorUtils";
 import { preview, deploymentID } from "./src/util/pagesUtils";
 
-cacheAuthorData(preview || env.NODE_ENV === "development");
+cacheAuthorData(preview || env.NODE_ENV === "development").then();
 
 const url =
   (preview && `https://${deploymentID}.papermc-docs.pages.dev`) || "https://docs.papermc.io";
@@ -282,4 +282,4 @@ const config: Config = {
   },
 };
 
-export = config;
+export default config;
diff --git a/package.json b/package.json
@@ -27,6 +27,7 @@
     "@docusaurus/theme-common": "3.7.0",
     "@docusaurus/theme-mermaid": "3.7.0",
     "@docusaurus/theme-search-algolia": "3.7.0",
+    "@docusaurus/utils": "^3.7.0",
     "@floating-ui/react": "^0.27.6",
     "@fontsource/jetbrains-mono": "5.2.5",
     "@iconify/react": "5.2.1",
@@ -45,6 +46,7 @@
     "@docusaurus/tsconfig": "3.7.0",
     "@docusaurus/types": "3.7.0",
     "@fec/remark-a11y-emoji": "4.0.2",
+    "@octokit/types": "^13.10.0",
     "@types/is-ci": "3.0.4",
     "@types/js-yaml": "^4.0.9",
     "@types/node": "22.14.0",
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/src/components/Projects.tsx b/src/components/Projects.tsx
@@ -1,6 +1,6 @@
 import Link from "@docusaurus/Link";
 import clsx from "clsx";
-import React from "react";
+import React, { type JSX } from "react";
 import { Icon } from "@iconify/react";
 import "../css/projects.css";
 
diff --git a/src/components/config/ConfigDocBlock.tsx b/src/components/config/ConfigDocBlock.tsx
@@ -1,4 +1,4 @@
-import React, { useState, useEffect, useRef, ReactNode } from "react";
+import React, { useState, useEffect, useRef, ReactNode, type JSX } from "react";
 import ReactMarkdown from "react-markdown";
 import style from "@site/src/css/markdown-styles.module.css";
 import yaml from "js-yaml";
@@ -119,7 +119,7 @@ const parseItalics = (key: string) => {
 };
 
 const parseDescriptionForVersioning = (description: String) => {
-  return VersionFormattedCode({ children: description, plainText: true });
+  return VersionFormattedCode({ children: description, plainText: true }) as string;
 };
 
 const YamlNodeWithDescription = ({
diff --git a/src/components/config/ConfigurationStructureDiagram.tsx b/src/components/config/ConfigurationStructureDiagram.tsx
@@ -1,4 +1,4 @@
-import React, { useState } from "react";
+import React, { useState, type JSX } from "react";
 import "@site/src/css/configuration-explorer-layout.css";
 // @ts-ignore
 import { Icon } from "@iconify/react";
diff --git a/src/components/permission/Permissions.tsx b/src/components/permission/Permissions.tsx
@@ -1,4 +1,4 @@
-import React from "react";
+import React, { type JSX } from "react";
 
 interface Command {
   /** The primary name of the command as registered by Minecraft code. */
diff --git a/src/pages/index.tsx b/src/pages/index.tsx
@@ -1,4 +1,4 @@
-import React from "react";
+import React, { type JSX } from "react";
 import Layout from "@theme/Layout";
 import useDocusaurusContext from "@docusaurus/useDocusaurusContext";
 import styles from "../css/index.module.css";
diff --git a/src/theme/DocCard/index.tsx b/src/theme/DocCard/index.tsx
@@ -1,4 +1,4 @@
-import React, { type ReactNode } from "react";
+import React, { type ReactNode, type JSX } from "react";
 import clsx from "clsx";
 import Link from "@docusaurus/Link";
 import { findFirstSidebarItemLink, useDocById } from "@docusaurus/plugin-content-docs/client";
diff --git a/src/theme/DocItem/index.tsx b/src/theme/DocItem/index.tsx
@@ -1,4 +1,4 @@
-import React from "react";
+import React, { type JSX } from "react";
 import { HtmlClassNameProvider } from "@docusaurus/theme-common";
 import { DocProvider } from "@docusaurus/plugin-content-docs/client";
 import DocItemMetadata from "@theme/DocItem/Metadata";
@@ -23,8 +23,8 @@ function EOLMessage(message: string): JSX.Element {
 export default function DocItem(props: Props): JSX.Element {
   const docHtmlClassName = `docs-doc-id-${props.content.metadata.id}`;
   const MDXComponent = props.content;
-  const eolPage = props.content?.frontMatter?.eol === true;
-  const eolMessage = props.content?.frontMatter?.eol_message || "";
+  const eolPage = props.content?.frontMatter?.["eol"] === true;
+  const eolMessage = props.content?.frontMatter?.["eol_message"] || "";
 
   return (
     <DocProvider content={props.content}>
diff --git a/src/theme/DocVersionBadge/index.tsx b/src/theme/DocVersionBadge/index.tsx
@@ -1,4 +1,4 @@
-import React, { ComponentProps } from "react";
+import React, { ComponentProps, type JSX } from "react";
 import type DocVersionBadgeType from "@theme/DocVersionBadge";
 
 type Props = ComponentProps<typeof DocVersionBadgeType>;
diff --git a/src/theme/DocVersionBanner/index.tsx b/src/theme/DocVersionBanner/index.tsx
@@ -1,15 +1,14 @@
-import React, { type ComponentType } from "react";
+import React, { type ComponentType, type JSX } from "react";
 import clsx from "clsx";
-import useDocusaurusContext from "@docusaurus/useDocusaurusContext";
 import Link from "@docusaurus/Link";
 import Translate from "@docusaurus/Translate";
 import {
   useActivePlugin,
   useDocVersionSuggestions,
   type GlobalVersion,
 } from "@docusaurus/plugin-content-docs/client";
-import { ThemeClassNames, useDocsPreferredVersion } from "@docusaurus/theme-common";
-import { useDocsVersion } from "@docusaurus/plugin-content-docs/client";
+import { ThemeClassNames } from "@docusaurus/theme-common";
+import { useDocsVersion, useDocsPreferredVersion } from "@docusaurus/plugin-content-docs/client";
 
 import type { Props } from "@theme/DocVersionBanner";
 import type { VersionBanner, PropVersionMetadata } from "@docusaurus/plugin-content-docs";
@@ -104,9 +103,6 @@ function DocVersionBannerEnabled({
 }: Props & {
   versionMetadata: PropVersionMetadata;
 }): JSX.Element {
-  const {
-    siteConfig: { title: siteTitle },
-  } = useDocusaurusContext();
   const { pluginId } = useActivePlugin({ failfast: true })!;
 
   const getVersionMainDoc = (version: GlobalVersion) =>
diff --git a/src/theme/LastUpdated/index.tsx b/src/theme/LastUpdated/index.tsx
@@ -1,4 +1,4 @@
-import React from "react";
+import React, { type JSX } from "react";
 import Translate from "@docusaurus/Translate";
 import { ThemeClassNames } from "@docusaurus/theme-common";
 import { useDateTimeFormat } from "@docusaurus/theme-common/internal";
diff --git a/src/theme/NavbarItem/DocsVersionDropdownNavbarItem.tsx b/src/theme/NavbarItem/DocsVersionDropdownNavbarItem.tsx
@@ -1,4 +1,4 @@
-import React, { ComponentProps } from "react";
+import React, { ComponentProps, type JSX } from "react";
 import DocsVersionDropdownNavbarItem from "@theme-original/NavbarItem/DocsVersionDropdownNavbarItem";
 import type DocsVersionDropdownNavbarItemType from "@theme/NavbarItem/DocsVersionDropdownNavbarItem";
 import { useLocalPathname } from "@docusaurus/theme-common/internal";
diff --git a/src/theme/NavbarItem/DropdownNavbarItem.tsx b/src/theme/NavbarItem/DropdownNavbarItem.tsx
@@ -1,4 +1,4 @@
-import React, { useState, useRef, useEffect } from "react";
+import React, { useState, useRef, useEffect, type JSX } from "react";
 import clsx from "clsx";
 import { useCollapsible, Collapsible, isRegexpStringMatch } from "@docusaurus/theme-common";
 
diff --git a/src/util/authorUtils.ts b/src/util/authorUtils.ts
@@ -1,4 +1,4 @@
-import fs from "fs-extra";
+import { existsSync } from "fs";
 import path from "path";
 import { Endpoints } from "@octokit/types";
 
@@ -7,7 +7,7 @@ import { Globby } from "@docusaurus/utils/src/globUtils";
 
 type endpoint = Endpoints["GET /repos/{owner}/{repo}/commits/{ref}"];
 
-const headers = {
+const headers: Record<string, string> = {
   Accept: "application/vnd.github.v3+json",
   "User-Agent": "PaperMC-Docs",
 };
@@ -38,7 +38,7 @@ async function cacheUsernameFromCommit(commit: string) {
       throw new Error(`Received error status code ${response.status} (${response.statusText})`);
     }
 
-    const body = (await response.json()) as endpoint["response"];
+    const body = (await response.json()) as endpoint["response"]["data"];
     const username = body.author.login;
 
     commitCache.set(commit, username);
@@ -67,7 +67,7 @@ export async function cacheAuthorData(isPreview: boolean) {
   }
   const docPath = path.resolve("docs/");
 
-  if (!(await fs.pathExists(docPath))) {
+  if (!existsSync(docPath)) {
     return null;
   }
 
diff --git a/tsconfig.json b/tsconfig.json
@@ -1,8 +1,6 @@
 {
   "extends": "@docusaurus/tsconfig",
   "compilerOptions": {
-    "baseUrl": ".",
-    "moduleResolution": "Node16",
-    "lib": ["DOM", "ES2021"]
+    "baseUrl": "."
   }
 }
