credits

Author: its-miroma

.vitepress/data/authors.data.ts

@@ -0,0 +1,71 @@
+import { Octokit } from "octokit";
+import { createContentLoader, DefaultTheme } from "vitepress";
+
+const GITHUB_TOKEN = process.env.GITHUB_TOKEN || "";
+const octokit = new Octokit({ auth: GITHUB_TOKEN });
+
+export default {
+  async load() {
+    const authors = new Map<string, { files: number; login: string }>();
+    const authorsNoGitHub = new Map<string, { files: number; login: string }>();
+
+    const markdownData = await createContentLoader(["**/*.md"], {
+      globOptions: {
+        ignore: ["node_modules/**/*", "translated/**/*", "versions/**/*"],
+      },
+    }).load();
+
+    markdownData.forEach(async (file) => {
+      file.frontmatter["authors"]?.forEach((login: string) => {
+        const author = authors.get(login) || { login, files: 0 };
+        author.files++;
+        authors.set(login, author);
+      });
+
+      file.frontmatter["authors-nogithub"]?.forEach((login: string) => {
+        const author = authorsNoGitHub.get(login) || { login, files: 0 };
+        author.files++;
+        authorsNoGitHub.set(login, author);
+      });
+    });
+
+    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,
+          });
+
+          return {
+            avatar: data.avatar_url,
+            links: [{ icon: "github", link: data.html_url }],
+            name: data.login,
+            number: author.files,
+          } as DefaultTheme.TeamMember & { number: number };
+        } catch (error) {
+          //console.error(error);
+          return {
+            name: author.login,
+            number: author.files,
+          };
+        }
+      })
+    );
+
+    const authorsNoGitHubArray = Array.from(authorsNoGitHub.values()).map(
+      (author) =>
+        ({
+          name: author.login,
+          number: author.files,
+        } as DefaultTheme.TeamMember & { number: number })
+    );
+
+    return [
+      ...authorsArray.filter((author) => !!author),
+      ...authorsNoGitHubArray,
+    ]
+      .sort((a, b) => a.name.localeCompare(b.name))
+      .sort((a, b) => b.number - a.number);
+  },
+};

.vitepress/data/committers.data.ts

@@ -0,0 +1,39 @@
+import { Octokit } from "octokit";
+import { DefaultTheme } from "vitepress";
+
+const GITHUB_TOKEN = process.env.GITHUB_TOKEN || "";
+const octokit = new Octokit({ auth: GITHUB_TOKEN });
+
+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 (error) {
+        console.error(error);
+        return [];
+      }
+    })();
+
+    return contributors
+      .filter(
+        (contributor) =>
+          contributor.login && contributor.login !== "FabricMCBot"
+      )
+      .map(
+        (contributor) =>
+          ({
+            avatar: contributor.avatar_url,
+            links: [{ icon: "github", link: contributor.html_url }],
+            name: contributor.login,
+            number: contributor.contributions,
+          } as DefaultTheme.TeamMember & { number: number })
+      )
+      .sort((a, b) => a.name.localeCompare(b.name))
+      .sort((a, b) => b.number - a.number);
+  },
+};

.vitepress/data/maintainers.data.ts

@@ -0,0 +1,55 @@
+import { Octokit } from "octokit";
+import { DefaultTheme } from "vitepress";
+
+const GITHUB_TOKEN = process.env.GITHUB_TOKEN || "";
+const octokit = new Octokit({ auth: GITHUB_TOKEN });
+
+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 (error) {
+        console.error(error);
+        return [];
+      }
+    })();
+
+    return (
+      await Promise.all(
+        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 (error) {
+              console.error(error);
+              return [{ login: "FabricMC" }];
+            }
+          })(),
+          member,
+        }))
+      )
+    )
+      .filter(
+        (result) =>
+          result.val.map((org) => org.login).includes("FabricMC") &&
+          result.member.login !== "FabricMCBot"
+      )
+      .map(
+        (result) =>
+          ({
+            avatar: result.member.avatar_url,
+            links: [{ icon: "github", link: result.member.html_url }],
+            name: result.member.login,
+          } as DefaultTheme.TeamMember)
+      )
+      .sort((a, b) => a.name.localeCompare(b.name));
+  },
+};

.vitepress/data/translators.data.ts

