@docusaurus/plugin-content-docs 0.0.0-4281 → 0.0.0-4282

package/src/sidebars/__tests__/index.test.ts

@@ -1,204 +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 path from 'path';
-import {
-  loadNormalizedSidebars,
-  DefaultSidebars,
-  DisabledSidebars,
-} from '../index';
-import type {NormalizeSidebarsParams, VersionMetadata} from '../../types';
-
-describe('loadNormalizedSidebars', () => {
-  const fixtureDir = path.join(__dirname, '__fixtures__', 'sidebars');
-  const options: NormalizeSidebarsParams = {
-    sidebarCollapsed: true,
-    sidebarCollapsible: true,
-    version: {
-      versionName: 'version',
-      versionPath: 'versionPath',
-    } as VersionMetadata,
-  };
-  test('sidebars with known sidebar item type', async () => {
-    const sidebarPath = path.join(fixtureDir, 'sidebars.json');
-    const result = loadNormalizedSidebars(sidebarPath, options);
-    expect(result).toMatchSnapshot();
-  });
-
-  test('sidebars with deep level of category', async () => {
-    const sidebarPath = path.join(fixtureDir, 'sidebars-category.js');
-    const result = loadNormalizedSidebars(sidebarPath, options);
-    expect(result).toMatchSnapshot();
-  });
-
-  test('sidebars shorthand and longform lead to exact same sidebar', async () => {
-    const sidebarPath1 = path.join(fixtureDir, 'sidebars-category.js');
-    const sidebarPath2 = path.join(
-      fixtureDir,
-      'sidebars-category-shorthand.js',
-    );
-    const sidebar1 = loadNormalizedSidebars(sidebarPath1, options);
-    const sidebar2 = loadNormalizedSidebars(sidebarPath2, options);
-    expect(sidebar1).toEqual(sidebar2);
-  });
-
-  test('sidebars with category but category.items is not an array', async () => {
-    const sidebarPath = path.join(
-      fixtureDir,
-      'sidebars-category-wrong-items.json',
-    );
-    expect(() => loadNormalizedSidebars(sidebarPath, options))
-      .toThrowErrorMatchingInlineSnapshot(`
-      "{
-        \\"type\\": \\"category\\",
-        \\"label\\": \\"Category Label\\",
-        \\"items\\" [1]: \\"doc1\\"
-      }
-      
-      [1] \\"items\\" must be an array"
-    `);
-  });
-
-  test('sidebars with category but category label is not a string', async () => {
-    const sidebarPath = path.join(
-      fixtureDir,
-      'sidebars-category-wrong-label.json',
-    );
-    expect(() => loadNormalizedSidebars(sidebarPath, options))
-      .toThrowErrorMatchingInlineSnapshot(`
-      "{
-        \\"type\\": \\"category\\",
-        \\"items\\": [
-          \\"doc1\\"
-        ],
-        \\"label\\" [1]: true
-      }
-      
-      [1] \\"label\\" must be a string"
-    `);
-  });
-
-  test('sidebars item doc but id is not a string', async () => {
-    const sidebarPath = path.join(
-      fixtureDir,
-      'sidebars-doc-id-not-string.json',
-    );
-    expect(() => loadNormalizedSidebars(sidebarPath, options))
-      .toThrowErrorMatchingInlineSnapshot(`
-      "{
-        \\"type\\": \\"doc\\",
-        \\"id\\" [1]: [
-          \\"doc1\\"
-        ]
-      }
-      
-      [1] \\"id\\" must be a string"
-    `);
-  });
-
-  test('sidebars with first level not a category', async () => {
-    const sidebarPath = path.join(
-      fixtureDir,
-      'sidebars-first-level-not-category.js',
-    );
-    const result = loadNormalizedSidebars(sidebarPath, options);
-    expect(result).toMatchSnapshot();
-  });
-
-  test('sidebars link', async () => {
-    const sidebarPath = path.join(fixtureDir, 'sidebars-link.json');
-    const result = loadNormalizedSidebars(sidebarPath, options);
-    expect(result).toMatchSnapshot();
-  });
-
-  test('sidebars link wrong label', async () => {
-    const sidebarPath = path.join(fixtureDir, 'sidebars-link-wrong-label.json');
-    expect(() => loadNormalizedSidebars(sidebarPath, options))
-      .toThrowErrorMatchingInlineSnapshot(`
-      "{
-        \\"type\\": \\"link\\",
-        \\"href\\": \\"https://github.com\\",
-        \\"label\\" [1]: false
-      }
-      
-      [1] \\"label\\" must be a string"
-    `);
-  });
-
-  test('sidebars link wrong href', async () => {
-    const sidebarPath = path.join(fixtureDir, 'sidebars-link-wrong-href.json');
-    expect(() => loadNormalizedSidebars(sidebarPath, options))
-      .toThrowErrorMatchingInlineSnapshot(`
-      "{
-        \\"type\\": \\"link\\",
-        \\"label\\": \\"GitHub\\",
-        \\"href\\" [1]: [
-          \\"example.com\\"
-        ]
-      }
-      
-      [1] \\"href\\" contains an invalid value"
-    `);
-  });
-
-  test('sidebars with unknown sidebar item type', async () => {
-    const sidebarPath = path.join(fixtureDir, 'sidebars-unknown-type.json');
-    expect(() => loadNormalizedSidebars(sidebarPath, options))
-      .toThrowErrorMatchingInlineSnapshot(`
-      "{
-        \\"type\\": \\"superman\\",
-        \\"undefined\\" [1]: -- missing --
-      }
-      
-      [1] Unknown sidebar item type \\"superman\\"."
-    `);
-  });
-
-  test('sidebars with known sidebar item type but wrong field', async () => {
-    const sidebarPath = path.join(fixtureDir, 'sidebars-wrong-field.json');
-    expect(() => loadNormalizedSidebars(sidebarPath, options))
-      .toThrowErrorMatchingInlineSnapshot(`
-      "{
-        \\"type\\": \\"category\\",
-        \\"label\\": \\"category\\",
-        \\"href\\": \\"https://github.com\\",
-        \\"items\\" [1]: -- missing --
-      }
-      
-      [1] \\"items\\" is required"
-    `);
-  });
-
-  test('unexisting path', () => {
-    expect(loadNormalizedSidebars('badpath', options)).toEqual(
-      DisabledSidebars,
-    );
-  });
-
-  test('undefined path', () => {
-    expect(loadNormalizedSidebars(undefined, options)).toEqual(DefaultSidebars);
-  });
-
-  test('literal false path', () => {
-    expect(loadNormalizedSidebars(false, options)).toEqual(DisabledSidebars);
-  });
-
-  test('sidebars with category.collapsed property', async () => {
-    const sidebarPath = path.join(fixtureDir, 'sidebars-collapsed.json');
-    const result = loadNormalizedSidebars(sidebarPath, options);
-    expect(result).toMatchSnapshot();
-  });
-
-  test('sidebars with category.collapsed property at first level', async () => {
-    const sidebarPath = path.join(
-      fixtureDir,
-      'sidebars-collapsed-first-level.json',
-    );
-    const result = loadNormalizedSidebars(sidebarPath, options);
-    expect(result).toMatchSnapshot();
-  });
-});

