chore: update names

Author: wackerow

.gitignore

@@ -56,4 +56,4 @@ robots.txt
 # Crowdin report output
 src/data/crowdin/bucketsAwaitingReviewReport.csv
 
-src/data/commit-history.json
+src/data/git-contributor-cache.json

package.json

@@ -6,7 +6,7 @@
     "dev": "yarn clean-commit-history && next dev",
     "postinstall": "yarn theme",
     "build": "yarn clean-commit-history && next build",
-    "clean-commit-history": "touch ./src/data/commit-history.json && rm ./src/data/commit-history.json",
+    "clean-commit-history": "touch ./src/data/git-contributor-cache.json && rm ./src/data/git-contributor-cache.json",
     "postbuild": "next-sitemap",
     "start": "next start",
     "lint": "next lint",

src/lib/api/fetchGitHistory.ts

@@ -4,8 +4,8 @@ import { join } from "path"
 import type { FileContributor } from "@/lib/types"
 
 import {
-  COMMIT_HISTORY_JSON,
   CONTENT_DIR,
+  GIT_CONTRIBUTOR_CACHE_JSON,
   GITHUB_COMMITS_URL,
   OLD_CONTENT_DIR,
 } from "@/lib/constants"
@@ -49,11 +49,12 @@ async function fetchWithRateLimit(
 }
 
 // Fetch commit history and save it to a JSON file
-export const fetchAndSaveGitHistory = async (mdDir: string) => {
+export const fetchAndCacheGitContributors = async (mdDir: string) => {
   const filepath = join("/", mdDir, "index.md")
 
-  const commitHistory = fs.existsSync(COMMIT_HISTORY_JSON)
-    ? JSON.parse(fs.readFileSync(COMMIT_HISTORY_JSON, "utf8"))
+  // Load cache
+  const commitHistory = fs.existsSync(GIT_CONTRIBUTOR_CACHE_JSON)
+    ? JSON.parse(fs.readFileSync(GIT_CONTRIBUTOR_CACHE_JSON, "utf8"))
     : {}
 
   // First, check cache for existing commit history for English version (despite locale)
@@ -83,7 +84,10 @@ export const fetchAndSaveGitHistory = async (mdDir: string) => {
 
   // Amend to commitHistory log and save
   commitHistory[filepath] = uniqueContributors
-  fs.writeFileSync(COMMIT_HISTORY_JSON, JSON.stringify(commitHistory, null, 2))
+  fs.writeFileSync(
+    GIT_CONTRIBUTOR_CACHE_JSON,
+    JSON.stringify(commitHistory, null, 2)
+  )
 
   return uniqueContributors
 }

src/lib/constants.ts

@@ -150,4 +150,4 @@ export const HAMBURGER_BUTTON_ID = "mobile-menu-button"
 export const MOBILE_LANGUAGE_BUTTON_NAME = "mobile-language-button"
 export const DESKTOP_LANGUAGE_BUTTON_NAME = "desktop-language-button"
 
-export const COMMIT_HISTORY_JSON = "src/data/commit-history.json"
+export const GIT_CONTRIBUTOR_CACHE_JSON = "src/data/git-contributor-cache.json"

src/pages/[...slug].tsx

@@ -55,7 +55,7 @@ import {
   UseCasesLayout,
 } from "@/layouts"
 import { fetchGFIs } from "@/lib/api/fetchGFIs"
-import { fetchAndSaveGitHistory } from "@/lib/api/fetchGitHistory"
+import { fetchAndCacheGitContributors } from "@/lib/api/fetchGitHistory"
 import rehypeHeadingIds from "@/lib/rehype/rehypeHeadingIds"
 import rehypeImg from "@/lib/rehype/rehypeImg"
 import remarkInferToc from "@/lib/rehype/remarkInferToc"
@@ -181,7 +181,7 @@ export const getStaticProps = (async (context) => {
 
   const gfissues = await gfIssuesDataFetch()
 
-  const contributors = await fetchAndSaveGitHistory(mdDir)
+  const gitContributors = await fetchAndCacheGitContributors(mdDir)
 
   return {
     props: {
@@ -197,7 +197,7 @@ export const getStaticProps = (async (context) => {
       tocItems,
       crowdinContributors,
       gfissues,
-      contributors,
+      contributors: gitContributors,
     },
   }
 }) satisfies GetStaticProps<Props, Params>