docs: resolve link checking successfully

aws-amplify · Oct 25, 2023 · 9496881 · 9496881
1 parent 702c332
commit 9496881
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 8 deletions.
diff --git a/docs/scripts/link-checker-puppeteer.ts b/docs/scripts/link-checker-puppeteer.ts
@@ -62,6 +62,7 @@ function reportResult(links: LinkInfo[]) {
     }
   } else {
     console.log('🎉 All links look good!');
+    process.exit();
   }
 }
 
@@ -95,7 +96,7 @@ async function runLinkChecker() {
     };
   });
 
-  await console.table(allPagesPathsNum);
+  console.table(allPagesPathsNum);
 
   const links = results.reduce((acc, curr) => [...acc, ...curr.links], []);
   reportResult(links);
@@ -104,5 +105,6 @@ async function runLinkChecker() {
 try {
   runLinkChecker();
 } catch (err) {
+  console.log(`Docs link check failure: ${err.message}`);
   process.exit(1);
 }
diff --git a/docs/scripts/util/checkLink.ts b/docs/scripts/util/checkLink.ts
@@ -67,7 +67,7 @@ async function returnStatus({
   }
 }
 
-export function checkLink(
+export async function checkLink(
   {
     href,
     tagName,
@@ -82,12 +82,7 @@ export function checkLink(
     pageUrl: string;
   },
   linkIdx: number
-): Promise<LinkInfo>;
-
-export async function checkLink(
-  { href, tagName, tagText, pageIdx, pageUrl },
-  linkIdx
-) {
+): Promise<LinkInfo> {
   return new Promise(async (res, rej) => {
     const linkData = { href, linkIdx, pageIdx, pageUrl, tagName, tagText };
     if (!href) {