@docusaurus/plugin-content-docs 2.0.0-beta.ff31de0ff → 2.0.1

package/src/client/__tests__/docsClientUtils.test.ts

@@ -1,372 +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 {
-  ActivePlugin,
-  getActivePlugin,
-  getLatestVersion,
-  getActiveDocContext,
-  getActiveVersion,
-  getDocVersionSuggestions,
-} from '../docsClientUtils';
-import {GlobalPluginData, GlobalVersion} from '../../types';
-import {shuffle} from 'lodash';
-
-describe('docsClientUtils', () => {
-  test('getActivePlugin', () => {
-    const data: Record<string, GlobalPluginData> = {
-      pluginIosId: {
-        path: '/ios',
-        versions: [],
-      },
-      pluginAndroidId: {
-        path: '/android',
-        versions: [],
-      },
-    };
-
-    expect(getActivePlugin(data, '/')).toEqual(undefined);
-    expect(getActivePlugin(data, '/xyz')).toEqual(undefined);
-
-    expect(() =>
-      getActivePlugin(data, '/', {failfast: true}),
-    ).toThrowErrorMatchingInlineSnapshot(
-      `"Can't find active docs plugin for pathname=/, while it was expected to be found. Maybe you tried to use a docs feature that can only be used on a docs-related page? Existing docs plugin paths are: /ios, /android"`,
-    );
-    expect(() =>
-      getActivePlugin(data, '/xyz', {failfast: true}),
-    ).toThrowErrorMatchingInlineSnapshot(
-      `"Can't find active docs plugin for pathname=/xyz, while it was expected to be found. Maybe you tried to use a docs feature that can only be used on a docs-related page? Existing docs plugin paths are: /ios, /android"`,
-    );
-
-    const activePluginIos: ActivePlugin = {
-      pluginId: 'pluginIosId',
-      pluginData: data.pluginIosId,
-    };
-    expect(getActivePlugin(data, '/ios')).toEqual(activePluginIos);
-    expect(getActivePlugin(data, '/ios/')).toEqual(activePluginIos);
-    expect(getActivePlugin(data, '/ios/abc/def')).toEqual(activePluginIos);
-
-    const activePluginAndroid: ActivePlugin = {
-      pluginId: 'pluginAndroidId',
-      pluginData: data.pluginAndroidId,
-    };
-    expect(getActivePlugin(data, '/android')).toEqual(activePluginAndroid);
-    expect(getActivePlugin(data, '/android/')).toEqual(activePluginAndroid);
-    expect(getActivePlugin(data, '/android/ijk')).toEqual(activePluginAndroid);
-  });
-
-  test('getLatestVersion', () => {
-    const versions: GlobalVersion[] = [
-      {
-        name: 'version1',
-        label: 'version1',
-        path: '/???',
-        isLast: false,
-        docs: [],
-        mainDocId: '???',
-      },
-      {
-        name: 'version2',
-        label: 'version2',
-        path: '/???',
-        isLast: true,
-        docs: [],
-        mainDocId: '???',
-      },
-      {
-        name: 'version3',
-        label: 'version3',
-        path: '/???',
-        isLast: false,
-        docs: [],
-        mainDocId: '???',
-      },
-    ];
-
-    expect(
-      getLatestVersion({
-        path: '???',
-        versions,
-      }),
-    ).toEqual(versions[1]);
-  });
-
-  test('getActiveVersion', () => {
-    const data: GlobalPluginData = {
-      path: 'docs',
-      versions: [
-        {
-          name: 'next',
-          label: 'next',
-          isLast: false,
-          path: '/docs/next',
-          docs: [],
-          mainDocId: '???',
-        },
-        {
-          name: 'version2',
-          label: 'version2',
-          isLast: true,
-          path: '/docs',
-          docs: [],
-          mainDocId: '???',
-        },
-        {
-          name: 'version1',
-          label: 'version1',
-          isLast: false,
-          path: '/docs/version1',
-          docs: [],
-          mainDocId: '???',
-        },
-      ],
-    };
-
-    expect(getActiveVersion(data, '/someUnknownPath')).toEqual(undefined);
-
-    expect(getActiveVersion(data, '/docs/next')?.name).toEqual('next');
-    expect(getActiveVersion(data, '/docs/next/')?.name).toEqual('next');
-    expect(getActiveVersion(data, '/docs/next/someDoc')?.name).toEqual('next');
-
-    expect(getActiveVersion(data, '/docs')?.name).toEqual('version2');
-    expect(getActiveVersion(data, '/docs/')?.name).toEqual('version2');
-    expect(getActiveVersion(data, '/docs/someDoc')?.name).toEqual('version2');
-
-    expect(getActiveVersion(data, '/docs/version1')?.name).toEqual('version1');
-    expect(getActiveVersion(data, '/docs/version1')?.name).toEqual('version1');
-    expect(getActiveVersion(data, '/docs/version1/someDoc')?.name).toEqual(
-      'version1',
-    );
-  });
-
-  test('getActiveDocContext', () => {
-    const versionNext: GlobalVersion = {
-      name: 'next',
-      label: 'next',
-      path: '/docs/next',
-      isLast: false,
-      mainDocId: 'doc1',
-      docs: [
-        {
-          id: 'doc1',
-          path: '/docs/next/',
-        },
-        {
-          id: 'doc2',
-          path: '/docs/next/doc2',
-        },
-      ],
-    };
-
-    const version2: GlobalVersion = {
-      name: 'version2',
-      label: 'version2',
-      isLast: true,
-      path: '/docs',
-      mainDocId: 'doc1',
-      docs: [
-        {
-          id: 'doc1',
-          path: '/docs/',
-        },
-        {
-          id: 'doc2',
-          path: '/docs/doc2',
-        },
-      ],
-    };
-
-    const version1: GlobalVersion = {
-      name: 'version1',
-      label: 'version1',
-      path: '/docs/version1',
-      isLast: false,
-      mainDocId: 'doc1',
-      docs: [
-        {
-          id: 'doc1',
-          path: '/docs/version1/',
-        },
-      ],
-    };
-
-    // shuffle, because order shouldn't matter
-    const versions: GlobalVersion[] = shuffle([
-      versionNext,
-      version2,
-      version1,
-    ]);
-
-    const data: GlobalPluginData = {
-      path: 'docs',
-      versions,
-    };
-
-    expect(getActiveDocContext(data, '/doesNotExist')).toEqual({
-      activeVersion: undefined,
-      activeDoc: undefined,
-      alternateDocVersions: {},
-    });
-
-    expect(getActiveDocContext(data, '/docs/next/doesNotExist')).toEqual({
-      activeVersion: versionNext,
-      activeDoc: undefined,
-      alternateDocVersions: {},
-    });
-
-    expect(getActiveDocContext(data, '/docs/next')).toEqual({
-      activeVersion: versionNext,
-      activeDoc: versionNext.docs[0],
-      alternateDocVersions: {
-        next: versionNext.docs[0],
-        version2: version2.docs[0],
-        version1: version1.docs[0],
-      },
-    });
-    expect(getActiveDocContext(data, '/docs/next/doc2')).toEqual({
-      activeVersion: versionNext,
-      activeDoc: versionNext.docs[1],
-      alternateDocVersions: {
-        next: versionNext.docs[1],
-        version2: version2.docs[1],
-        version1: undefined,
-      },
-    });
-
-    expect(getActiveDocContext(data, '/docs/')).toEqual({
-      activeVersion: version2,
-      activeDoc: version2.docs[0],
-      alternateDocVersions: {
-        next: versionNext.docs[0],
-        version2: version2.docs[0],
-        version1: version1.docs[0],
-      },
-    });
-    expect(getActiveDocContext(data, '/docs/doc2')).toEqual({
-      activeVersion: version2,
-      activeDoc: version2.docs[1],
-      alternateDocVersions: {
-        next: versionNext.docs[1],
-        version2: version2.docs[1],
-        version1: undefined,
-      },
-    });
-
-    expect(getActiveDocContext(data, '/docs/version1')).toEqual({
-      activeVersion: version1,
-      activeDoc: version1.docs[0],
-      alternateDocVersions: {
-        next: versionNext.docs[0],
-        version2: version2.docs[0],
-        version1: version1.docs[0],
-      },
-    });
-    expect(getActiveDocContext(data, '/docs/version1/doc2')).toEqual({
-      activeVersion: version1,
-      activeDoc: undefined,
-      alternateDocVersions: {},
-    });
-  });
-
-  test('getDocVersionSuggestions', () => {
-    const versionNext: GlobalVersion = {
-      name: 'next',
-      label: 'next',
-      isLast: false,
-      path: '/docs/next',
-      mainDocId: 'doc1',
-      docs: [
-        {
-          id: 'doc1',
-          path: '/docs/next/',
-        },
-        {
-          id: 'doc2',
-          path: '/docs/next/doc2',
-        },
-      ],
-    };
-
-    const version2: GlobalVersion = {
-      name: 'version2',
-      label: 'version2',
-      path: '/docs',
-      isLast: true,
-      mainDocId: 'doc1',
-      docs: [
-        {
-          id: 'doc1',
-          path: '/docs/',
-        },
-        {
-          id: 'doc2',
-          path: '/docs/doc2',
-        },
-      ],
-    };
-
-    const version1: GlobalVersion = {
-      name: 'version1',
-      label: 'version1',
-      isLast: false,
-      path: '/docs/version1',
-      mainDocId: 'doc1',
-      docs: [
-        {
-          id: 'doc1',
-          path: '/docs/version1/',
-        },
-      ],
-    };
-
-    // shuffle, because order shouldn't matter
-    const versions: GlobalVersion[] = shuffle([
-      versionNext,
-      version2,
-      version1,
-    ]);
-
-    const data: GlobalPluginData = {
-      path: 'docs',
-      versions,
-    };
-
-    expect(getDocVersionSuggestions(data, '/doesNotExist')).toEqual({
-      latestDocSuggestion: undefined,
-      latestVersionSuggestion: version2,
-    });
-
-    expect(getDocVersionSuggestions(data, '/docs/next')).toEqual({
-      latestDocSuggestion: version2.docs[0],
-      latestVersionSuggestion: version2,
-    });
-    expect(getDocVersionSuggestions(data, '/docs/next/doc2')).toEqual({
-      latestDocSuggestion: version2.docs[1],
-      latestVersionSuggestion: version2,
-    });
-
-    // nothing to suggest, we are already on latest version
-    expect(getDocVersionSuggestions(data, '/docs/')).toEqual({
-      latestDocSuggestion: undefined,
-      latestVersionSuggestion: undefined,
-    });
-    expect(getDocVersionSuggestions(data, '/docs/doc2')).toEqual({
-      latestDocSuggestion: undefined,
-      latestVersionSuggestion: undefined,
-    });
-
-    expect(getDocVersionSuggestions(data, '/docs/version1/')).toEqual({
-      latestDocSuggestion: version2.docs[0],
-      latestVersionSuggestion: version2,
-    });
-    expect(getDocVersionSuggestions(data, '/docs/version1/doc2')).toEqual({
-      latestDocSuggestion: undefined, // because /docs/version1/doc2 does not exist
-      latestVersionSuggestion: version2,
-    });
-  });
-});

