Merge pull request #159 from ethereum/tutorialsPageMigration

/developers/tutorials page migration

Author: pettinarip

src/lib/utils/md.ts

@@ -2,16 +2,22 @@ import fs from "fs"
 import { extname, join } from "path"
 
 import matter from "gray-matter"
+import readingTime from "reading-time"
 
 import type { Frontmatter } from "@/lib/types"
 import type { MdPageContent } from "@/lib/interfaces"
 
+import { Skill } from "@/components/TutorialMetadata"
+
+import { dateToString } from "@/lib/utils/date"
 import { getFallbackEnglishPath, removeEnglishPrefix } from "@/lib/utils/i18n"
 
 import { CONTENT_DIR, DEFAULT_LOCALE, LOCALES_CODES } from "@/lib/constants"
 
 import { toPosixPath } from "./relativePath"
 
+import { ITutorial } from "@/pages/developers/tutorials"
+
 const CURRENT_CONTENT_DIR = join(process.cwd(), CONTENT_DIR)
 
 const getPostSlugs = (dir: string, files: string[] = []) => {
@@ -340,3 +346,34 @@ export const getContent = (dir: string) => {
 
   return content
 }
+
+export const getTutorialsData = (locale: string): ITutorial[] => {
+  const fullPath = join(CURRENT_CONTENT_DIR, locale !== 'en' ? `translations/${locale!}` : '', 'developers/tutorials')
+  let tutorialData: ITutorial[] = []
+
+  if (fs.existsSync(fullPath)) {
+    const languageTutorialFiles = fs.readdirSync(fullPath)
+
+    tutorialData = languageTutorialFiles.map((dir) => {
+      const filePath = join(CURRENT_CONTENT_DIR, locale !== 'en' ? `translations/${locale!}` : '', 'developers/tutorials', dir, 'index.md')
+      const fileContents = fs.readFileSync(filePath, "utf8")
+      const { data, content } = matter(fileContents)
+      const frontmatter = data as Frontmatter
+      
+      return {
+        to: join(`/${locale}/developers/tutorials`, dir),
+        title: frontmatter.title,
+        description: frontmatter.description,
+        author: frontmatter.author || '',
+        tags: frontmatter.tags,
+        skill: frontmatter.skill as Skill,
+        timeToRead: Math.round(readingTime(content).minutes),
+        published: dateToString(frontmatter.published),
+        lang: frontmatter.lang, 
+        isExternal: false,
+      }
+    })
+  }
+
+  return tutorialData
+}

src/lib/utils/translations.ts

@@ -94,6 +94,10 @@ const getRequiredNamespacesForPath = (path: string) => {
     requiredNamespaces = [...requiredNamespaces, "page-developers-index", "page-developers-learning-tools"]
   }
 
+  if (path.startsWith("/developers/tutorials")) {
+    requiredNamespaces = [...requiredNamespaces, "page-developers-tutorials"]
+  }
+
   if (path.startsWith("/developers/docs/scaling")) {
     requiredNamespaces = [...requiredNamespaces, "page-layer-2"]
   }

src/lib/utils/tutorial.ts

@@ -0,0 +1,92 @@
+import { Lang } from "@/lib/types"
+
+import { Skill } from "@/components/TutorialMetadata"
+
+import { IExternalTutorial, ITutorial } from "@/pages/developers/tutorials"
+
+// Take all tutorials, and return a list of tutorials for a specific locale
+export const filterTutorialsByLang = (
+  internalTutorials: any,
+  externalTutorials: Array<IExternalTutorial>,
+  locale: Lang
+): Array<ITutorial> => {
+  const internalTutorialsMap = internalTutorials.map((tutorial) => {
+    const lang = tutorial?.lang || "en"
+
+    return {
+      to: tutorial.to || "",
+      title: tutorial?.title || "",
+      description: tutorial?.description || "",
+      author: tutorial?.author || "",
+      tags: tutorial?.tags?.map((tag) =>
+        (tag || "").toLowerCase().trim()
+      ),
+      skill: tutorial?.skill as Skill,
+      timeToRead: tutorial?.timeToRead,
+      published: tutorial?.published,
+      lang: tutorial?.lang,
+      isExternal: false,
+    }
+  })
+
+  const externalTutorialsMap = externalTutorials.map<ITutorial>(
+    (tutorial: IExternalTutorial) => ({
+      to: tutorial.url,
+      title: tutorial.title,
+      description: tutorial.description,
+      author: tutorial.author,
+      tags: tutorial.tags.map((tag) => tag.toLowerCase().trim()),
+      skill: tutorial.skillLevel as Skill,
+      timeToRead: Number(tutorial.timeToRead),
+      published: new Date(tutorial.publishDate).toISOString(),
+      lang: tutorial.lang || "en",
+      isExternal: true,
+    })
+  )
+
+  const allTutorials: Array<ITutorial> = [
+    ...externalTutorialsMap,
+    ...internalTutorialsMap,
+  ]
+
+  const filteredTutorials = allTutorials
+    .filter((tutorial) => tutorial.lang === locale)
+    .sort((a, b) => {
+      if (a.published && b.published) {
+        return new Date(b.published).getTime() - new Date(a.published).getTime()
+      }
+      // Dont order if no published is present
+      return 0
+    })
+
+  return filteredTutorials
+}
+
+export const getSortedTutorialTagsForLang = (
+  filteredTutorialsByLang: Array<ITutorial> = []
+) => {
+  const allTags = filteredTutorialsByLang.reduce<Array<string>>(
+    (tags, tutorial) => {
+      return [...tags, ...(tutorial.tags || [])]
+    },
+    []
+  )
+
+  const reducedTags = allTags.reduce((acc, tag) => {
+    if (acc[tag]) {
+      acc[tag] = acc[tag] + 1
+    } else {
+      acc[tag] = 1
+    }
+    return acc
+  }, {})
+
+  const sortedTags = Object.keys(reducedTags)
+    .sort()
+    .reduce((obj, key) => {
+      obj[key] = reducedTags[key]
+      return obj
+    }, {})
+
+  return sortedTags
+}