fix: use base path for relative path resolution in TOC generation (#74)

iamchanii · okineadev · commit ed5cc48e1c2d · 2025-09-11T10:03:28.000+02:00
With base: '/docs/', TOC items failed to match sidebar entries. For example, sidebar data could not be retrieved at all. (See commit 47410cf) With this fix, TOC items are now correctly resolved against sidebar entries even when base is set. A test case has been added to cover this scenario. ::: changelog Previously, the plugin was hardcoding a `/` prefix without considering the `base` configuration option, which caused incorrect path matching when VitePress sites are deployed with a base path (e.g., `/docs/`). :::
diff --git a/src/generator/toc.ts b/src/generator/toc.ts
@@ -118,7 +118,8 @@ async function processSidebarSection(
 							(item.base ?? section.base ?? base ?? '') + item.link,
 						)
 						const matchingFile = preparedFiles.find((file) => {
-							const relativePath = `/${transformToPosixPath(stripExtPosix(file.path))}`
+							const basePrefix = base.endsWith('/') ? base : `${base}/`
+							const relativePath = `${basePrefix}${transformToPosixPath(stripExtPosix(file.path))}`
 							return isPathMatch(relativePath, normalizedItemLink)
 						})
 
diff --git a/tests/generator/__snapshots__/toc.test.ts.snap b/tests/generator/__snapshots__/toc.test.ts.snap
@@ -63,6 +63,15 @@ exports[`generateTOC resolves paths with common prefixes correctly 1`] = `
 "
 `;
 
+exports[`generateTOC resolves paths with base options 1`] = `
+"### Blog Started
+
+- [First version](/docs/blog/v1.md): Blazing fast frontend tool
+- [New features!](/docs/blog/v1.1.md): Instructions on how to get started with the tool
+
+"
+`;
+
 exports[`generateTOC with directoryFilter should include all files when directoryFilter is "." (root) 1`] = `
 "- [Some cool tool](/index.md): Blazing fast frontend tool
 - [Getting started](/test/getting-started.md): Instructions on how to get started with the tool
diff --git a/tests/generator/toc.test.ts b/tests/generator/toc.test.ts
@@ -167,6 +167,16 @@ describe('generateTOC', () => {
 
 		expect(toc).toMatchSnapshot()
 	})
+
+	it('resolves paths with base options', async () => {
+		const toc = await generateTOC(preparedFilesWithCommonPrefixSample, {
+			outDir,
+			base: '/docs',
+			sidebarConfig: sampleObjectVitePressSidebarWithCommonPrefix,
+		})
+
+		expect(toc).toMatchSnapshot()
+	})
 })
 
 describe('generateTOCLink', () => {

Original file line number	Diff line number	Diff line change
`@@ -118,7 +118,8 @@ async function processSidebarSection(`
`118`	`118`	`(item.base ?? section.base ?? base ?? '') + item.link,`
`119`	`119`	`)`
`120`	`120`	`const matchingFile = preparedFiles.find((file) => {`
`121`		- const relativePath = `/${transformToPosixPath(stripExtPosix(file.path))}`
	`121`	+ const basePrefix = base.endsWith('/') ? base : `${base}/`
	`122`	+ const relativePath = `${basePrefix}${transformToPosixPath(stripExtPosix(file.path))}`
`122`	`123`	`return isPathMatch(relativePath, normalizedItemLink)`
`123`	`124`	`})`
`124`	`125`