package/src/docFrontMatter.ts

@@ -1,53 +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.
- */
-
-/* eslint-disable camelcase */
-
-import {
-  JoiFrontMatter as Joi, // Custom instance for frontmatter
-  validateFrontMatter,
-} from '@docusaurus/utils-validation';
-
-export type DocFrontMatter = {
-  id?: string;
-  title?: string;
-  hide_title?: boolean;
-  hide_table_of_contents?: boolean;
-  keywords?: string[];
-  image?: string;
-  description?: string;
-  slug?: string;
-  sidebar_label?: string;
-  sidebar_position?: number;
-  custom_edit_url?: string | null;
-  parse_number_prefixes?: boolean;
-};
-
-// NOTE: we don't add any default value on purpose here
-// We don't want default values to magically appear in doc metadatas and props
-// While the user did not provide those values explicitly
-// We use default values in code instead
-const DocFrontMatterSchema = Joi.object<DocFrontMatter>({
-  id: Joi.string(),
-  title: Joi.string().allow(''), // see https://github.com/facebook/docusaurus/issues/4591#issuecomment-822372398
-  hide_title: Joi.boolean(),
-  hide_table_of_contents: Joi.boolean(),
-  keywords: Joi.array().items(Joi.string().required()),
-  image: Joi.string().uri({allowRelative: false}),
-  description: Joi.string().allow(''), // see  https://github.com/facebook/docusaurus/issues/4591#issuecomment-822372398
-  slug: Joi.string(),
-  sidebar_label: Joi.string(),
-  sidebar_position: Joi.number().min(0),
-  custom_edit_url: Joi.string().uri({allowRelative: true}).allow('', null),
-  parse_number_prefixes: Joi.boolean(),
-}).unknown();
-
-export function validateDocFrontMatter(
-  frontMatter: Record<string, unknown>,
-): DocFrontMatter {
-  return validateFrontMatter(frontMatter, DocFrontMatterSchema);
-}

