Merge branch 'main' into repo-sync

Author: Octomerger

lib/get-english-headings.js

@@ -1,5 +1,7 @@
-// capture h2, h3, and h4 headings
-const headingRegex = /^###?#? (.*?)$/gm
+const astFromMarkdown = require('mdast-util-from-markdown')
+const toString = require('mdast-util-to-string')
+const visit = require('unist-util-visit')
+const findPage = require('./find-page')
 
 // for any translated page, first get corresponding English markdown
 // then get the headings on both the translated and English pageMap
@@ -16,22 +18,31 @@ module.exports = function getEnglishHeadings (page, context) {
     }, {})
   }
 
-  const translatedHeadings = page.markdown.match(headingRegex)
-  if (!translatedHeadings) return
+  const translatedHeadings = getHeadings(page.markdown)
+  if (!translatedHeadings.length) return
 
-  const englishPage = context.pages[`/en/${page.relativePath.replace(/.md$/, '')}`]
+  const englishPage = findPage(`/en/${page.relativePath.replace(/.md$/, '')}`, context.pages, context.redirects)
   if (!englishPage) return
 
   // FIX  there may be bugs if English headings are updated before Crowdin syncs up :/
-  const englishHeadings = englishPage.markdown.match(headingRegex)
-  if (!englishHeadings) return
-
-  // select heading text only
-  const cleanTranslatedHeadings = translatedHeadings.map(h => h.replace(headingRegex, '$1'))
-  const cleanEnglishHeadings = englishHeadings.map(h => h.replace(headingRegex, '$1'))
+  const englishHeadings = getHeadings(englishPage.markdown)
+  if (!englishHeadings.length) return
 
   // return a map from translation:English
-  return Object.assign(...cleanTranslatedHeadings.map((k, i) => ({
-    [k]: cleanEnglishHeadings[i]
+  return Object.assign(...translatedHeadings.map((k, i) => ({
+    [k]: englishHeadings[i]
   })))
 }
+
+function getHeadings (markdown) {
+  const ast = astFromMarkdown(markdown)
+  const headings = []
+
+  visit(ast, node => {
+    if (node.type !== 'heading') return
+    if (![2, 3, 4].includes(node.depth)) return
+    headings.push(toString(node))
+  })
+
+  return headings
+}

package-lock.json

@@ -57,6 +57,8 @@
     "lodash": "^4.17.21",
     "lunr": "^2.3.9",
     "lunr-languages": "^1.4.0",
+    "mdast-util-to-string": "^2.0.0",
+    "mdast-util-from-markdown": "^0.8.5",
     "morgan": "^1.10.0",
     "next": "^11.0.0",
     "node-fetch": "^2.6.1",
@@ -148,7 +150,6 @@
     "jest-slow-test-reporter": "^1.0.0",
     "linkinator": "^2.13.6",
     "make-promises-safe": "^5.1.0",
-    "mdast-util-from-markdown": "^0.8.4",
     "mini-css-extract-plugin": "^1.6.0",
     "mkdirp": "^1.0.4",
     "mock-express-response": "^0.3.0",

package.json

@@ -251,6 +251,16 @@ describe('server', () => {
       const $ = await getDOM('/github/getting-started-with-github')
       expect($('h2#in-this-article').length).toBe(0)
     })
+
+    test('renders mini TOC with correct links when headings contain markup', async () => {
+      const $ = await getDOM('/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates')
+      expect($('h2#in-this-article + ul li a[href="#package-ecosystem"]').length).toBe(1)
+    })
+
+    test('renders mini TOC with correct links when headings contain markup in localized content', async () => {
+      const $ = await getDOM('/ja/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates')
+      expect($('h2#in-this-article + ul li a[href="#package-ecosystem"]').length).toBe(1)
+    })
   })
 
   describe('image asset paths', () => {