@@ -0,0 +1,110 @@
+import {
+  default as Client,
+  default as crowdin,
+} from "@crowdin/crowdin-api-client";
+import { DefaultTheme } from "vitepress";
+
+const CROWDIN_TOKEN = process.env.CROWDIN_TOKEN || "";
+const PROJECT_ID = 647524;
+const { sourceFilesApi, reportsApi } = (() => {
+  try {
+    //@ts-expect-error https://github.com/crowdin/crowdin-api-client-js/issues/98
+    return new crowdin.default({ token: CROWDIN_TOKEN }) as Client;
+  } catch (error) {
+    return { sourceFilesApi: {}, reportsApi: {} } as Client;
+  }
+})();
+
+export default {
+  async load() {
+    if (!CROWDIN_TOKEN) return [];
+    const { data: directories } = await sourceFilesApi.listProjectDirectories(
+      PROJECT_ID,
+      {
+        filter: "fabric-docs",
+      }
+    );
+
+    const { data: files } = await sourceFilesApi
+      .withFetchAll()
+      .listProjectFiles(PROJECT_ID, {
+        directoryId: directories[0].data.directoryId,
+        filter: "**",
+      });
+
+    let report: any[] = [];
+    try {
+      const identifier = (
+        await reportsApi.generateReport(PROJECT_ID, {
+          name: "contribution-raw-data",
+          schema: {
+            unit: "words",
+            mode: "translations",
+            fileIds: files.map((f) => f.data.id),
+          },
+        })
+      ).data.identifier;
+
+      while (
+        (await reportsApi.checkReportStatus(PROJECT_ID, identifier)).data
+          .status !== "finished"
+      ) {
+        setTimeout(() => {}, 2000);
+      }
+
+      report = (
+        await (
+          await fetch(
+            (
+              await reportsApi.downloadReport(PROJECT_ID, identifier)
+            ).data.url
+          )
+        ).json()
+      ).data;
+    } catch (error) {
+      console.error(error);
+    }
+
+    const translators = new Map<
+      string,
+      {
+        words: number;
+        languages: Set<string>;
+        avatar: string;
+        username: string;
+      }
+    >();
+
+    report.forEach((entry) => {
+      if (entry.user.username === "REMOVED_USER") return;
+
+      const user = translators.get(entry.user.username) || {
+        words: 0,
+        languages: new Set<string>(),
+        avatar: entry.user.avatarUrl,
+        username: entry.user.username,
+      };
+      user.words += entry.translated;
+      user.languages.add(entry.language.name);
+      translators.set(user.username, user);
+    });
+
+    return Array.from(translators.values())
+      .map(
+        (contributor) =>
+          ({
+            avatar: contributor.avatar,
+            links: [
+              {
+                icon: "crowdin",
+                link: `https://crowdin.com/profile/${contributor.username}`,
+              },
+            ],
+            name: contributor.username,
+            number: contributor.words,
+          } as DefaultTheme.TeamMember & { number: number })
+      )
+      .sort((a, b) => a.name.localeCompare(b.name))
+      .sort((a, b) => b.number - a.number);
+  },
+};

.vitepress/i18n.ts

@@ -131,6 +131,33 @@ export const getLocales = () => {
           },
         },
 
+        credits: {
+          authors: {
+            description: {
+              plural: resolver("credits.authors.description.plural"),
+              singular: resolver("credits.authors.description.singular"),
+            },
+            title: resolver("credits.authors"),
+          },
+          committers: {
+            description: {
+              plural: resolver("credits.committers.description.plural"),
+              singular: resolver("credits.committers.description.singular"),
+            },
+            title: resolver("credits.committers"),
+          },
+          maintainers: {
+            title: resolver("credits.maintainers"),
+          },
+          translators: {
+            description: {
+              plural: resolver("credits.translators.description.plural"),
+              singular: resolver("credits.translators.description.singular"),
+            },
+            title: resolver("credits.translators"),
+          },
+        },
+
         darkModeSwitchLabel: resolver("mode_switcher"),
 
         darkModeSwitchTitle: resolver("mode_dark"),

.vitepress/types.ts

@@ -40,6 +40,72 @@ export namespace Fabric {
     };
   }
 
+  export interface CreditsOptions {
+    authors: {
+      description: {
+        /**
+         * @default "%d pages"
+         */
+        plural: string;
+
+        /**
+         * @default "1 page"
+         */
+        singular: string;
+      };
+
+      /**
+       * @default "Pages Written"
+       */
+      title: string;
+    };
+
+    committers: {
+      description: {
+        /**
+         * @default "%d contributions"
+         */
+        plural: string;
+
+        /**
+         * @default "1 contribution"
+         */
+        singular: string;
+      };
+
+      /**
+       * @default "Contributions on GitHub"
+       */
+      title: string;
+    };
+
+    maintainers: {
+      /**
+       * @default "Maintenance"
+       */
+      title: string;
+    };
+
+    translators: {
+      description: {
+        /**
+         * @default "%d words"
+         */
+        plural: string;
+
+        /**
+         * @default "1 word"
+         */
+        singular: string;
+      };
+
+      /**
+       * @default "Translations on Crowdin"
+       */
+      title: string;
+    };
+  }
+
   export interface DownloadOptions {
     /**
      * Set custom text for download button.
@@ -157,6 +223,7 @@ export namespace Fabric {
   export interface ThemeConfig extends Versioned.ThemeConfig {
     authors: AuthorsOptions;
     banner: BannerOptions;
+    credits: CreditsOptions;
     download: DownloadOptions;
     env: EnvOptions;
     notFound: NotFoundOptions;