package/src/markdown/__tests__/__fixtures__/docs/doc-localized.md

@@ -1 +0,0 @@
-### localized doc

package/src/markdown/__tests__/__fixtures__/docs/doc1.md

@@ -1,13 +0,0 @@
-# Don't transform any link here
-
-![image1](assets/image1.png)
-
-# Don't replace inside fenced codeblock
-
-```md
-![doc4](doc4.md)
-```
-
-### Non-existing Docs
-
-- [hahaha](hahaha.md)

package/src/markdown/__tests__/__fixtures__/docs/doc2.md

@@ -1,12 +0,0 @@
-### Existing Docs
-
-- [doc1](doc1.md)
-- [doc2](./doc2.md)
-- [doc3](subdir/doc3.md)
-
-## Repeating Docs
-
-- [doc1](doc1.md)
-- [doc2](./doc2.md)
-
-- [doc-localized](./doc-localized.md)

package/src/markdown/__tests__/__fixtures__/docs/doc4.md

@@ -1,19 +0,0 @@
-### Existing Docs
-
-- [doc1][doc1]
-- [doc2][doc2]
-
-## Repeating Docs
-
-- [doc1][doc1]
-- [doc2][doc2]
-
-## Do not replace this
-
-```md
-![image1][image1]
-```
-
-[doc1]: doc1.md
-[doc2]: ./doc2.md
-[image1]: assets/image1.png

