implement suggestions from code review

- drop `axios` dependency
- always throw if `TOKEN`s are unset
- log errors to console
- extract bot data logic to its own file
- use bot's avatar as fallback for translators

Author: its-miroma

.vitepress/data/authors.data.ts

@@ -32,6 +32,7 @@ export default {
     const authorsArray = await Promise.all(
       Array.from(authors.values()).map(async (author) => {
         try {
+          if (!GITHUB_TOKEN) throw new Error("GITHUB_TOKEN is unset")
           const { data } = await octokit.rest.users.getByUsername({
             username: author.login,
           });
@@ -43,26 +44,15 @@ export default {
             number: author.files,
           } as DefaultTheme.TeamMember & { number: number };
         } catch (error) {
-          // Allows build without internet
+          console.error("Error: ", error);
           return null;
         }
       })
     );
 
-    const { data } = await (async () => {
-      try {
-        return await octokit.rest.users.getByUsername({
-          username: "FabricMCBot",
-        });
-      } catch (e) {
-        // Allows build without internet
-        return { data: { avatar_url: "" } };
-      }
-    })();
     const authorsNoGitHubArray = Array.from(authorsNoGitHub.values()).map(
       (author) =>
         ({
-          avatar: data.avatar_url,
           name: author.login,
           number: author.files,
         } as DefaultTheme.TeamMember & { number: number })

.vitepress/data/bot.data.ts

@@ -0,0 +1,26 @@
+import { Octokit } from "octokit";
+import { DefaultTheme } from "vitepress";
+
+const LOGIN = "FabricMCBot";
+const GITHUB_TOKEN = process.env.GITHUB_TOKEN || "";
+const octokit = new Octokit({ auth: GITHUB_TOKEN });
+
+export default {
+  async load() {
+    const { data } = await (async () => {
+      try {
+        return await octokit.rest.users.getByUsername({
+          username: LOGIN,
+        });
+      } catch (error) {
+        console.error("Error: ", error);
+        return { data: { avatar_url: `https://github.com/${LOGIN}.png` } };
+      }
+    })();
+
+    return {
+      avatar: data.avatar_url,
+      name: LOGIN,
+    } as DefaultTheme.TeamMember;
+  },
+};

.vitepress/data/committers.data.ts

@@ -8,25 +8,16 @@ export default {
   async load() {
     const contributors = await (async () => {
       try {
+        if (!GITHUB_TOKEN) throw new Error("GITHUB_TOKEN is unset")
         return await octokit.paginate(octokit.rest.repos.listContributors, {
           owner: "FabricMC",
           repo: "fabric-docs",
         });
-      } catch (e) {
-        // Allows build without internet
+      } catch (error) {
+        console.error("Error: ", error);
         return [];
       }
     })();
-    const { data } = await (async () => {
-      try {
-        return await octokit.rest.users.getByUsername({
-          username: "FabricMCBot",
-        });
-      } catch (e) {
-        // Allows build without internet
-        return { data: { avatar_url: "" } };
-      }
-    })();
 
     return contributors
       .filter(
@@ -36,7 +27,7 @@ export default {
       .map(
         (contributor) =>
           ({
-            avatar: contributor.avatar_url || data.avatar_url,
+            avatar: contributor.avatar_url,
             links: [{ icon: "github", link: contributor.html_url }],
             name: contributor.login,
             number: contributor.contributions,

.vitepress/data/maintainers.data.ts

@@ -8,12 +8,13 @@ export default {
   async load() {
     const members = await (async () => {
       try {
+        if (!GITHUB_TOKEN) throw new Error("GITHUB_TOKEN is unset")
         return await octokit.paginate(octokit.rest.teams.listMembersInOrg, {
           org: "FabricMC",
           team_slug: "documentation",
         });
-      } catch (e) {
-        // Allows build without a GITHUB_TOKEN or without internet
+      } catch (error) {
+        console.error("Error: ", error);
         return [];
       }
     })();
@@ -23,11 +24,12 @@ export default {
         members.map(async (member) => ({
           val: await (async () => {
             try {
+              if (!GITHUB_TOKEN) throw new Error("GITHUB_TOKEN is unset")
               return await octokit.paginate(octokit.rest.orgs.listForUser, {
                 username: member.login,
               });
-            } catch (e) {
-              // Allows build without internet
+            } catch (error) {
+              console.error("Error: ", error);
               return [{ login: "FabricMC" }];
             }
           })(),

.vitepress/data/translators.data.ts

@@ -1,5 +1,4 @@
 import crowdin from "@crowdin/crowdin-api-client";
-import axios from "axios";
 import { DefaultTheme } from "vitepress";
 
 const CROWDIN_TOKEN = process.env.CROWDIN_TOKEN || "";
@@ -8,16 +7,14 @@ const { sourceFilesApi, reportsApi } = (() => {
   try {
     //@ts-expect-error https://github.com/crowdin/crowdin-api-client-js/issues/98
     return new crowdin.default({ token: CROWDIN_TOKEN });
-  } catch (e) {
-    // Allows build without a CROWDIN_TOKEN or without internet
+  } catch (error) {
     return { sourceFilesApi: {}, reportsApi: {} };
   }
 })();
 
 export default {
   async load() {
     if (!CROWDIN_TOKEN) return [];
-
     const { data: directories } = await sourceFilesApi.listProjectDirectories(
       PROJECT_ID,
       {
@@ -53,13 +50,15 @@ export default {
       }
 
       report = (
-        await axios.get(
-          (
-            await reportsApi.downloadReport(PROJECT_ID, identifier)
-          ).data.url
-        )
-      ).data.data;
-    } catch (e) {}
+        await (
+          await fetch(
+            (
+              await reportsApi.downloadReport(PROJECT_ID, identifier)
+            ).data.url
+          )
+        ).json()
+      ).data;
+    } catch (error) {}
 
     const translators = new Map<
       string,
@@ -89,9 +88,7 @@ export default {
       .map(
         (contributor) =>
           ({
-            avatar:
-              contributor.avatar ||
-              "https://i2.wp.com/crowdin.com/images/user-picture.png?ssl=1",
+            avatar: contributor.avatar,
             links: [
               {
                 icon: "crowdin",

credits.md

@@ -19,6 +19,7 @@ import {
 import { computed } from "vue";
 
 import { data as _authors } from "/.vitepress/data/authors.data";
+import { data as _bot } from "/.vitepress/data/bot.data";
 import { data as _committers } from "/.vitepress/data/committers.data";
 import { data as _maintainers } from "/.vitepress/data/maintainers.data";
 import { data as _translators } from "/.vitepress/data/translators.data";
@@ -31,6 +32,7 @@ const options = computed(
 
 const authors = _authors.map((author) => ({
   ...author,
+  avatar: author.avatar || _bot.avatar;
   title:
     author.number === 1
       ? options.value.authors.description.singular
@@ -42,6 +44,7 @@ const authors = _authors.map((author) => ({
 
 const committers = _committers.map((committer) => ({
   ...committer,
+  avatar: committer.avatar || _bot.avatar;
   title:
     committer.number === 1
       ? options.value.committers.description.singular
@@ -55,6 +58,7 @@ const maintainers = _maintainers;
 
 const translators = _translators.map((translator) => ({
   ...translator,
+  avatar: translator.avatar || _bot.avatar;
   title:
     translator.number === 1
       ? options.value.translators.description.singular

package-lock.json

@@ -24,7 +24,6 @@
   "dependencies": {
     "@crowdin/crowdin-api-client": "^1.41.1",
     "@vueuse/core": "^12.4.0",
-    "axios": "^1.7.9",
     "markdown-it-mathjax3": "^4.3.2",
     "markdown-it-vuepress-code-snippet-enhanced": "github:IMB11/md-it-enhanced-snippets#dfb9fa2",
     "medium-zoom": "^1.1.0",