package/src/sidebars/__tests__/processor.test.ts

@@ -1,237 +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 {processSidebars, SidebarProcessorParams} from '../processor';
-import type {
-  SidebarItem,
-  SidebarItemsGenerator,
-  Sidebars,
-  NormalizedSidebars,
-} from '../types';
-import {DefaultSidebarItemsGenerator} from '../generator';
-import {createSlugger} from '@docusaurus/utils';
-import {VersionMetadata} from '../../types';
-import {DefaultNumberPrefixParser} from '../../numberPrefix';
-
-describe('processSidebars', () => {
-  function createStaticSidebarItemGenerator(
-    sidebarSlice: SidebarItem[],
-  ): SidebarItemsGenerator {
-    return jest.fn(async () => sidebarSlice);
-  }
-
-  const StaticGeneratedSidebarSlice: SidebarItem[] = [
-    {type: 'doc', id: 'doc-generated-id-1'},
-    {type: 'doc', id: 'doc-generated-id-2'},
-  ];
-
-  const StaticSidebarItemsGenerator: SidebarItemsGenerator =
-    createStaticSidebarItemGenerator(StaticGeneratedSidebarSlice);
-
-  // @ts-expect-error: good enough for this test
-  const version: VersionMetadata = {
-    versionName: '1.0.0',
-    versionPath: '/docs/1.0.0',
-  };
-
-  const params: SidebarProcessorParams = {
-    sidebarItemsGenerator: StaticSidebarItemsGenerator,
-    docs: [],
-    version,
-    numberPrefixParser: DefaultNumberPrefixParser,
-    categoryLabelSlugger: createSlugger(),
-    sidebarOptions: {
-      sidebarCollapsed: true,
-      sidebarCollapsible: true,
-    },
-  };
-
-  async function testProcessSidebars(
-    unprocessedSidebars: NormalizedSidebars,
-    paramsOverrides: Partial<SidebarProcessorParams> = {},
-  ) {
-    return processSidebars(unprocessedSidebars, {
-      ...params,
-      ...paramsOverrides,
-    });
-  }
-
-  test('let sidebars without autogenerated items untouched', async () => {
-    const unprocessedSidebars: NormalizedSidebars = {
-      someSidebar: [
-        {type: 'doc', id: 'doc1'},
-        {
-          type: 'category',
-          collapsed: false,
-          collapsible: true,
-          items: [{type: 'doc', id: 'doc2'}],
-          label: 'Category',
-        },
-        {type: 'link', href: 'https://facebook.com', label: 'FB'},
-      ],
-      secondSidebar: [
-        {type: 'doc', id: 'doc3'},
-        {type: 'link', href: 'https://instagram.com', label: 'IG'},
-        {
-          type: 'category',
-          collapsed: false,
-          collapsible: true,
-          items: [{type: 'doc', id: 'doc4'}],
-          label: 'Category',
-        },
-      ],
-    };
-
-    const processedSidebar = await testProcessSidebars(unprocessedSidebars);
-    expect(processedSidebar).toEqual(unprocessedSidebars);
-  });
-
-  test('replace autogenerated items by generated sidebars slices', async () => {
-    const unprocessedSidebars: NormalizedSidebars = {
-      someSidebar: [
-        {type: 'doc', id: 'doc1'},
-        {
-          type: 'category',
-          label: 'Category',
-          link: {
-            type: 'generated-index',
-            slug: 'category-generated-index-slug',
-            permalink: 'category-generated-index-permalink',
-          },
-          collapsed: false,
-          collapsible: true,
-          items: [
-            {type: 'doc', id: 'doc2'},
-            {type: 'autogenerated', dirName: 'dir1'},
-          ],
-        },
-        {type: 'link', href: 'https://facebook.com', label: 'FB'},
-      ],
-      secondSidebar: [
-        {type: 'doc', id: 'doc3'},
-        {type: 'autogenerated', dirName: 'dir2'},
-        {type: 'link', href: 'https://instagram.com', label: 'IG'},
-        {type: 'autogenerated', dirName: 'dir3'},
-        {
-          type: 'category',
-          label: 'Category',
-          collapsed: false,
-          collapsible: true,
-          items: [{type: 'doc', id: 'doc4'}],
-        },
-      ],
-    };
-
-    const processedSidebar = await testProcessSidebars(unprocessedSidebars);
-
-    expect(StaticSidebarItemsGenerator).toHaveBeenCalledTimes(3);
-    expect(StaticSidebarItemsGenerator).toHaveBeenCalledWith({
-      defaultSidebarItemsGenerator: DefaultSidebarItemsGenerator,
-      item: {type: 'autogenerated', dirName: 'dir1'},
-      docs: params.docs,
-      version: {
-        versionName: version.versionName,
-      },
-      numberPrefixParser: DefaultNumberPrefixParser,
-      options: params.sidebarOptions,
-    });
-    expect(StaticSidebarItemsGenerator).toHaveBeenCalledWith({
-      defaultSidebarItemsGenerator: DefaultSidebarItemsGenerator,
-      item: {type: 'autogenerated', dirName: 'dir2'},
-      docs: params.docs,
-      version: {
-        versionName: version.versionName,
-      },
-      numberPrefixParser: DefaultNumberPrefixParser,
-      options: params.sidebarOptions,
-    });
-    expect(StaticSidebarItemsGenerator).toHaveBeenCalledWith({
-      defaultSidebarItemsGenerator: DefaultSidebarItemsGenerator,
-      item: {type: 'autogenerated', dirName: 'dir3'},
-      docs: params.docs,
-      version: {
-        versionName: version.versionName,
-      },
-      numberPrefixParser: DefaultNumberPrefixParser,
-      options: params.sidebarOptions,
-    });
-
-    expect(processedSidebar).toEqual({
-      someSidebar: [
-        {type: 'doc', id: 'doc1'},
-        {
-          type: 'category',
-          label: 'Category',
-          link: {
-            type: 'generated-index',
-            slug: 'category-generated-index-slug',
-            permalink: 'category-generated-index-permalink',
-          },
-          collapsed: false,
-          collapsible: true,
-          items: [{type: 'doc', id: 'doc2'}, ...StaticGeneratedSidebarSlice],
-        },
-        {type: 'link', href: 'https://facebook.com', label: 'FB'},
-      ],
-      secondSidebar: [
-        {type: 'doc', id: 'doc3'},
-        ...StaticGeneratedSidebarSlice,
-        {type: 'link', href: 'https://instagram.com', label: 'IG'},
-        ...StaticGeneratedSidebarSlice,
-        {
-          type: 'category',
-          label: 'Category',
-          collapsed: false,
-          collapsible: true,
-          items: [{type: 'doc', id: 'doc4'}],
-        },
-      ],
-    } as Sidebars);
-  });
-
-  test('ensure generated items are normalized', async () => {
-    const sidebarSliceContainingCategoryGeneratedIndex: SidebarItem[] = [
-      {
-        type: 'category',
-        label: 'Generated category',
-        link: {
-          type: 'generated-index',
-          slug: 'generated-cat-index-slug',
-          // @ts-expect-error: TODO undefined should be allowed here, typing error needing refactor
-          permalink: undefined,
-        },
-      },
-    ];
-
-    const unprocessedSidebars: NormalizedSidebars = {
-      someSidebar: [{type: 'autogenerated', dirName: 'dir2'}],
-    };
-
-    const processedSidebar = await testProcessSidebars(unprocessedSidebars, {
-      sidebarItemsGenerator: createStaticSidebarItemGenerator(
-        sidebarSliceContainingCategoryGeneratedIndex,
-      ),
-    });
-
-    expect(processedSidebar).toEqual({
-      someSidebar: [
-        {
-          type: 'category',
-          label: 'Generated category',
-          link: {
-            type: 'generated-index',
-            slug: 'generated-cat-index-slug',
-            permalink: '/docs/1.0.0/generated-cat-index-slug',
-          },
-          items: [],
-          collapsible: true,
-          collapsed: true,
-        },
-      ],
-    } as Sidebars);
-  });
-});