package/src/markdown/__tests__/__fixtures__/docs/doc5.md

@@ -1,6 +0,0 @@
-### Not Existing Docs
-
-- [docNotExist1](docNotExist1.md)
-- [docNotExist2](./docNotExist2.mdx)
-- [docNotExist3](../docNotExist3.mdx)
-- [docNotExist4](./subdir/docNotExist4.md)

package/src/markdown/__tests__/__fixtures__/docs/subdir/doc3.md

@@ -1,3 +0,0 @@
-### Relative linking
-
-- [doc1](../doc2.md)

package/src/markdown/__tests__/__fixtures__/versioned_docs/version-1.0.0/doc2.md

@@ -1,7 +0,0 @@
-### Existing Docs
-
-- [doc1](subdir/doc1.md)
-
-### With hash
-
-- [doc2](doc2.md#existing-docs)

package/src/markdown/__tests__/__fixtures__/versioned_docs/version-1.0.0/subdir/doc1.md

@@ -1,3 +0,0 @@
-### Relative linking
-
-- [doc1](../doc2.md)

package/src/markdown/__tests__/__snapshots__/linkify.test.ts.snap

@@ -1,82 +0,0 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`transform nothing 1`] = `
-"# Don't transform any link here
-
-![image1](assets/image1.png)
-
-# Don't replace inside fenced codeblock
-
-\`\`\`md
-![doc4](doc4.md)
-\`\`\`
-
-### Non-existing Docs
-
-- [hahaha](hahaha.md)
-"
-`;
-
-exports[`transform relative links 1`] = `
-"### Relative linking
-
-- [doc1](/docs/doc2)
-"
-`;
-
-exports[`transform to correct links 1`] = `
-"### Existing Docs
-
-- [doc1](/docs/doc1)
-- [doc2](/docs/doc2)
-- [doc3](/docs/subdir/doc3)
-
-## Repeating Docs
-
-- [doc1](/docs/doc1)
-- [doc2](/docs/doc2)
-
-- [doc-localized](/fr/doc-localized)
-"
-`;
-
-exports[`transforms absolute links in versioned docs 1`] = `
-"### Existing Docs
-
-- [doc1](/docs/1.0.0/subdir/doc1)
-
-### With hash
-
-- [doc2](/docs/1.0.0/doc2#existing-docs)
-"
-`;
-
-exports[`transforms reference links 1`] = `
-"### Existing Docs
-
-- [doc1][doc1]
-- [doc2][doc2]
-
-## Repeating Docs
-
-- [doc1][doc1]
-- [doc2][doc2]
-
-## Do not replace this
-
-\`\`\`md
-![image1][image1]
-\`\`\`
-
-[doc1]: /docs/doc1
-[doc2]: /docs/doc2
-[image1]: assets/image1.png
-"
-`;
-
-exports[`transforms relative links in versioned docs 1`] = `
-"### Relative linking
-
-- [doc1](/docs/1.0.0/doc2)
-"
-`;