wip: refactor

facebook · Nov 23, 2023 · ca33fb8 · ca33fb8
1 parent f60242a
commit ca33fb8
Show file tree

Hide file tree

Showing 2 changed files with 53 additions and 19 deletions.
diff --git a/packages/docusaurus/src/server/__tests__/brokenLinks.test.ts b/packages/docusaurus/src/server/__tests__/brokenLinks.test.ts
@@ -134,21 +134,23 @@ describe('handleBrokenLinks', () => {
       },
       '/docs/goodDoc': {
         links: [
+          '#someHash',
+          '/community#anchorFromGoodDoc',
           './anotherGoodDoc#someHash',
           '/docs/anotherGoodDoc?someQueryString=true#someHash',
           '../docs/anotherGoodDoc?someQueryString=true',
           '../docs/anotherGoodDoc#someHash',
         ],
-        anchors: ['someHash'],
+        anchors: ['someHash'], // anchors here are anchors of the page itself (/docs/goodDoc) not the links in it
       },
       '/community': {
         links: [
           '/docs/goodDoc',
-          '/docs/anotherGoodDoc#someHash',
+          '/docs/anotherGoodDoc#someHash', // anchor here is an anchor of an other page, it should be checked against the anchors of the other page
           './docs/goodDoc#someHash',
           './docs/anotherGoodDoc',
         ],
-        anchors: [],
+        anchors: ['anchorFromGoodDoc'],
       },
       // '/page1': {
       //   links: [

diff --git a/packages/docusaurus/src/server/brokenLinks.ts b/packages/docusaurus/src/server/brokenLinks.ts
@@ -21,11 +21,46 @@ type BrokenLink = {
   anchor: boolean;
 };
 
+type CollectedLinks = {
+  [location: string]: {links: string[]; anchors: string[]};
+};
+
 // matchRoutes does not support qs/anchors, so we remove it!
 function onlyPathname(link: string) {
   return link.split('#')[0]!.split('?')[0]!;
 }
 
+function checkAnchorsInOtherRoutes(allCollectedCorrectLinks: CollectedLinks): {
+  [location: string]: BrokenLink[];
+} {
+  const brokenLinksByLocation: {[location: string]: BrokenLink[]} = {};
+
+  Object.entries(allCollectedCorrectLinks).forEach(([key, value]) => {
+    const brokenLinks = value.links.flatMap((link) => {
+      const [route, anchor] = link.split('#');
+      if (route !== '' && anchor !== undefined) {
+        const targetRoute = allCollectedCorrectLinks[route!];
+        if (targetRoute && !targetRoute.anchors.includes(anchor)) {
+          return [
+            {
+              link: `${route}#${anchor}`,
+              resolvedLink: route!,
+              anchor: true,
+            },
+          ];
+        }
+      }
+      return [];
+    });
+
+    if (brokenLinks.length > 0) {
+      brokenLinksByLocation[key] = brokenLinks;
+    }
+  });
+
+  return brokenLinksByLocation;
+}
+
 function getPageBrokenLinks({
   pagePath,
   pageLinks,
@@ -56,18 +91,14 @@ function getPageBrokenLinks({
   }
 
   function isAnchorBrokenLink(link: string) {
-    const urlHash = link.split('#')[1];
+    const [urlPath, urlHash] = link.split('#');
 
-    if (urlHash === undefined || pageAnchors.length === 0) {
+    // ignore anchors that are not on the current page
+    if (urlHash === undefined || pageAnchors.length === 0 || urlPath !== '') {
       return false;
     }
 
-    const brokenAnchors = pageAnchors.flatMap((anchor) => {
-      if (anchor === urlHash) {
-        return [];
-      }
-      return [anchor];
-    });
+    const brokenAnchors = pageAnchors.filter((anchor) => anchor !== urlHash);
 
     return brokenAnchors.length > 0;
   }
@@ -100,7 +131,7 @@ function getAllBrokenLinks({
   allCollectedLinks,
   routes,
 }: {
-  allCollectedLinks: {[location: string]: {links: string[]; anchors: string[]}};
+  allCollectedLinks: CollectedLinks;
   routes: RouteConfig[];
 }): {[location: string]: BrokenLink[]} {
   const filteredRoutes = filterIntermediateRoutes(routes);
@@ -116,7 +147,11 @@ function getAllBrokenLinks({
       }),
   );
 
-  return _.pickBy(allBrokenLinks, (brokenLinks) => brokenLinks.length > 0);
+  const allBrokenAnchors = checkAnchorsInOtherRoutes(allCollectedLinks);
+
+  const brokenCollection = _.merge(allBrokenLinks, allBrokenAnchors);
+
+  return _.pickBy(brokenCollection, (brokenLinks) => brokenLinks.length > 0);
 }
 
 function getBrokenLinksErrorMessage(allBrokenLinks: {
@@ -209,7 +244,7 @@ ${Object.entries(allBrokenLinks)
 }
 
 export async function handleBrokenLinks(params: {
-  allCollectedLinks: {[location: string]: {links: string[]; anchors: string[]}};
+  allCollectedLinks: CollectedLinks;
   onBrokenLinks: ReportingSeverity;
   onBrokenAnchors: ReportingSeverity;
   routes: RouteConfig[];
@@ -227,17 +262,14 @@ async function handlePathBrokenLinks({
   baseUrl,
   outDir,
 }: {
-  allCollectedLinks: {[location: string]: {links: string[]; anchors: string[]}};
+  allCollectedLinks: CollectedLinks;
   onBrokenLinks: ReportingSeverity;
   onBrokenAnchors: ReportingSeverity;
   routes: RouteConfig[];
   baseUrl: string;
   outDir: string;
 }): Promise<void> {
-  if (onBrokenLinks === 'ignore') {
-    return;
-  }
-  if (onBrokenAnchors === 'ignore') {
+  if (onBrokenLinks === 'ignore' || onBrokenAnchors === 'ignore') {
     return;
   }