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

feat: sub-categories in sidebar.json (#892)

Browse source 
* Add ability to specify sub categories in sidebar.json

* move v1 files to correct place

* refactor implementation

* refactor naming for implementation clarity
This commit is contained in:
Will Brock 2018-10-08 04:09:29 -04:00 • committed by Endilie Yacop Sucipto
parent d052feec40
commit 954456088c
14 changed files with 535 additions and 88 deletions
Download patch file Download diff file Expand all files Collapse all files

59
v1/lib/server/__tests__/utils.test.js
View file

@ -88,4 +88,63 @@ describe('server utils', () => {
expect(utils.getSubDir(docE, docsDir)).toBeNull();
expect(utils.getSubDir(docE, translatedDir)).toEqual('lol/lah');
});
describe('validateSidebar', () => {
test('should throw an error for invalid sidebarMetadatas', () => {
const metadata = {
id: 'doc1',
sidebar: 'docs',
next_id: 'doc2',
next: 'doc2',
};
const sidebarMetadatas = {
doc1: {},
};
expect(() => {
utils.validateSidebar(metadata, sidebarMetadatas);
}).toThrow(
`Improper sidebars.json file, document with id 'doc2' not found. Make sure that documents with the ids specified in sidebars.json exist and that no ids are repeated.`,
);
});
test('should throw an error for invalid version sidebarMetadatas', () => {
const metadata = {
id: 'doc1',
version: 'foo',
sidebar: 'docs',
next_id: 'doc2',
next: 'doc2',
};
const sidebarMetadatas = {
doc1: {},
};
expect(() => {
utils.validateSidebar(metadata, sidebarMetadatas);
}).toThrow(
`Improper sidebars file for version foo, document with id 'doc2' not found. Make sure that all documents with ids specified in this version's sidebar file exist and that no ids are repeated.`,
);
});
test('should pass validate', () => {
const metadata = {
id: 'doc1',
sidebar: 'docs',
next_id: 'doc2',
next: 'doc2',
};
const sidebarMetadatas = {
doc1: {},
doc2: {},
};
expect(() => {
utils.validateSidebar(metadata, sidebarMetadatas);
}).not.toThrow();
});
});
});