3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-05-10 23:57:22 +02:00
Code Issues Projects Releases Packages Wiki Activity

fix(v2): throw error if first level item of a sidebar is not category (#1994)

Browse source
This commit is contained in:
Endi 2019-11-14 23:36:15 +07:00 • committed by GitHub
parent 472a1a660c
commit 4e5a03fb88
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 30 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

13
packages/docusaurus-plugin-content-docs/src/__tests__/__fixtures__/sidebars/sidebars-first-level-not-category.js Normal file
View file

@ -0,0 +1,13 @@
module.exports = {
docs: [
{
type: 'category',
label: 'Getting Started',
items: ['greeting'],
},
{
type: 'doc',
id: 'api',
},
],
};

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

@ -34,6 +34,16 @@ describe('loadSidebars', () => {
);
});
test('sidebars with first level not a category', async () => {
const sidebarPath = path.join(
fixtureDir,
'sidebars-first-level-not-category',
);
expect(() => loadSidebars(sidebarPath)).toThrowErrorMatchingInlineSnapshot(
`"Error loading {\\"type\\":\\"doc\\",\\"id\\":\\"api\\"}. First level item of a sidebar must be a category"`,
);
});
test('sidebars with unknown sidebar item type', async () => {
const sidebarPath = path.join(fixtureDir, 'sidebars-unknown-type.json');
expect(() => loadSidebars(sidebarPath)).toThrowErrorMatchingInlineSnapshot(

7
packages/docusaurus-plugin-content-docs/src/sidebars.ts
View file

@ -39,6 +39,13 @@ function normalizeCategory(
category: SidebarItemCategoryRaw,
level = 0,
): SidebarItemCategory {
if (level === 0 && category.type !== 'category') {
throw new Error(
`Error loading ${JSON.stringify(
category,
)}. First level item of a sidebar must be a category`,
);
}
assertItem(category, ['items', 'label']);
if (!Array.isArray(category.items)) {