test: improve test coverage; multiple internal refactors (#6912)

packages/docusaurus-plugin-content-docs/src/markdown/__tests__/__fixtures__/outside/doc1.md

@@ -0,0 +1 @@
+[link](../docs/doc1.md)

packages/docusaurus-plugin-content-docs/src/markdown/__tests__/linkify.test.ts

@@ -193,4 +193,14 @@ describe('linkify', () => {
     expect(transformedContent).not.toContain('](../doc2.md)');
     expect(content).not.toEqual(transformedContent);
   });
+
+  // See comment in linkify.ts
+  it('throws for file outside version', async () => {
+    const doc1 = path.join(__dirname, '__fixtures__/outside/doc1.md');
+    await expect(() =>
+      transform(doc1),
+    ).rejects.toThrowErrorMatchingInlineSnapshot(
+      `"Unexpected error: Markdown file at \\"<PROJECT_ROOT>/packages/docusaurus-plugin-content-docs/src/markdown/__tests__/__fixtures__/outside/doc1.md\\" does not belong to any docs version!"`,
+    );
+  });
 });

packages/docusaurus-plugin-content-docs/src/markdown/linkify.ts

@@ -15,6 +15,10 @@ function getVersion(filePath: string, options: DocsMarkdownOption) {
       filePath.startsWith(docsDirPath),
     ),
   );
+  // At this point, this should never happen, because the MDX loaders' paths are
+  // literally using the version content paths; but if we allow sourcing content
+  // from outside the docs directory (through the `include` option, for example;
+  // is there a compelling use-case?), this would actually be testable
   if (!versionFound) {
     throw new Error(
       `Unexpected error: Markdown file at "${filePath}" does not belong to any docs version!`,

packages/docusaurus-plugin-content-docs/src/sidebars/postProcessor.ts

@@ -58,22 +58,17 @@ function postProcessSidebarItem(
           `Sidebar category ${item.label} has neither any subitem nor a link. This makes this item not able to link to anything.`,
         );
       }
-      switch (category.link.type) {
-        case 'doc':
-          return {
+      return category.link.type === 'doc'
+        ? {
             type: 'doc',
             label: category.label,
             id: category.link.id,
-          };
-        case 'generated-index':
-          return {
+          }
+        : {
             type: 'link',
             label: category.label,
             href: category.link.permalink,
           };
-        default:
-          throw new Error('Unexpected sidebar category link type');
-      }
     }
     // A non-collapsible category can't be collapsed!
     if (category.collapsible === false) {

packages/docusaurus-plugin-content-docs/src/sidebars/utils.ts

@@ -376,18 +376,13 @@ export function toNavigationLink(
     return undefined;
   }
 
-  if (navigationItem.type === 'doc') {
-    return toDocNavigationLink(getDocById(navigationItem.id));
-  } else if (navigationItem.type === 'category') {
-    if (navigationItem.link.type === 'doc') {
-      return toDocNavigationLink(getDocById(navigationItem.link.id));
-    } else if (navigationItem.link.type === 'generated-index') {
-      return {
-        title: navigationItem.label,
-        permalink: navigationItem.link.permalink,
-      };
-    }
-    throw new Error('unexpected category link type');
+  if (navigationItem.type === 'category') {
+    return navigationItem.link.type === 'doc'
+      ? toDocNavigationLink(getDocById(navigationItem.link.id))
+      : {
+          title: navigationItem.label,
+          permalink: navigationItem.link.permalink,
+        };
   }
-  throw new Error('unexpected navigation item');
+  return toDocNavigationLink(getDocById(navigationItem.id));
 }