@docusaurus/plugin-content-docs 2.0.0-beta.13 → 2.0.0-beta.15

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

@@ -1,105 +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 {validateSidebars, validateCategoryMetadataFile} from '../validation';
-import {CategoryMetadataFile} from '../generator';
-import {SidebarsConfig} from '../types';
-
-describe('validateSidebars', () => {
-  // TODO add more tests
-
-  // TODO it seems many error cases are not validated properly
-  // and error messages are quite bad
-  test('throw for bad value', async () => {
-    expect(() => validateSidebars({sidebar: [{type: 42}]}))
-      .toThrowErrorMatchingInlineSnapshot(`
-      "{
-        \\"type\\": 42,
-        \\"undefined\\" [1]: -- missing --
-      }
-      
-      [1] Unknown sidebar item type \\"42\\"."
-    `);
-  });
-
-  test('accept empty object', async () => {
-    const sidebars: SidebarsConfig = {};
-    validateSidebars(sidebars);
-  });
-
-  test('accept valid values', async () => {
-    const sidebars: SidebarsConfig = {
-      sidebar1: [
-        {type: 'doc', id: 'doc1'},
-        {type: 'doc', id: 'doc2'},
-        {
-          type: 'category',
-          label: 'Category',
-          items: [{type: 'doc', id: 'doc3'}],
-        },
-      ],
-    };
-    validateSidebars(sidebars);
-  });
-});
-
-describe('validateCategoryMetadataFile', () => {
-  // TODO add more tests
-
-  test('throw for bad value', async () => {
-    expect(() =>
-      validateCategoryMetadataFile(42),
-    ).toThrowErrorMatchingInlineSnapshot(
-      `"\\"value\\" must be of type object"`,
-    );
-  });
-
-  test('accept empty object', async () => {
-    const content: CategoryMetadataFile = {};
-    expect(validateCategoryMetadataFile(content)).toEqual(content);
-  });
-
-  test('accept valid values', async () => {
-    const content: CategoryMetadataFile = {
-      className: 'className',
-      label: 'Category Label',
-      link: {
-        type: 'generated-index',
-        slug: 'slug',
-        title: 'title',
-        description: 'description',
-      },
-      collapsible: true,
-      collapsed: true,
-      position: 3,
-    };
-    expect(validateCategoryMetadataFile(content)).toEqual(content);
-  });
-
-  test('rejects permalink', async () => {
-    const content: CategoryMetadataFile = {
-      className: 'className',
-      label: 'Category Label',
-      link: {
-        type: 'generated-index',
-        slug: 'slug',
-        // @ts-expect-error: rejected on purpose
-        permalink: 'somePermalink',
-        title: 'title',
-        description: 'description',
-      },
-      collapsible: true,
-      collapsed: true,
-      position: 3,
-    };
-    expect(() =>
-      validateCategoryMetadataFile(content),
-    ).toThrowErrorMatchingInlineSnapshot(
-      `"\\"link.permalink\\" is not allowed"`,
-    );
-  });
-});

package/tsconfig.json

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