feat: warning message when md links are broken (#1116)

feat: show a warning message when md links are broken
facebook · Nov 23, 2018 · 711c15d · 711c15d
1 parent 1e83613
commit 711c15d
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/v1/lib/server/docs.js b/v1/lib/server/docs.js
@@ -49,6 +49,7 @@ function mdToHtmlify(oldContent, mdToHtml, metadata) {
   let content = oldContent;
   const mdLinks = [];
   const mdReferences = [];
+  const mdBrokenLinks = [];
 
   // find any inline-style links to markdown files
   const linkRegex = /(?:\]\()(?:\.\/)?([^'")\]\s>]+\.md)/g;
@@ -81,6 +82,8 @@ function mdToHtmlify(oldContent, mdToHtml, metadata) {
         new RegExp(`\\]\\((\\./)?${mdLink}`, 'g'),
         `](${htmlLink}`,
       );
+    } else {
+      mdBrokenLinks.push(mdLink);
     }
   });
 
@@ -100,8 +103,17 @@ function mdToHtmlify(oldContent, mdToHtml, metadata) {
         new RegExp(`\\]:(?:\\s)?(\\./|\\.\\./)?${refLink}`, 'g'),
         `]: ${htmlLink}`,
       );
+    } else {
+      mdBrokenLinks.push(refLink);
     }
   });
+
+  if (mdBrokenLinks.length) {
+    console.log(
+      `[WARN] unresolved links in file '${metadata.source}' >`,
+      mdBrokenLinks,
+    );
+  }
   return content;
 }