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

package/src/__tests__/slug.test.ts

@@ -1,216 +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 getSlug from '../slug';
-
-describe('getSlug', () => {
-  test('should default to dirname/id', () => {
-    expect(
-      getSlug({
-        baseID: 'doc',
-        source: '@site/docs/dir/doc.md',
-        sourceDirName: '/dir',
-      }),
-    ).toEqual('/dir/doc');
-    expect(
-      getSlug({
-        baseID: 'doc',
-        source: '@site/docs/dir/subdir/doc.md',
-        sourceDirName: '/dir/subdir',
-      }),
-    ).toEqual('/dir/subdir/doc');
-  });
-
-  test('should handle conventional doc indexes', () => {
-    expect(
-      getSlug({
-        baseID: 'doc',
-        source: '@site/docs/dir/subdir/index.md',
-        sourceDirName: '/dir/subdir',
-      }),
-    ).toEqual('/dir/subdir/');
-    expect(
-      getSlug({
-        baseID: 'doc',
-        source: '@site/docs/dir/subdir/inDEx.mdx',
-        sourceDirName: '/dir/subdir',
-      }),
-    ).toEqual('/dir/subdir/');
-    expect(
-      getSlug({
-        baseID: 'doc',
-        source: '@site/docs/dir/subdir/readme.md',
-        sourceDirName: '/dir/subdir',
-      }),
-    ).toEqual('/dir/subdir/');
-    expect(
-      getSlug({
-        baseID: 'doc',
-        source: '@site/docs/dir/subdir/reADMe.mdx',
-        sourceDirName: '/dir/subdir',
-      }),
-    ).toEqual('/dir/subdir/');
-    expect(
-      getSlug({
-        baseID: 'doc',
-        source: '@site/docs/dir/subdir/subdir.md',
-        sourceDirName: '/dir/subdir',
-      }),
-    ).toEqual('/dir/subdir/');
-    expect(
-      getSlug({
-        baseID: 'doc',
-        source: '@site/docs/dir/subdir/suBDir.mdx',
-        sourceDirName: '/dir/subdir',
-      }),
-    ).toEqual('/dir/subdir/');
-  });
-
-  test('should ignore conventional doc index when explicit slug frontmatter is provided', () => {
-    expect(
-      getSlug({
-        baseID: 'doc',
-        source: '@site/docs/dir/subdir/index.md',
-        sourceDirName: '/dir/subdir',
-        frontmatterSlug: '/my/frontMatterSlug',
-      }),
-    ).toEqual('/my/frontMatterSlug');
-  });
-
-  test('can strip dir number prefixes', () => {
-    expect(
-      getSlug({
-        baseID: 'doc',
-        source: '@site/docs/001-dir1/002-dir2/doc.md',
-        sourceDirName: '/001-dir1/002-dir2',
-        stripDirNumberPrefixes: true,
-      }),
-    ).toEqual('/dir1/dir2/doc');
-    expect(
-      getSlug({
-        baseID: 'doc',
-        source: '@site/docs/001-dir1/002-dir2/doc.md',
-        sourceDirName: '/001-dir1/002-dir2',
-        stripDirNumberPrefixes: false,
-      }),
-    ).toEqual('/001-dir1/002-dir2/doc');
-  });
-
-  // See https://github.com/facebook/docusaurus/issues/3223
-  test('should handle special chars in doc path', () => {
-    expect(
-      getSlug({
-        baseID: 'my dôc',
-        source: '@site/docs/dir with spâce/hey $hello/doc.md',
-        sourceDirName: '/dir with spâce/hey $hello',
-      }),
-    ).toEqual('/dir with spâce/hey $hello/my dôc');
-  });
-
-  test('should handle current dir', () => {
-    expect(
-      getSlug({baseID: 'doc', source: '@site/docs/doc.md', sourceDirName: '.'}),
-    ).toEqual('/doc');
-    expect(
-      getSlug({baseID: 'doc', source: '@site/docs/doc.md', sourceDirName: '/'}),
-    ).toEqual('/doc');
-  });
-
-  test('should resolve absolute slug frontmatter', () => {
-    expect(
-      getSlug({
-        baseID: 'any',
-        source: '@site/docs/doc.md',
-        sourceDirName: '.',
-        frontmatterSlug: '/abc/def',
-      }),
-    ).toEqual('/abc/def');
-    expect(
-      getSlug({
-        baseID: 'any',
-        source: '@site/docs/any/doc.md',
-        sourceDirName: './any',
-        frontmatterSlug: '/abc/def',
-      }),
-    ).toEqual('/abc/def');
-    expect(
-      getSlug({
-        baseID: 'any',
-        source: '@site/docs/any/any/doc.md',
-        sourceDirName: './any/any',
-        frontmatterSlug: '/abc/def',
-      }),
-    ).toEqual('/abc/def');
-  });
-
-  test('should resolve relative slug frontmatter', () => {
-    expect(
-      getSlug({
-        baseID: 'any',
-        source: '@site/docs/doc.md',
-        sourceDirName: '.',
-        frontmatterSlug: 'abc/def',
-      }),
-    ).toEqual('/abc/def');
-    expect(
-      getSlug({
-        baseID: 'any',
-        source: '@site/docs/dir/doc.md',
-        sourceDirName: '/dir',
-        frontmatterSlug: 'abc/def',
-      }),
-    ).toEqual('/dir/abc/def');
-    expect(
-      getSlug({
-        baseID: 'any',
-        source: '@site/docs/unslashedDir/doc.md',
-        sourceDirName: 'unslashedDir',
-        frontmatterSlug: 'abc/def',
-      }),
-    ).toEqual('/unslashedDir/abc/def');
-    expect(
-      getSlug({
-        baseID: 'any',
-        source: '@site/docs/dir/subdir/doc.md',
-        sourceDirName: 'dir/subdir',
-        frontmatterSlug: 'abc/def',
-      }),
-    ).toEqual('/dir/subdir/abc/def');
-    expect(
-      getSlug({
-        baseID: 'any',
-        source: '@site/docs/dir/doc.md',
-        sourceDirName: '/dir',
-        frontmatterSlug: './abc/def',
-      }),
-    ).toEqual('/dir/abc/def');
-    expect(
-      getSlug({
-        baseID: 'any',
-        source: '@site/docs/dir/doc.md',
-        sourceDirName: '/dir',
-        frontmatterSlug: './abc/../def',
-      }),
-    ).toEqual('/dir/def');
-    expect(
-      getSlug({
-        baseID: 'any',
-        source: '@site/docs/dir/subdir/doc.md',
-        sourceDirName: '/dir/subdir',
-        frontmatterSlug: '../abc/def',
-      }),
-    ).toEqual('/dir/abc/def');
-    expect(
-      getSlug({
-        baseID: 'any',
-        source: '@site/docs/dir/subdirdoc.md',
-        sourceDirName: '/dir/subdir',
-        frontmatterSlug: '../../../../../abc/../def',
-      }),
-    ).toEqual('/def');
-  });
-});

