3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-08-06 10:20:09 +02:00
Code Issues Projects Releases Packages Wiki Activity

chore(plugin-docs): remove legacy versioned prefix on doc ids and sidebar names in versioned sidebars (#9310)

Browse source
This commit is contained in:
Sébastien Lorber 2023-09-15 18:52:42 +02:00 • committed by GitHub
parent f5ae537d3e
commit 598b32011f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
25 changed files with 264 additions and 396 deletions
Download patch file Download diff file Expand all files Collapse all files

36
packages/docusaurus-plugin-content-docs/src/sidebars/__tests__/generator.test.ts
View file

@ -67,7 +67,6 @@ describe('DefaultSidebarItemsGenerator', () => {
sidebar_custom_props: {custom: 'prop'},
},
title: '',
unversionedId: 'doc1',
},
{
id: 'doc2',
@ -76,7 +75,6 @@ describe('DefaultSidebarItemsGenerator', () => {
sidebarPosition: 3,
frontMatter: {},
title: '',
unversionedId: 'doc2',
},
{
id: 'doc3',
@ -85,7 +83,6 @@ describe('DefaultSidebarItemsGenerator', () => {
sidebarPosition: 1,
frontMatter: {},
title: '',
unversionedId: 'doc3',
},
{
id: 'doc4',
@ -94,7 +91,6 @@ describe('DefaultSidebarItemsGenerator', () => {
sidebarPosition: 1.5,
frontMatter: {},
title: '',
unversionedId: 'doc4',
},
{
id: 'doc5',
@ -103,7 +99,6 @@ describe('DefaultSidebarItemsGenerator', () => {
sidebarPosition: undefined,
frontMatter: {},
title: '',
unversionedId: 'doc5',
},
],
isCategoryIndex: () => false,
@ -150,7 +145,6 @@ describe('DefaultSidebarItemsGenerator', () => {
sidebarPosition: 0,
frontMatter: {},
title: '',
unversionedId: 'intro',
},
{
id: 'tutorials-index',
@ -159,7 +153,6 @@ describe('DefaultSidebarItemsGenerator', () => {
sidebarPosition: 2,
frontMatter: {},
title: 'Tutorials',
unversionedId: 'tutorials-index',
},
{
id: 'tutorial2',
@ -168,7 +161,6 @@ describe('DefaultSidebarItemsGenerator', () => {
sidebarPosition: 2,
frontMatter: {},
title: '',
unversionedId: 'tutorial2',
},
{
id: 'tutorial1',
@ -177,7 +169,6 @@ describe('DefaultSidebarItemsGenerator', () => {
sidebarPosition: 1,
frontMatter: {},
title: '',
unversionedId: 'tutorial1',
},
{
id: 'guides-index',
@ -185,7 +176,6 @@ describe('DefaultSidebarItemsGenerator', () => {
sourceDirName: '02-Guides',
frontMatter: {},
title: 'Guides',
unversionedId: 'guides-index',
},
{
id: 'guide2',
@ -194,7 +184,6 @@ describe('DefaultSidebarItemsGenerator', () => {
sidebarPosition: 2,
frontMatter: {},
title: '',
unversionedId: 'guide2',
},
{
id: 'guide1',
@ -205,7 +194,6 @@ describe('DefaultSidebarItemsGenerator', () => {
sidebar_class_name: 'foo',
},
title: '',
unversionedId: 'guide1',
},
{
id: 'nested-guide',
@ -214,7 +202,6 @@ describe('DefaultSidebarItemsGenerator', () => {
sidebarPosition: undefined,
frontMatter: {},
title: '',
unversionedId: 'nested-guide',
},
{
id: 'end',
@ -223,7 +210,6 @@ describe('DefaultSidebarItemsGenerator', () => {
sidebarPosition: 3,
frontMatter: {},
title: '',
unversionedId: 'end',
},
],
});
@ -268,7 +254,6 @@ describe('DefaultSidebarItemsGenerator', () => {
title: 'Subsubsubfolder category label',
sidebarPosition: undefined,
frontMatter: {},
unversionedId: 'doc1',
},
{
id: 'doc2',
@ -277,7 +262,6 @@ describe('DefaultSidebarItemsGenerator', () => {
sidebarPosition: undefined,
frontMatter: {},
title: '',
unversionedId: 'doc2',
},
{
id: 'doc3',
@ -286,7 +270,6 @@ describe('DefaultSidebarItemsGenerator', () => {
sidebarPosition: undefined,
frontMatter: {},
title: '',
unversionedId: 'doc2',
},
{
id: 'doc4',
@ -295,7 +278,6 @@ describe('DefaultSidebarItemsGenerator', () => {
sidebarPosition: undefined,
frontMatter: {},
title: '',
unversionedId: 'doc4',
},
{
id: 'doc5',
@ -304,7 +286,6 @@ describe('DefaultSidebarItemsGenerator', () => {
sidebarPosition: undefined,
frontMatter: {},
title: '',
unversionedId: 'doc5',
},
{
id: 'doc6',
@ -313,7 +294,6 @@ describe('DefaultSidebarItemsGenerator', () => {
sidebarPosition: undefined,
frontMatter: {},
title: '',
unversionedId: 'doc6',
},
{
id: 'doc7',
@ -322,7 +302,6 @@ describe('DefaultSidebarItemsGenerator', () => {
sidebarPosition: 2,
frontMatter: {},
title: '',
unversionedId: 'doc7',
},
{
id: 'doc8',
@ -331,7 +310,6 @@ describe('DefaultSidebarItemsGenerator', () => {
sidebarPosition: 1,
frontMatter: {},
title: '',
unversionedId: 'doc8',
},
],
});
@ -370,7 +348,6 @@ describe('DefaultSidebarItemsGenerator', () => {
sourceDirName: 'Category',
frontMatter: {},
title: '',
unversionedId: 'parent/doc1',
},
{
id: 'parent/doc2',
@ -378,7 +355,6 @@ describe('DefaultSidebarItemsGenerator', () => {
sourceDirName: 'Category',
frontMatter: {},
title: '',
unversionedId: 'parent/doc2',
},
{
id: 'parent/doc3',
@ -386,7 +362,6 @@ describe('DefaultSidebarItemsGenerator', () => {
sourceDirName: 'Category',
frontMatter: {},
title: '',
unversionedId: 'parent/doc3',
},
{
id: 'parent/doc4',
@ -394,7 +369,6 @@ describe('DefaultSidebarItemsGenerator', () => {
sourceDirName: 'Category2',
frontMatter: {},
title: '',
unversionedId: 'parent/doc4',
},
{
id: 'parent/doc5',
@ -402,7 +376,6 @@ describe('DefaultSidebarItemsGenerator', () => {
sourceDirName: 'Category2',
frontMatter: {},
title: '',
unversionedId: 'parent/doc5',
},
{
id: 'parent/doc6',
@ -410,7 +383,6 @@ describe('DefaultSidebarItemsGenerator', () => {
sourceDirName: 'Category2',
frontMatter: {},
title: '',
unversionedId: 'parent/doc6',
},
],
isCategoryIndex: () => false,
@ -449,7 +421,6 @@ describe('DefaultSidebarItemsGenerator', () => {
sidebarPosition: 0,
frontMatter: {},
title: '',
unversionedId: 'intro',
},
{
id: 'tutorials-index',
@ -458,7 +429,6 @@ describe('DefaultSidebarItemsGenerator', () => {
sidebarPosition: 2,
frontMatter: {},
title: 'Tutorials',
unversionedId: 'tutorials-index',
},
{
id: 'tutorial2',
@ -467,7 +437,6 @@ describe('DefaultSidebarItemsGenerator', () => {
sidebarPosition: 2,
frontMatter: {},
title: '',
unversionedId: 'tutorial2',
},
{
id: 'tutorial1',
@ -476,7 +445,6 @@ describe('DefaultSidebarItemsGenerator', () => {
sidebarPosition: 1,
frontMatter: {},
title: '',
unversionedId: 'tutorial1',
},
{
id: 'not-guides-index',
@ -484,7 +452,6 @@ describe('DefaultSidebarItemsGenerator', () => {
sourceDirName: '02-Guides',
frontMatter: {},
title: 'Guides',
unversionedId: 'not-guides-index',
},
{
id: 'guide2',
@ -493,7 +460,6 @@ describe('DefaultSidebarItemsGenerator', () => {
sidebarPosition: 2,
frontMatter: {},
title: 'guide2',
unversionedId: 'guide2',
},
{
id: 'guide1',
@ -504,7 +470,6 @@ describe('DefaultSidebarItemsGenerator', () => {
sidebar_class_name: 'foo',
},
title: '',
unversionedId: 'guide1',
},
],
});
@ -536,7 +501,6 @@ describe('DefaultSidebarItemsGenerator', () => {
docs: [
{
id: 'intro',
unversionedId: 'intro',
source: '@site/docs/category/intro.md',
sourceDirName: 'category',
frontMatter: {},

2
packages/docusaurus-plugin-content-docs/src/sidebars/__tests__/postProcessor.test.ts
View file

@ -155,7 +155,7 @@ describe('postProcess', () => {
{
sidebarOptions: {sidebarCollapsed: true, sidebarCollapsible: true},
version: {path: 'version'},
drafts: [{id: 'foo', unversionedId: 'foo'}],
drafts: [{id: 'foo'}],
} as unknown as SidebarPostProcessorParams,
),
).toMatchSnapshot();

30
packages/docusaurus-plugin-content-docs/src/sidebars/__tests__/utils.test.ts
View file

@ -155,8 +155,7 @@ describe('createSidebarsUtils', () => {
it('getDocNavigation', () => {
expect(
getDocNavigation({
unversionedId: 'doc1',
versionedId: 'doc1',
docId: 'doc1',
displayedSidebar: undefined,
unlistedIds: new Set(),
}),
@ -170,8 +169,7 @@ describe('createSidebarsUtils', () => {
});
expect(
getDocNavigation({
unversionedId: 'doc2',
versionedId: 'doc2',
docId: 'doc2',
displayedSidebar: undefined,
unlistedIds: new Set(),
}),
@ -186,8 +184,7 @@ describe('createSidebarsUtils', () => {
expect(
getDocNavigation({
unversionedId: 'doc3',
versionedId: 'doc3',
docId: 'doc3',
displayedSidebar: undefined,
unlistedIds: new Set(),
}),
@ -201,8 +198,7 @@ describe('createSidebarsUtils', () => {
});
expect(
getDocNavigation({
unversionedId: 'doc4',
versionedId: 'doc4',
docId: 'doc4',
displayedSidebar: undefined,
unlistedIds: new Set(),
}),
@ -218,8 +214,7 @@ describe('createSidebarsUtils', () => {
expect(
getDocNavigation({
unversionedId: 'doc5',
versionedId: 'doc5',
docId: 'doc5',
displayedSidebar: undefined,
unlistedIds: new Set(),
}),
@ -233,8 +228,7 @@ describe('createSidebarsUtils', () => {
});
expect(
getDocNavigation({
unversionedId: 'doc6',
versionedId: 'doc6',
docId: 'doc6',
displayedSidebar: undefined,
unlistedIds: new Set(),
}),
@ -251,8 +245,7 @@ describe('createSidebarsUtils', () => {
});
expect(
getDocNavigation({
unversionedId: 'doc7',
versionedId: 'doc7',
docId: 'doc7',
displayedSidebar: undefined,
unlistedIds: new Set(),
}),
@ -266,8 +259,7 @@ describe('createSidebarsUtils', () => {
});
expect(
getDocNavigation({
unversionedId: 'doc3',
versionedId: 'doc3',
docId: 'doc3',
displayedSidebar: null,
unlistedIds: new Set(),
}),
@ -278,8 +270,7 @@ describe('createSidebarsUtils', () => {
});
expect(() =>
getDocNavigation({
unversionedId: 'doc3',
versionedId: 'doc3',
docId: 'doc3',
displayedSidebar: 'foo',
unlistedIds: new Set(),
}),
@ -288,8 +279,7 @@ describe('createSidebarsUtils', () => {
);
expect(
getDocNavigation({
unversionedId: 'doc3',
versionedId: 'doc3',
docId: 'doc3',
displayedSidebar: 'sidebar1',
unlistedIds: new Set(),
}),