refactor: separate into utils, sanitize characters

zlataovce · zlataovce · commit ffe9ac5e5889 · 2024-06-22T09:43:44.000+02:00
diff --git a/docusaurus.config.ts b/docusaurus.config.ts
@@ -13,13 +13,12 @@ import {
   cacheAuthorData,
   getFileCommitHashSafe,
 } from "./src/util/authorUtils";
+import { preview, deploymentID } from "./src/util/pagesUtils";
 
-const preview = isCI && env.CI_ENV === "preview";
 cacheAuthorData(preview || env.NODE_ENV === "development");
 
-const pagesId =
-  `${env.GITHUB_PR_HEAD_OWNER}-${env.GITHUB_HEAD_REF || env.GITHUB_REF_NAME}`.substring(0, 28);
-const url = (preview && `https://${pagesId}.papermc-docs.pages.dev`) || "https://docs.papermc.io";
+const url =
+  (preview && `https://${deploymentID}.papermc-docs.pages.dev`) || "https://docs.papermc.io";
 
 const docsCommon: Options = {
   breadcrumbs: true,
diff --git a/src/util/pagesUtils.ts b/src/util/pagesUtils.ts
@@ -0,0 +1,11 @@
+import { env } from "process";
+
+export const preview = env.CI_ENV === "preview";
+
+export const deploymentID: string =
+  `${env.GITHUB_PR_HEAD_OWNER}-${env.GITHUB_HEAD_REF || env.GITHUB_REF_NAME}` // <PR head branch owner username>-<head branch name>
+    .substring(0, 28) // capped to 28 characters
+    .toLowerCase() // lowercase
+    .replace("/", "-") // sanitize characters in branch names
+    .replace("_", "-")
+    .replace(".", "-");