package/src/__tests__/translations.test.ts

@@ -1,164 +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 {LoadedContent, DocMetadata, LoadedVersion} from '../types';
-import {CURRENT_VERSION_NAME} from '../constants';
-import {
-  getLoadedContentTranslationFiles,
-  translateLoadedContent,
-} from '../translations';
-import {updateTranslationFileMessages} from '@docusaurus/utils';
-
-function createSampleDoc(doc: Pick<DocMetadata, 'id'>): DocMetadata {
-  return {
-    editUrl: 'any',
-    lastUpdatedAt: 0,
-    lastUpdatedBy: 'any',
-    next: undefined,
-    previous: undefined,
-    permalink: 'any',
-    slug: 'any',
-    source: 'any',
-    unversionedId: 'any',
-    version: 'any',
-    title: `${doc.id} title`,
-    sidebar_label: `${doc.id} title`,
-    description: `${doc.id} description`,
-    ...doc,
-  };
-}
-
-function createSampleVersion(
-  version: Pick<LoadedVersion, 'versionName'>,
-): LoadedVersion {
-  return {
-    versionLabel: `${version.versionName} label`,
-    versionPath: '/docs/',
-    mainDocId: '',
-    routePriority: undefined,
-    sidebarFilePath: 'any',
-    isLast: true,
-    contentPath: 'any',
-    contentPathLocalized: 'any',
-    docs: [
-      createSampleDoc({
-        id: 'doc1',
-      }),
-      createSampleDoc({
-        id: 'doc2',
-      }),
-      createSampleDoc({
-        id: 'doc3',
-      }),
-      createSampleDoc({
-        id: 'doc4',
-      }),
-      createSampleDoc({
-        id: 'doc5',
-      }),
-    ],
-    sidebars: {
-      docs: [
-        {
-          type: 'category',
-          label: 'Getting started',
-          collapsed: false,
-          link: {
-            type: 'generated-index',
-            slug: '/category/getting-started-index-slug',
-            permalink: '/docs/category/getting-started-index-slug',
-            title: 'Getting started index title',
-            description: 'Getting started index description',
-          },
-          items: [
-            {
-              type: 'doc',
-              id: 'doc1',
-            },
-            {
-              type: 'doc',
-              id: 'doc2',
-            },
-            {
-              type: 'link',
-              label: 'Link label',
-              href: 'https://facebook.com',
-            },
-            {
-              type: 'ref',
-              id: 'doc1',
-            },
-          ],
-        },
-        {
-          type: 'doc',
-          id: 'doc3',
-        },
-      ],
-      otherSidebar: [
-        {
-          type: 'doc',
-          id: 'doc4',
-        },
-        {
-          type: 'doc',
-          id: 'doc5',
-        },
-      ],
-    },
-    ...version,
-  };
-}
-
-const SampleLoadedContent: LoadedContent = {
-  loadedVersions: [
-    createSampleVersion({
-      versionName: CURRENT_VERSION_NAME,
-    }),
-    createSampleVersion({
-      versionName: '2.0.0',
-    }),
-    createSampleVersion({
-      versionName: '1.0.0',
-    }),
-  ],
-};
-
-function getSampleTranslationFiles() {
-  return getLoadedContentTranslationFiles(SampleLoadedContent);
-}
-function getSampleTranslationFilesTranslated() {
-  const translationFiles = getSampleTranslationFiles();
-  return translationFiles.map((translationFile) =>
-    updateTranslationFileMessages(
-      translationFile,
-      (message) => `${message} (translated)`,
-    ),
-  );
-}
-
-describe('getLoadedContentTranslationFiles', () => {
-  test('should return translation files matching snapshot', async () => {
-    expect(getSampleTranslationFiles()).toMatchSnapshot();
-  });
-});
-
-describe('translateLoadedContent', () => {
-  test('should not translate anything if translation files are untranslated', () => {
-    const translationFiles = getSampleTranslationFiles();
-    expect(
-      translateLoadedContent(SampleLoadedContent, translationFiles),
-    ).toEqual(SampleLoadedContent);
-  });
-
-  test('should return translated loaded content matching snapshot', () => {
-    const translationFiles = getSampleTranslationFilesTranslated();
-    expect(
-      translateLoadedContent(SampleLoadedContent, translationFiles),
-    ).toMatchSnapshot();
-  });
-});