Merge pull request #41 from HiDeoo/hd-fix-packages-entrypoint-strateg…

…y-broken-links
HiDeoo · Apr 18, 2024 · 356b61e · 356b61e
2 parents f03aaf9 + 2fb04e3
commit 356b61e
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 2 deletions.
diff --git a/fixtures/packages/packages/bar/src/functions.ts b/fixtures/packages/packages/bar/src/functions.ts
@@ -4,3 +4,20 @@
 export function doBar() {
   return 'doBar'
 }
+
+/**
+ * A function that does another bar thing but better.
+ *
+ * This is a better alternative to {@link doBar}.
+ */
+export function doBarBetter(options: DoBarBetterOptions) {
+  return options.name
+}
+
+/**
+ * Options for {@link doBarBetter}
+ */
+export interface DoBarBetterOptions {
+  name: string
+  number: number
+}
diff --git a/packages/starlight-typedoc/libs/starlight.ts b/packages/starlight-typedoc/libs/starlight.ts
@@ -206,7 +206,8 @@ export function getRelativeURL(url: string, baseUrl: string, pageUrl?: string):
 
   const currentDirname = path.dirname(pageUrl ?? '')
   const urlDirname = path.dirname(url)
-  const relativeUrl = currentDirname === urlDirname ? url : path.posix.relative(currentDirname, url)
+  const relativeUrl =
+    currentDirname === urlDirname ? url : path.posix.join(currentDirname, path.posix.relative(currentDirname, url))
 
   const filePath = path.parse(relativeUrl)
   const [, anchor] = filePath.base.split('#')

diff --git a/packages/starlight-typedoc/tests/e2e/packages/content.test.ts b/packages/starlight-typedoc/tests/e2e/packages/content.test.ts
@@ -1,5 +1,14 @@
 import { test } from '../test'
 
+test('should properly format links', async ({ docPage }) => {
+  docPage.usePackagesEntryPoints()
+
+  await docPage.goto('bar/functions/dobarbetter')
+
+  await docPage.content.getByRole('link', { exact: true, name: 'DoBarBetterOptions' }).click()
+  await docPage.page.waitForURL('**/api-packages-entrypoints/bar/interfaces/dobarbetteroptions/**')
+})
+
 test('should properly format links in block tag comments', async ({ docPage }) => {
   docPage.usePackagesEntryPoints()
 

diff --git a/packages/starlight-typedoc/tests/e2e/packages/sidebar.test.ts b/packages/starlight-typedoc/tests/e2e/packages/sidebar.test.ts
@@ -21,9 +21,13 @@ test('should generate the proper items for for multiple entry points', async ({
     {
       label: 'bar',
       items: [
+        {
+          label: 'Interfaces',
+          items: [{ name: 'DoBarBetterOptions' }],
+        },
         {
           label: 'Functions',
-          items: [{ name: 'doBar' }],
+          items: [{ name: 'doBar' }, { name: 'doBarBetter' }],
         },
       ],
       collapsed: true,