@docusaurus/theme-common 2.0.0-beta.13 → 2.0.0-beta.15

package/src/utils/__tests__/docsUtils.test.tsx

@@ -1,331 +0,0 @@
-/**
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-
-import React from 'react';
-import {renderHook} from '@testing-library/react-hooks';
-import {
-  findFirstCategoryLink,
-  isActiveSidebarItem,
-  DocsVersionProvider,
-  useDocsVersion,
-  useDocById,
-  useDocsSidebar,
-  DocsSidebarProvider,
-  findSidebarCategory,
-} from '../docsUtils';
-import {
-  PropSidebar,
-  PropSidebarItem,
-  PropSidebarItemCategory,
-  PropVersionMetadata,
-} from '@docusaurus/plugin-content-docs';
-
-// Make tests more readable with some useful category item defaults
-function testCategory(
-  data?: Partial<PropSidebarItemCategory>,
-): PropSidebarItemCategory {
-  return {
-    type: 'category',
-    href: undefined,
-    label: 'Category label',
-    items: [],
-    collapsed: true,
-    collapsible: true,
-    ...data,
-  };
-}
-
-function testVersion(data?: Partial<PropVersionMetadata>): PropVersionMetadata {
-  return {
-    version: 'versionName',
-    label: 'Version Label',
-    className: 'version className',
-    badge: true,
-    banner: 'unreleased',
-    docs: {},
-    docsSidebars: {},
-    isLast: false,
-    pluginId: 'default',
-    ...data,
-  };
-}
-
-describe('docsUtils', () => {
-  describe('useDocsVersion', () => {
-    test('should throw if context provider is missing', () => {
-      expect(
-        () => renderHook(() => useDocsVersion()).result.current,
-      ).toThrowErrorMatchingInlineSnapshot(
-        `"This hook requires usage of <DocsVersionProvider>"`,
-      );
-    });
-
-    test('should read value from context provider', () => {
-      const version = testVersion();
-      const {result} = renderHook(() => useDocsVersion(), {
-        wrapper: ({children}) => (
-          <DocsVersionProvider version={version}>
-            {children}
-          </DocsVersionProvider>
-        ),
-      });
-      expect(result.current).toBe(version);
-    });
-  });
-
-  describe('useDocsSidebar', () => {
-    test('should throw if context provider is missing', () => {
-      expect(
-        () => renderHook(() => useDocsSidebar()).result.current,
-      ).toThrowErrorMatchingInlineSnapshot(
-        `"This hook requires usage of <DocsSidebarProvider>"`,
-      );
-    });
-
-    test('should read value from context provider', () => {
-      const sidebar: PropSidebar = [];
-      const {result} = renderHook(() => useDocsSidebar(), {
-        wrapper: ({children}) => (
-          <DocsSidebarProvider sidebar={sidebar}>
-            {children}
-          </DocsSidebarProvider>
-        ),
-      });
-      expect(result.current).toBe(sidebar);
-    });
-  });
-
-  describe('useDocById', () => {
-    const version = testVersion({
-      docs: {
-        doc1: {
-          id: 'doc1',
-          title: 'Doc 1',
-          description: 'desc1',
-          sidebar: 'sidebar1',
-        },
-        doc2: {
-          id: 'doc2',
-          title: 'Doc 2',
-          description: 'desc2',
-          sidebar: 'sidebar2',
-        },
-      },
-    });
-
-    function callHook(docId: string | undefined) {
-      const {result} = renderHook(() => useDocById(docId), {
-        wrapper: ({children}) => (
-          <DocsVersionProvider version={version}>
-            {children}
-          </DocsVersionProvider>
-        ),
-      });
-      return result.current;
-    }
-
-    test('should accept undefined', () => {
-      expect(callHook(undefined)).toBeUndefined();
-    });
-
-    test('should find doc1', () => {
-      expect(callHook('doc1')).toMatchObject({id: 'doc1'});
-    });
-    test('should find doc2', () => {
-      expect(callHook('doc2')).toMatchObject({id: 'doc2'});
-    });
-
-    test('should throw for doc3', () => {
-      expect(() => callHook('doc3')).toThrowErrorMatchingInlineSnapshot(
-        `"no version doc found by id=doc3"`,
-      );
-    });
-  });
-
-  describe('findSidebarCategory', () => {
-    test('should be able to return undefined', () => {
-      expect(findSidebarCategory([], () => false)).toBeUndefined();
-      expect(
-        findSidebarCategory([testCategory(), testCategory()], () => false),
-      ).toBeUndefined();
-    });
-
-    test('should return first element matching predicate', () => {
-      const first = testCategory();
-      const second = testCategory();
-      const third = testCategory();
-      const sidebar = [first, second, third];
-      expect(findSidebarCategory(sidebar, () => true)).toEqual(first);
-      expect(findSidebarCategory(sidebar, (item) => item === first)).toEqual(
-        first,
-      );
-      expect(findSidebarCategory(sidebar, (item) => item === second)).toEqual(
-        second,
-      );
-      expect(findSidebarCategory(sidebar, (item) => item === third)).toEqual(
-        third,
-      );
-    });
-
-    test('should be able to search in sub items', () => {
-      const subsub1 = testCategory();
-      const subsub2 = testCategory();
-      const sub1 = testCategory({
-        items: [subsub1, subsub2],
-      });
-      const sub2 = testCategory();
-      const parent = testCategory({
-        items: [sub1, sub2],
-      });
-      const sidebar = [parent];
-
-      expect(findSidebarCategory(sidebar, () => true)).toEqual(parent);
-      expect(findSidebarCategory(sidebar, (item) => item === sub1)).toEqual(
-        sub1,
-      );
-      expect(findSidebarCategory(sidebar, (item) => item === sub2)).toEqual(
-        sub2,
-      );
-      expect(findSidebarCategory(sidebar, (item) => item === subsub1)).toEqual(
-        subsub1,
-      );
-      expect(findSidebarCategory(sidebar, (item) => item === subsub2)).toEqual(
-        subsub2,
-      );
-    });
-  });
-
-  describe('findFirstCategoryLink', () => {
-    test('category without link nor child', () => {
-      expect(
-        findFirstCategoryLink(
-          testCategory({
-            href: undefined,
-          }),
-        ),
-      ).toEqual(undefined);
-    });
-
-    test('category with link', () => {
-      expect(
-        findFirstCategoryLink(
-          testCategory({
-            href: '/itemPath',
-          }),
-        ),
-      ).toEqual('/itemPath');
-    });
-
-    test('category with deeply nested category link', () => {
-      expect(
-        findFirstCategoryLink(
-          testCategory({
-            href: undefined,
-            items: [
-              testCategory({
-                href: undefined,
-                items: [
-                  testCategory({
-                    href: '/itemPath',
-                  }),
-                ],
-              }),
-            ],
-          }),
-        ),
-      ).toEqual('/itemPath');
-    });
-
-    test('category with deeply nested link', () => {
-      expect(
-        findFirstCategoryLink(
-          testCategory({
-            href: undefined,
-            items: [
-              testCategory({
-                href: undefined,
-                items: [{type: 'link', href: '/itemPath', label: 'Label'}],
-              }),
-            ],
-          }),
-        ),
-      ).toEqual('/itemPath');
-    });
-  });
-
-  describe('isActiveSidebarItem', () => {
-    test('with link href', () => {
-      const item: PropSidebarItem = {
-        type: 'link',
-        href: '/itemPath',
-        label: 'Label',
-      };
-
-      expect(isActiveSidebarItem(item, '/unexistingPath')).toEqual(false);
-
-      expect(isActiveSidebarItem(item, '/itemPath')).toEqual(true);
-
-      // Ensure it's not trailing slash sensitive:
-      expect(isActiveSidebarItem(item, '/itemPath/')).toEqual(true);
-      expect(
-        isActiveSidebarItem({...item, href: '/itemPath/'}, '/itemPath'),
-      ).toEqual(true);
-    });
-
-    test('with category href', () => {
-      const item: PropSidebarItem = testCategory({
-        href: '/itemPath',
-      });
-
-      expect(isActiveSidebarItem(item, '/unexistingPath')).toEqual(false);
-
-      expect(isActiveSidebarItem(item, '/itemPath')).toEqual(true);
-
-      // Ensure it's not trailing slash sensitive:
-      expect(isActiveSidebarItem(item, '/itemPath/')).toEqual(true);
-      expect(
-        isActiveSidebarItem({...item, href: '/itemPath/'}, '/itemPath'),
-      ).toEqual(true);
-    });
-
-    test('with category nested items', () => {
-      const item: PropSidebarItem = testCategory({
-        href: '/category-path',
-        items: [
-          {
-            type: 'link',
-            href: '/sub-link-path',
-            label: 'Label',
-          },
-          testCategory({
-            href: '/sub-category-path',
-            items: [
-              {
-                type: 'link',
-                href: '/sub-sub-link-path',
-                label: 'Label',
-              },
-            ],
-          }),
-        ],
-      });
-
-      expect(isActiveSidebarItem(item, '/unexistingPath')).toEqual(false);
-
-      expect(isActiveSidebarItem(item, '/category-path')).toEqual(true);
-      expect(isActiveSidebarItem(item, '/sub-link-path')).toEqual(true);
-      expect(isActiveSidebarItem(item, '/sub-category-path')).toEqual(true);
-      expect(isActiveSidebarItem(item, '/sub-sub-link-path')).toEqual(true);
-
-      // Ensure it's not trailing slash sensitive:
-      expect(isActiveSidebarItem(item, '/category-path/')).toEqual(true);
-      expect(isActiveSidebarItem(item, '/sub-link-path/')).toEqual(true);
-      expect(isActiveSidebarItem(item, '/sub-category-path/')).toEqual(true);
-      expect(isActiveSidebarItem(item, '/sub-sub-link-path/')).toEqual(true);
-    });
-  });
-});

package/src/utils/__tests__/jsUtils.test.ts

@@ -1,33 +0,0 @@
-/**
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-
-import {uniq} from '../jsUtils';
-
-describe('uniq', () => {
-  test('remove duplicate primitives', () => {
-    expect(uniq(['A', 'B', 'C', 'B', 'A', 'D'])).toEqual(['A', 'B', 'C', 'D']);
-    expect(uniq([3, 3, 5, 1, 6, 3, 5])).toEqual([3, 5, 1, 6]);
-    expect(uniq([null, undefined, 3, null, 4, 3])).toEqual([
-      null,
-      undefined,
-      3,
-      4,
-    ]);
-  });
-
-  test('remove duplicate objects/arrays by identity', () => {
-    const obj1 = {};
-    const obj2 = {};
-    const obj3 = {};
-    const array1: unknown[] = [];
-    const array2: unknown[] = [];
-    const array3: unknown[] = [];
-    expect(
-      uniq([obj1, obj1, obj2, array1, obj2, array3, array2, array1, obj3]),
-    ).toEqual([obj1, obj2, array1, array3, array2, obj3]);
-  });
-});

package/src/utils/__tests__/pathUtils.test.ts

@@ -1,32 +0,0 @@
-/**
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-
-import {isSamePath} from '../pathUtils';
-
-describe('isSamePath', () => {
-  test('should be true for compared path without trailing slash', () => {
-    expect(isSamePath('/docs', '/docs')).toBeTruthy();
-  });
-
-  test('should be true for compared path with trailing slash', () => {
-    expect(isSamePath('/docs', '/docs/')).toBeTruthy();
-  });
-
-  test('should be false for compared path with double trailing slash', () => {
-    expect(isSamePath('/docs', '/docs//')).toBeFalsy();
-  });
-
-  test('should be true for twice undefined/null', () => {
-    expect(isSamePath(undefined, undefined)).toBeTruthy();
-    expect(isSamePath(undefined, undefined)).toBeTruthy();
-  });
-
-  test('should be false when one undefined', () => {
-    expect(isSamePath('/docs', undefined)).toBeFalsy();
-    expect(isSamePath(undefined, '/docs')).toBeFalsy();
-  });
-});

package/src/utils/__tests__/tagUtils.test.ts

@@ -1,66 +0,0 @@
-/**
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-
-import {shuffle} from 'lodash';
-import {listTagsByLetters} from '../tagsUtils';
-
-describe('listTagsByLetters', () => {
-  type Param = Parameters<typeof listTagsByLetters>[0];
-  type Tag = Param[number];
-  type Result = ReturnType<typeof listTagsByLetters>;
-
-  test('Should create letters list', () => {
-    const tag1: Tag = {
-      name: 'tag1',
-      permalink: '/tag1',
-      count: 1,
-    };
-    const tag2: Tag = {
-      name: 'Tag2',
-      permalink: '/tag2',
-      count: 11,
-    };
-    const tagzxy: Tag = {
-      name: 'zxy',
-      permalink: '/zxy',
-      count: 987,
-    };
-    const tagAbc: Tag = {
-      name: 'Abc',
-      permalink: '/abc',
-      count: 123,
-    };
-    const tagdef: Tag = {
-      name: 'def',
-      permalink: '/def',
-      count: 1,
-    };
-    const tagaaa: Tag = {
-      name: 'aaa',
-      permalink: '/aaa',
-      count: 10,
-    };
-
-    const expectedResult: Result = [
-      {letter: 'A', tags: [tagaaa, tagAbc]},
-      {letter: 'D', tags: [tagdef]},
-      {letter: 'T', tags: [tag1, tag2]},
-      {letter: 'Z', tags: [tagzxy]},
-    ];
-
-    // Input order shouldn't matter, output is always consistently sorted
-    expect(
-      listTagsByLetters([tag1, tag2, tagzxy, tagAbc, tagdef, tagaaa]),
-    ).toEqual(expectedResult);
-    expect(
-      listTagsByLetters([tagzxy, tagdef, tagaaa, tag2, tagAbc, tag1]),
-    ).toEqual(expectedResult);
-    expect(
-      listTagsByLetters(shuffle([tagzxy, tagdef, tagaaa, tag2, tagAbc, tag1])),
-    ).toEqual(expectedResult);
-  });
-});

package/src/utils/__tests__/tocUtils.test.ts

@@ -1,197 +0,0 @@
-/**
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-
-import {TOCItem} from '@docusaurus/types';
-import {filterTOC} from '../tocUtils';
-
-describe('filterTOC', () => {
-  test('filter a toc with all heading levels', () => {
-    const toc: TOCItem[] = [
-      {
-        id: 'alpha',
-        level: 1,
-        value: 'alpha',
-        children: [
-          {
-            id: 'bravo',
-            level: 2,
-            value: 'Bravo',
-            children: [
-              {
-                id: 'charlie',
-                level: 3,
-                value: 'Charlie',
-                children: [
-                  {
-                    id: 'delta',
-                    level: 4,
-                    value: 'Delta',
-                    children: [
-                      {
-                        id: 'echo',
-                        level: 5,
-                        value: 'Echo',
-                        children: [
-                          {
-                            id: 'foxtrot',
-                            level: 6,
-                            value: 'Foxtrot',
-                            children: [],
-                          },
-                        ],
-                      },
-                    ],
-                  },
-                ],
-              },
-            ],
-          },
-        ],
-      },
-    ];
-
-    expect(filterTOC({toc, minHeadingLevel: 2, maxHeadingLevel: 2})).toEqual([
-      {
-        id: 'bravo',
-        level: 2,
-        value: 'Bravo',
-        children: [],
-      },
-    ]);
-
-    expect(filterTOC({toc, minHeadingLevel: 3, maxHeadingLevel: 3})).toEqual([
-      {
-        id: 'charlie',
-        level: 3,
-        value: 'Charlie',
-        children: [],
-      },
-    ]);
-
-    expect(filterTOC({toc, minHeadingLevel: 2, maxHeadingLevel: 3})).toEqual([
-      {
-        id: 'bravo',
-        level: 2,
-        value: 'Bravo',
-        children: [
-          {
-            id: 'charlie',
-            level: 3,
-            value: 'Charlie',
-            children: [],
-          },
-        ],
-      },
-    ]);
-
-    expect(filterTOC({toc, minHeadingLevel: 2, maxHeadingLevel: 4})).toEqual([
-      {
-        id: 'bravo',
-        level: 2,
-        value: 'Bravo',
-        children: [
-          {
-            id: 'charlie',
-            level: 3,
-            value: 'Charlie',
-            children: [
-              {
-                id: 'delta',
-                level: 4,
-                value: 'Delta',
-                children: [],
-              },
-            ],
-          },
-        ],
-      },
-    ]);
-  });
-
-  // It's not 100% clear exactly how the TOC should behave under weird heading levels provided by the user
-  // Adding a test so that behavior stays the same over time
-  test('filter invalid heading levels (but possible) TOC', () => {
-    const toc: TOCItem[] = [
-      {
-        id: 'charlie',
-        level: 3,
-        value: 'Charlie',
-        children: [],
-      },
-      {
-        id: 'bravo',
-        level: 2,
-        value: 'Bravo',
-        children: [
-          {
-            id: 'delta',
-            level: 4,
-            value: 'Delta',
-            children: [],
-          },
-        ],
-      },
-    ];
-
-    expect(filterTOC({toc, minHeadingLevel: 2, maxHeadingLevel: 2})).toEqual([
-      {
-        id: 'bravo',
-        level: 2,
-        value: 'Bravo',
-        children: [],
-      },
-    ]);
-
-    expect(filterTOC({toc, minHeadingLevel: 3, maxHeadingLevel: 3})).toEqual([
-      {
-        id: 'charlie',
-        level: 3,
-        value: 'Charlie',
-        children: [],
-      },
-    ]);
-
-    expect(filterTOC({toc, minHeadingLevel: 4, maxHeadingLevel: 4})).toEqual([
-      {
-        id: 'delta',
-        level: 4,
-        value: 'Delta',
-        children: [],
-      },
-    ]);
-
-    expect(filterTOC({toc, minHeadingLevel: 2, maxHeadingLevel: 3})).toEqual([
-      {
-        id: 'charlie',
-        level: 3,
-        value: 'Charlie',
-        children: [],
-      },
-      {
-        id: 'bravo',
-        level: 2,
-        value: 'Bravo',
-        children: [],
-      },
-    ]);
-
-    expect(filterTOC({toc, minHeadingLevel: 3, maxHeadingLevel: 4})).toEqual([
-      {
-        id: 'charlie',
-        level: 3,
-        value: 'Charlie',
-        children: [],
-      },
-      {
-        id: 'delta',
-        level: 4,
-        value: 'Delta',
-        children: [],
-      },
-    ]);
-  });
-});

package/tsconfig.json

@@ -1,10 +0,0 @@
-{
-  "extends": "../../tsconfig.json",
-  "compilerOptions": {
-    "incremental": true,
-    "tsBuildInfoFile": "./lib/.tsbuildinfo",
-    "module": "esnext",
-    "rootDir": "src",
-    "outDir": "lib"
-  }
-}