fix(vitepress): fix sidebar links when "out" and "docsRoot" are the same value (#695)

Author: tgreyuk

.changeset/fluffy-spies-shop.md

@@ -0,0 +1,5 @@
+---
+'typedoc-vitepress-theme': patch
+---
+
+- Fix sidebar links when "out" and "docsRoot" are the same value (#695)

devtools/examples/vitepress/typedoc.json

@@ -1,7 +1,6 @@
 {
-  "extends": [
-    "../../../packages/typedoc-plugin-markdown/test/fixtures/typedoc.cjs"
-  ],
+  "extends": ["../../packages/fixtures/typedoc.cjs"],
+  "tsconfig": "../../../packages/typedoc-plugin-markdown/test/fixtures/tsconfig.json",
   "entryPoints": [
     "../../../packages/typedoc-plugin-markdown/test/fixtures/src/groups/**/*.ts"
   ],

packages/typedoc-vitepress-theme/src/sidebars/sidebar.vitepress.ts

@@ -15,10 +15,21 @@ function getNavigationItem(
 ) {
   const hasChildren = navigationItem?.children?.length;
 
+  const linkParts: string[] = [];
+
+  if (navigationItem?.path) {
+    if (basePath.length) {
+      linkParts.push(basePath);
+    }
+    linkParts.push(
+      getParsedUrl(navigationItem.path as string).replace(/\\/g, '/'),
+    );
+  }
+
   return {
     text: navigationItem.title,
-    ...(Boolean(navigationItem?.path) && {
-      link: `/${basePath}/${getParsedUrl(navigationItem.path as string).replace(/\\/g, '/')}`,
+    ...(linkParts.length && {
+      link: `/${linkParts.join('/')}`,
     }),
     ...(hasChildren && { collapsed: options.collapsed }),
     ...(hasChildren && {

packages/typedoc-vitepress-theme/test/__scripts__/prepare.ts

@@ -12,6 +12,7 @@ fs.removeSync(`./test/out`);
 const fixtures = [
   { options: 'typedoc.base.json', outDir: 'default' },
   { options: 'typedoc.sidebar-options.json', outDir: 'sidebar-options' },
+  { options: 'typedoc.sidebar-options-2.json', outDir: 'sidebar-options-2' },
 ];
 
 // write fixtures

packages/typedoc-vitepress-theme/test/specs/__snapshots__/vitepress.spec.ts.snap

@@ -2,6 +2,8 @@
 
 exports[`VitePress should generate typedoc sidebar 1`] = `"[{"text":"module-1","link":"/test/out/default/module-1/","collapsed":true,"items":[{"text":"Classes","collapsed":true,"items":[{"text":"ClassA","link":"/test/out/default/module-1/classes/ClassA.md"},{"text":"ClassB","link":"/test/out/default/module-1/classes/ClassB.md"}]},{"text":"Interfaces","collapsed":true,"items":[{"text":"InterfaceA","link":"/test/out/default/module-1/interfaces/InterfaceA.md"},{"text":"InterfaceB","link":"/test/out/default/module-1/interfaces/InterfaceB.md"}]}]},{"text":"module-2","link":"/test/out/default/module-2/","collapsed":true,"items":[{"text":"Classes","collapsed":true,"items":[{"text":"ClassA","link":"/test/out/default/module-2/classes/ClassA.md"},{"text":"ClassB","link":"/test/out/default/module-2/classes/ClassB.md"}]},{"text":"Interfaces","collapsed":true,"items":[{"text":"InterfaceA","link":"/test/out/default/module-2/interfaces/InterfaceA.md"},{"text":"InterfaceB","link":"/test/out/default/module-2/interfaces/InterfaceB.md"}]}]}]"`;
 
+exports[`VitePress should generate typedoc sidebar with duplicate out and docsRoots 1`] = `"[{"text":"module-1","link":"/module-1/","collapsed":true,"items":[{"text":"Classes","collapsed":true,"items":[{"text":"ClassA","link":"/module-1/classes/ClassA.md"},{"text":"ClassB","link":"/module-1/classes/ClassB.md"}]},{"text":"Interfaces","collapsed":true,"items":[{"text":"InterfaceA","link":"/module-1/interfaces/InterfaceA.md"},{"text":"InterfaceB","link":"/module-1/interfaces/InterfaceB.md"}]}]},{"text":"module-2","link":"/module-2/","collapsed":true,"items":[{"text":"Classes","collapsed":true,"items":[{"text":"ClassA","link":"/module-2/classes/ClassA.md"},{"text":"ClassB","link":"/module-2/classes/ClassB.md"}]},{"text":"Interfaces","collapsed":true,"items":[{"text":"InterfaceA","link":"/module-2/interfaces/InterfaceA.md"},{"text":"InterfaceB","link":"/module-2/interfaces/InterfaceB.md"}]}]}]"`;
+
 exports[`VitePress should generate typedoc sidebar with options 1`] = `
 "[
   {

packages/typedoc-vitepress-theme/test/specs/vitepress.spec.ts

@@ -35,4 +35,13 @@ describe(`VitePress`, () => {
       .toString();
     expect(contents).toMatchSnapshot();
   });
+
+  test(`should generate typedoc sidebar with duplicate out and docsRoots`, async () => {
+    const contents = fs
+      .readFileSync(
+        path.join(__dirname, '../out/sidebar-options-2/typedoc-sidebar.json'),
+      )
+      .toString();
+    expect(contents).toMatchSnapshot();
+  });
 });

packages/typedoc-vitepress-theme/test/typedoc.base.json

@@ -1,7 +1,6 @@
 {
   "entryPoints": ["./stubs/*.ts"],
   "tsconfig": "./stubs/tsconfig.json",
-  "out": "./out",
   "plugin": ["typedoc-plugin-markdown", "typedoc-vitepress-theme"],
   "readme": "none",
   "disableSources": true,

packages/typedoc-vitepress-theme/test/typedoc.sidebar-options-2.json

@@ -0,0 +1,4 @@
+{
+  "extends": "./typedoc.base.json",
+  "docsRoot": "./out/sidebar-options-2"
+}