15308555518/ docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-12-25 17:22:50 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

simplify and remove useless comments

This commit is contained in:
sebastien 2025-12-22 15:58:38 +01:00
parent 3d28a9e798
commit 5492cabab9
2 changed files with 47 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
packages/docusaurus-plugin-content-docs/src/client/__tests__/docsUtils.test.tsx
View File

@ -657,6 +657,35 @@ describe('useSidebarBreadcrumbs', () => {
createUseSidebarBreadcrumbsMock(undefined, false)('/foo'),
).toBeNull();
});
// Regression test for https://github.com/facebook/docusaurus/issues/11612
it('returns the category that owns the URL, not a category with a link pointing to it', () => {
const categoryA: PropSidebarItemCategory = testCategory({
label: 'Category A',
href: '/category-a',
items: [
testLink({href: '/category-a/doc1', label: 'Doc 1'}),
testLink({href: '/category-a/doc2', label: 'Doc 2'}),
// This link points to Category B's generated-index
testLink({href: '/category-b', label: 'Go to Category B'}),
],
});
const categoryB: PropSidebarItemCategory = testCategory({
label: 'Category B',
href: '/category-b',
items: [
testLink({href: '/category-b/item1', label: 'Item 1'}),
testLink({href: '/category-b/item2', label: 'Item 2'}),
],
});
const sidebar: PropSidebar = [categoryA, categoryB];
expect(createUseSidebarBreadcrumbsMock(sidebar)('/category-b')).toEqual([
categoryB,
]);
});
});
describe('useCurrentSidebarCategory', () => {
@ -782,21 +811,7 @@ describe('useCurrentSidebarCategory', () => {
});
// Regression test for https://github.com/facebook/docusaurus/issues/11612
// When a link in Category A points to a generated-index URL owned by
// Category B, useCurrentSidebarCategory should return Category B (the owner),
// not Category A (which merely has a link pointing to it).
it('returns the category that owns the URL, not a category with a link pointing to it', () => {
// Category B is the actual owner of /category-b (its generated-index href)
const categoryB: PropSidebarItemCategory = testCategory({
label: 'Category B',
href: '/category-b',
items: [
testLink({href: '/category-b/item1', label: 'Item 1'}),
testLink({href: '/category-b/item2', label: 'Item 2'}),
],
});
// Category A contains a link that points to Category B's URL
const categoryA: PropSidebarItemCategory = testCategory({
label: 'Category A',
href: '/category-a',
@ -808,6 +823,15 @@ describe('useCurrentSidebarCategory', () => {
],
});
const categoryB: PropSidebarItemCategory = testCategory({
label: 'Category B',
href: '/category-b',
items: [
testLink({href: '/category-b/item1', label: 'Item 1'}),
testLink({href: '/category-b/item2', label: 'Item 2'}),
],
});
const sidebar: PropSidebar = [categoryA, categoryB];
const mockUseCurrentSidebarCategory =

36
packages/docusaurus-plugin-content-docs/src/client/docsUtils.tsx
View File

@ -234,27 +234,14 @@ function getSidebarBreadcrumbs({
}): PropSidebarBreadcrumbsItem[] {
const breadcrumbs: PropSidebarBreadcrumbsItem[] = [];
// When onlyCategories is true (e.g., for useCurrentSidebarCategory), we need
// to distinguish between:
// 1. A category that directly owns this URL (category.href === pathname)
// 2. A link that happens to point to this URL
//
// We should prefer (1) over (2) to fix the bug where a generated-index page
// shows items from the wrong category when another category has a link
// pointing to it. See https://github.com/facebook/docusaurus/issues/11612
//
// We use a two-pass approach:
// - First pass: Only look for categories that directly own the URL
// - Second pass: If not found, look for links (to support doc pages)
function extractCategoryOnly(items: PropSidebarItem[]): boolean {
function extractCategory(items: PropSidebarItem[]): boolean {
for (const item of items) {
if (item.type === 'category') {
if (isSamePath(item.href, pathname)) {
breadcrumbs.unshift(item);
return true;
}
if (extractCategoryOnly(item.items)) {
if (extractCategory(item.items)) {
breadcrumbs.unshift(item);
return true;
}
@ -263,11 +250,11 @@ function getSidebarBreadcrumbs({
return false;
}
function extractWithLinks(items: PropSidebarItem[]): boolean {
function extract(items: PropSidebarItem[]): boolean {
for (const item of items) {
if (
(item.type === 'category' &&
(isSamePath(item.href, pathname) || extractWithLinks(item.items))) ||
(isSamePath(item.href, pathname) || extract(item.items))) ||
(item.type === 'link' && isSamePath(item.href, pathname))
) {
const filtered = onlyCategories && item.type !== 'category';
@ -280,16 +267,11 @@ function getSidebarBreadcrumbs({
return false;
}
if (onlyCategories) {
// First try to find a category that directly owns this URL
if (!extractCategoryOnly(sidebarItems)) {
// Fall back to finding via links (for doc pages in a category)
extractWithLinks(sidebarItems);
}
} else {
// For breadcrumbs, use the original behavior (links included)
extractWithLinks(sidebarItems);
}
// We use a two-pass approach:
// - First pass: Only look for categories that directly own the URL
// - Second pass: If not found, look for links (to support doc pages)
// See why here: https://github.com/facebook/docusaurus/issues/11612
extractCategory(sidebarItems) || extract(sidebarItems);
return breadcrumbs;
}