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

test: fix some type errors in test files (#7486)

Browse source
This commit is contained in:
Joshua Chen 2022-05-25 11:46:10 +08:00 • committed by GitHub
parent 624735bd92
commit e2e40b8f5f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
50 changed files with 319 additions and 182 deletions
Download patch file Download diff file Expand all files Collapse all files

34
packages/docusaurus-theme-common/src/utils/__tests__/docsUtils.test.tsx
View file

@ -26,6 +26,7 @@ import type {
PropSidebarItemLink,
PropVersionMetadata,
} from '@docusaurus/plugin-content-docs';
import type {DocusaurusContext} from '@docusaurus/types';
// Make tests more readable with some useful category item defaults
function testCategory(
@ -294,19 +295,22 @@ describe('isActiveSidebarItem', () => {
describe('useSidebarBreadcrumbs', () => {
const createUseSidebarBreadcrumbsMock =
(sidebar: PropSidebar, breadcrumbsOption?: boolean) => (location: string) =>
(sidebar: PropSidebar | undefined, breadcrumbsOption?: boolean) =>
(location: string) =>
renderHook(() => useSidebarBreadcrumbs(), {
wrapper: ({children}) => (
<StaticRouter location={location}>
<Context.Provider
// eslint-disable-next-line react/jsx-no-constructed-context-values
value={{
globalData: {
'docusaurus-plugin-content-docs': {
default: {path: '/', breadcrumbs: breadcrumbsOption},
value={
// eslint-disable-next-line react/jsx-no-constructed-context-values
{
globalData: {
'docusaurus-plugin-content-docs': {
default: {path: '/', breadcrumbs: breadcrumbsOption},
},
},
},
}}>
} as unknown as DocusaurusContext
}>
<DocsSidebarProvider name="sidebarName" items={sidebar}>
{children}
</DocsSidebarProvider>
@ -421,7 +425,9 @@ describe('useSidebarBreadcrumbs', () => {
});
it('returns null when there is no sidebar', () => {
expect(createUseSidebarBreadcrumbsMock(null, false)('/foo')).toBeNull();
expect(
createUseSidebarBreadcrumbsMock(undefined, false)('/foo'),
).toBeNull();
});
});
@ -436,9 +442,12 @@ describe('useCurrentSidebarCategory', () => {
),
}).result.current;
it('works', () => {
const category = {
const category: PropSidebarItemCategory = {
type: 'category',
label: 'Category',
href: '/cat',
collapsible: true,
collapsed: false,
items: [
{type: 'link', href: '/cat/foo', label: 'Foo'},
{type: 'link', href: '/cat/bar', label: 'Bar'},
@ -453,8 +462,11 @@ describe('useCurrentSidebarCategory', () => {
});
it('throws for non-category index page', () => {
const category = {
const category: PropSidebarItemCategory = {
type: 'category',
label: 'Category',
collapsible: true,
collapsed: false,
items: [
{type: 'link', href: '/cat/foo', label: 'Foo'},
{type: 'link', href: '/cat/bar', label: 'Bar'},