tools: update doc tools to [email protected]

PR-URL: #36049 Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Daijiro Wachi <[email protected]>
nodejs · Nov 22, 2020 · 63494e4 · 63494e4
1 parent 500e709
commit 63494e4
Show file tree

Hide file tree

Showing 6 changed files with 1,362 additions and 63 deletions.
diff --git a/tools/doc/addon-verify.js b/tools/doc/addon-verify.js
@@ -11,13 +11,14 @@ const { resolve } = require('path');
 const vfile = require('to-vfile');
 const unified = require('unified');
 const remarkParse = require('remark-parse');
+const gfm = require('remark-gfm');
 
 const rootDir = resolve(__dirname, '..', '..');
 const doc = resolve(rootDir, 'doc', 'api', 'addons.md');
 const verifyDir = resolve(rootDir, 'test', 'addons');
 
 const file = vfile.readSync(doc, 'utf8');
-const tree = unified().use(remarkParse).parse(file);
+const tree = unified().use(remarkParse).use(gfm).parse(file);
 const addons = {};
 let id = 0;
 let currentHeader;

diff --git a/tools/doc/checkLinks.js b/tools/doc/checkLinks.js
@@ -45,6 +45,7 @@ function findMarkdownFilesRecursively(dirPath) {
 function checkFile(path) {
   const tree = unified()
     .use(require('remark-parse'))
+    .use(require('remark-gfm'))
     .parse(fs.readFileSync(path));
 
   const base = pathToFileURL(path);

diff --git a/tools/doc/generate.js b/tools/doc/generate.js
@@ -25,6 +25,7 @@ const { promises: fs } = require('fs');
 const path = require('path');
 const unified = require('unified');
 const markdown = require('remark-parse');
+const gfm = require('remark-gfm');
 const remark2rehype = require('remark-rehype');
 const raw = require('rehype-raw');
 const htmlStringify = require('rehype-stringify');
@@ -82,6 +83,7 @@ async function main() {
   const content = await unified()
     .use(replaceLinks, { filename, linksMapper })
     .use(markdown)
+    .use(gfm)
     .use(html.preprocessText, { nodeVersion })
     .use(json.jsonAPI, { filename })
     .use(html.firstHeader)

diff --git a/tools/doc/html.js b/tools/doc/html.js
@@ -27,6 +27,7 @@ const unified = require('unified');
 const find = require('unist-util-find');
 const visit = require('unist-util-visit');
 const markdown = require('remark-parse');
+const gfm = require('remark-gfm');
 const remark2rehype = require('remark-rehype');
 const raw = require('rehype-raw');
 const htmlStringify = require('rehype-stringify');
@@ -56,6 +57,7 @@ const gtocMD = fs.readFileSync(gtocPath, 'utf8')
   .replace(/^<!--.*?-->/gms, '');
 const gtocHTML = unified()
   .use(markdown)
+  .use(gfm)
   .use(remark2rehype, { allowDangerousHtml: true })
   .use(raw)
   .use(navClasses)
@@ -283,6 +285,7 @@ function parseYAML(text) {
     meta.changes.forEach((change) => {
       const description = unified()
         .use(markdown)
+        .use(gfm)
         .use(remark2rehype, { allowDangerousHtml: true })
         .use(raw)
         .use(htmlStringify)
@@ -381,6 +384,7 @@ function buildToc({ filename, apilinks }) {
 
     file.toc = unified()
       .use(markdown)
+      .use(gfm)
       .use(remark2rehype, { allowDangerousHtml: true })
       .use(raw)
       .use(htmlStringify)