run script on translations and also update category index files

Author: sarahs

script/content-migrations/remove-map-topics.js

@@ -3,23 +3,33 @@
 const fs = require('fs')
 const path = require('path')
 const walk = require('walk-sync')
+const languages = require('../../lib/languages')
+const frontmatter = require('../../lib/read-frontmatter')
+const addRedirectToFrontmatter = require('../../lib/redirects/add-redirect-to-frontmatter')
 
 const relativeRefRegex = /\/[a-zA-Z0-9-]+/g
 const linkString = /{% [^}]*?link.*? \/(.*?) ?%}/m
 const linksArray = new RegExp(linkString.source, 'gm')
 
-const fullDirectoryPath = path.join(process.cwd(), '/content')
-const files = walk(fullDirectoryPath, {
+const walkOpts = {
   includeBasePath: true,
   directories: false
-})
+}
+
+// We only want category TOC files, not product TOCs.
+const categoryFileRegex = /content\/[^/]+?\/[^/]+?\/index.md/
+
+const fullDirectoryPaths = Object.values(languages).map(langObj => path.join(process.cwd(), langObj.dir, 'content'))
+const categoryIndexFiles = fullDirectoryPaths.map(fullDirectoryPath => walk(fullDirectoryPath, walkOpts)).flat()
+  .filter(file => categoryFileRegex.test(file))
+
+// const categoryIndexFiles = [ path.join(process.cwd(), 'content/desktop/installing-and-configuring-github-desktop/index.md') ]
 
-files.forEach(file => {
-  if (path.basename(file) !== 'index.md') return
+categoryIndexFiles.forEach(categoryIndexFile => {
+  let categoryIndexContent = fs.readFileSync(categoryIndexFile, 'utf8')
 
-  let fileContent = fs.readFileSync(file, 'utf-8')
   // find array of TOC link strings
-  const rawItems = fileContent.match(linksArray)
+  const rawItems = categoryIndexContent.match(linksArray)
   if (!rawItems || !rawItems[0].includes('topic_link_in_list')) return
 
   const pageToc = {}
@@ -37,24 +47,53 @@ files.forEach(file => {
       pageToc[currentTopic] = tmpArray
     }
   })
+
   for (const topic in pageToc) {
-    const oldTopicDirectory = path.dirname(file)
+    const oldTopicDirectory = path.dirname(categoryIndexFile)
     const newTopicDirectory = path.join(oldTopicDirectory, topic)
-    const topicFile = path.join(oldTopicDirectory, `${topic}.md`)
+    const oldTopicFile = path.join(oldTopicDirectory, `${topic}.md`)
+
+    // Some translated category TOCs may be outdated and contain incorrect links
+    if (!fs.existsSync(oldTopicFile)) continue
 
     if (!fs.existsSync(newTopicDirectory)) fs.mkdirSync(newTopicDirectory)
 
-    let topicContent = fs.readFileSync(topicFile, 'utf-8')
-    topicContent = topicContent.replace('mapTopic: true\n', '')
+    const { data, content } = frontmatter(fs.readFileSync(oldTopicFile, 'utf8'))
+    delete data.mapTopic
+
+    let topicContent = content
 
     const articles = pageToc[topic]
 
     articles.forEach(article => {
-      fs.renameSync(`${oldTopicDirectory}/${article}.md`, `${newTopicDirectory}/${article}.md`)
+      // Update the new map topic index file content
       topicContent = topicContent + `{% link_with_intro /${article} %}\n`
-      fileContent = fileContent.replace(`/{% link_in_list /${article}`, `/{% link_in_list /${newTopicDirectory}/${article}`)
+
+      // Update the category index file content
+      categoryIndexContent = categoryIndexContent.replace(`{% link_in_list /${article}`, `{% link_in_list /${topic}/${article}`)
+
+      // Early return if the article doesn't exist (some translated category TOCs may be outdated and contain incorrect links)
+      if (!fs.existsSync(`${oldTopicDirectory}/${article}.md`)) return
+
+      // Move the file under the new map topic directory
+      const newArticlePath = `${newTopicDirectory}/${article}.md`
+      fs.renameSync(`${oldTopicDirectory}/${article}.md`, newArticlePath)
+
+      // Read the article file so we can add a redirect from its old path
+      const articleContents = frontmatter(fs.readFileSync(newArticlePath, 'utf8'))
+      addRedirectToFrontmatter(articleContents.data.redirect_from, `${oldTopicDirectory}/${article}`)
+
+      // Write the article with updated frontmatter
+      fs.writeFileSync(newArticlePath, frontmatter.stringify(articleContents.content.trim(), articleContents.data, { lineWidth: 10000 }))
     })
-    fs.writeFileSync(`${newTopicDirectory}/index.md`, topicContent)
-    fs.unlinkSync(topicFile)
+
+    // Write the map topic index file
+    fs.writeFileSync(`${newTopicDirectory}/index.md`, frontmatter.stringify(topicContent.trim(), data, { lineWidth: 10000 }))
+
+    // Write the category index file
+    fs.writeFileSync(categoryIndexFile, categoryIndexContent)
+
+    // Delete the old map topic
+    fs.unlinkSync(oldTopicFile)
   }
 })