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

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

@@ -1,190 +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 fs from 'fs-extra';
-import path from 'path';
-import {linkify} from '../linkify';
-import {
-  DocsMarkdownOption,
-  SourceToPermalink,
-  VersionMetadata,
-  BrokenMarkdownLink,
-} from '../../types';
-import {VERSIONED_DOCS_DIR, CURRENT_VERSION_NAME} from '../../constants';
-
-function createFakeVersion({
-  versionName,
-  contentPath,
-  contentPathLocalized,
-}: {
-  versionName: string;
-  contentPath: string;
-  contentPathLocalized: string;
-}): VersionMetadata {
-  return {
-    versionName,
-    versionLabel: 'Any',
-    versionPath: 'any',
-    contentPath,
-    contentPathLocalized,
-    sidebarFilePath: 'any',
-    routePriority: undefined,
-    isLast: false,
-  };
-}
-
-const siteDir = path.join(__dirname, '__fixtures__');
-
-const versionCurrent = createFakeVersion({
-  versionName: CURRENT_VERSION_NAME,
-  contentPath: path.join(siteDir, 'docs'),
-  contentPathLocalized: path.join(
-    siteDir,
-    'i18n',
-    'fr',
-    'docusaurus-plugin-content-docs',
-    CURRENT_VERSION_NAME,
-  ),
-});
-
-const version100 = createFakeVersion({
-  versionName: '1.0.0',
-  contentPath: path.join(siteDir, VERSIONED_DOCS_DIR, 'version-1.0.0'),
-  contentPathLocalized: path.join(
-    siteDir,
-    'i18n',
-    'fr',
-    'docusaurus-plugin-content-docs',
-    'version-1.0.0',
-  ),
-});
-
-const sourceToPermalink: SourceToPermalink = {
-  '@site/docs/doc1.md': '/docs/doc1',
-  '@site/docs/doc2.md': '/docs/doc2',
-  '@site/docs/subdir/doc3.md': '/docs/subdir/doc3',
-  '@site/docs/doc4.md': '/docs/doc4',
-  '@site/versioned_docs/version-1.0.0/doc2.md': '/docs/1.0.0/doc2',
-  '@site/versioned_docs/version-1.0.0/subdir/doc1.md':
-    '/docs/1.0.0/subdir/doc1',
-
-  '@site/i18n/fr/docusaurus-plugin-content-docs/current/doc-localized.md':
-    '/fr/doc-localized',
-  '@site/docs/doc-localized': '/doc-localized',
-};
-
-function createMarkdownOptions(
-  options?: Partial<DocsMarkdownOption>,
-): DocsMarkdownOption {
-  return {
-    sourceToPermalink,
-    onBrokenMarkdownLink: () => {},
-    versionsMetadata: [versionCurrent, version100],
-    siteDir,
-    ...options,
-  };
-}
-
-const transform = (filepath: string, options?: Partial<DocsMarkdownOption>) => {
-  const markdownOptions = createMarkdownOptions(options);
-  const content = fs.readFileSync(filepath, 'utf-8');
-  const transformedContent = linkify(content, filepath, markdownOptions);
-  return [content, transformedContent];
-};
-
-test('transform nothing', () => {
-  const doc1 = path.join(versionCurrent.contentPath, 'doc1.md');
-  const [content, transformedContent] = transform(doc1);
-  expect(transformedContent).toMatchSnapshot();
-  expect(content).toEqual(transformedContent);
-});
-
-test('transform to correct links', () => {
-  const doc2 = path.join(versionCurrent.contentPath, 'doc2.md');
-  const [content, transformedContent] = transform(doc2);
-  expect(transformedContent).toMatchSnapshot();
-  expect(transformedContent).toContain('](/docs/doc1');
-  expect(transformedContent).toContain('](/docs/doc2');
-  expect(transformedContent).toContain('](/docs/subdir/doc3');
-  expect(transformedContent).toContain('](/fr/doc-localized');
-  expect(transformedContent).not.toContain('](doc1.md)');
-  expect(transformedContent).not.toContain('](./doc2.md)');
-  expect(transformedContent).not.toContain('](subdir/doc3.md)');
-  expect(transformedContent).not.toContain('](/doc-localized');
-  expect(content).not.toEqual(transformedContent);
-});
-
-test('transform relative links', () => {
-  const doc3 = path.join(versionCurrent.contentPath, 'subdir', 'doc3.md');
-
-  const [content, transformedContent] = transform(doc3);
-  expect(transformedContent).toMatchSnapshot();
-  expect(transformedContent).toContain('](/docs/doc2');
-  expect(transformedContent).not.toContain('](../doc2.md)');
-  expect(content).not.toEqual(transformedContent);
-});
-
-test('transforms reference links', () => {
-  const doc4 = path.join(versionCurrent.contentPath, 'doc4.md');
-  const [content, transformedContent] = transform(doc4);
-  expect(transformedContent).toMatchSnapshot();
-  expect(transformedContent).toContain('[doc1]: /docs/doc1');
-  expect(transformedContent).toContain('[doc2]: /docs/doc2');
-  expect(transformedContent).not.toContain('[doc1]: doc1.md');
-  expect(transformedContent).not.toContain('[doc2]: ./doc2.md');
-  expect(content).not.toEqual(transformedContent);
-});
-
-test('report broken markdown links', () => {
-  const doc5 = path.join(versionCurrent.contentPath, 'doc5.md');
-  const onBrokenMarkdownLink = jest.fn();
-  const [content, transformedContent] = transform(doc5, {
-    onBrokenMarkdownLink,
-  });
-  expect(transformedContent).toEqual(content);
-  expect(onBrokenMarkdownLink).toHaveBeenCalledTimes(4);
-  expect(onBrokenMarkdownLink).toHaveBeenNthCalledWith(1, {
-    filePath: doc5,
-    link: 'docNotExist1.md',
-    contentPaths: versionCurrent,
-  } as BrokenMarkdownLink);
-  expect(onBrokenMarkdownLink).toHaveBeenNthCalledWith(2, {
-    filePath: doc5,
-    link: './docNotExist2.mdx',
-    contentPaths: versionCurrent,
-  } as BrokenMarkdownLink);
-  expect(onBrokenMarkdownLink).toHaveBeenNthCalledWith(3, {
-    filePath: doc5,
-    link: '../docNotExist3.mdx',
-    contentPaths: versionCurrent,
-  } as BrokenMarkdownLink);
-  expect(onBrokenMarkdownLink).toHaveBeenNthCalledWith(4, {
-    filePath: doc5,
-    link: './subdir/docNotExist4.md',
-    contentPaths: versionCurrent,
-  } as BrokenMarkdownLink);
-});
-
-test('transforms absolute links in versioned docs', () => {
-  const doc2 = path.join(version100.contentPath, 'doc2.md');
-  const [content, transformedContent] = transform(doc2);
-  expect(transformedContent).toMatchSnapshot();
-  expect(transformedContent).toContain('](/docs/1.0.0/subdir/doc1');
-  expect(transformedContent).toContain('](/docs/1.0.0/doc2#existing-docs');
-  expect(transformedContent).not.toContain('](subdir/doc1.md)');
-  expect(transformedContent).not.toContain('](doc2.md#existing-docs)');
-  expect(content).not.toEqual(transformedContent);
-});
-
-test('transforms relative links in versioned docs', () => {
-  const doc1 = path.join(version100.contentPath, 'subdir', 'doc1.md');
-  const [content, transformedContent] = transform(doc1);
-  expect(transformedContent).toMatchSnapshot();
-  expect(transformedContent).toContain('](/docs/1.0.0/doc2');
-  expect(transformedContent).not.toContain('](../doc2.md)');
-  expect(content).not.toEqual(transformedContent);
-});

package/src/sidebars/__tests__/__fixtures__/sidebars/sidebars-category-shorthand.js

@@ -1,34 +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.
- */
-
-module.exports = {
-  docs: [
-    {
-      'level 1': [
-        'a',
-        {
-          'level 2': [
-            {
-              'level 3': [
-                'c',
-                {
-                  'level 4': [
-                    'd',
-                    {
-                      'deeper more more': ['e'],
-                    },
-                  ],
-                },
-              ],
-            },
-            'f',
-          ],
-        },
-      ],
-    },
-  ],
-};

package/src/sidebars/__tests__/__fixtures__/sidebars/sidebars-category-wrong-items.json

@@ -1,11 +0,0 @@
-{
-  "docs": {
-    "Test": [
-      {
-        "type": "category",
-        "label": "Category Label",
-        "items": "doc1"
-      }
-    ]
-  }
-}

package/src/sidebars/__tests__/__fixtures__/sidebars/sidebars-category-wrong-label.json

@@ -1,11 +0,0 @@
-{
-  "docs": {
-    "Test": [
-      {
-        "type": "category",
-        "label": true,
-        "items": ["doc1"]
-      }
-    ]
-  }
-}

package/src/sidebars/__tests__/__fixtures__/sidebars/sidebars-category.js

@@ -1,44 +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.
- */
-
-module.exports = {
-  docs: [
-    {
-      type: 'category',
-      label: 'level 1',
-      items: [
-        'a',
-        {
-          type: 'category',
-          label: 'level 2',
-          items: [
-            {
-              type: 'category',
-              label: 'level 3',
-              items: [
-                'c',
-                {
-                  type: 'category',
-                  label: 'level 4',
-                  items: [
-                    'd',
-                    {
-                      type: 'category',
-                      label: 'deeper more more',
-                      items: ['e'],
-                    },
-                  ],
-                },
-              ],
-            },
-            'f',
-          ],
-        },
-      ],
-    },
-  ],
-};

package/src/sidebars/__tests__/__fixtures__/sidebars/sidebars-collapsed-first-level.json

@@ -1,20 +0,0 @@
-{
-    "docs": [
-        {
-            "type": "category",
-            "label": "Introduction",
-            "items": [
-                "doc1"
-            ],
-            "collapsed": false
-        },
-        {
-            "type": "category",
-            "label": "Powering MDX",
-            "items": [
-                "doc2"
-            ],
-            "collapsed": false
-        }
-    ]
-}

package/src/sidebars/__tests__/__fixtures__/sidebars/sidebars-collapsed.json

@@ -1,21 +0,0 @@
-{
-    "docs": {
-      "Test": [
-        {
-          "type": "category",
-          "label": "Introduction",
-          "items": ["doc1"],
-          "collapsed": false
-        }
-      ],
-      "Reference": [
-        {
-          "type": "category",
-          "label": "Powering MDX",
-          "items": ["doc2"],
-          "collapsed": false
-        }
-      ]
-    }
-  }
-  

package/src/sidebars/__tests__/__fixtures__/sidebars/sidebars-doc-id-not-string.json

@@ -1,10 +0,0 @@
-{
-  "docs": {
-    "Test": [
-      {
-        "type": "doc",
-        "id": ["doc1"]
-      }
-    ]
-  }
-}

package/src/sidebars/__tests__/__fixtures__/sidebars/sidebars-first-level-not-category.js

@@ -1,20 +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.
- */
-
-module.exports = {
-  docs: [
-    {
-      type: 'category',
-      label: 'Getting Started',
-      items: ['greeting'],
-    },
-    {
-      type: 'doc',
-      id: 'api',
-    },
-  ],
-};

package/src/sidebars/__tests__/__fixtures__/sidebars/sidebars-link-wrong-href.json

@@ -1,11 +0,0 @@
-{
-  "docs": {
-    "Test": [
-      {
-        "type": "link",
-        "label": "GitHub",
-        "href": ["example.com"]
-      }
-    ]
-  }
-}

package/src/sidebars/__tests__/__fixtures__/sidebars/sidebars-link-wrong-label.json

@@ -1,11 +0,0 @@
-{
-  "docs": {
-    "Test": [
-      {
-        "type": "link",
-        "label": false,
-        "href": "https://github.com"
-      }
-    ]
-  }
-}

package/src/sidebars/__tests__/__fixtures__/sidebars/sidebars-link.json

@@ -1,11 +0,0 @@
-{
-  "docs": {
-    "Test": [
-      {
-        "type": "link",
-        "label": "category",
-        "href": "https://github.com"
-      }
-    ]
-  }
-}

package/src/sidebars/__tests__/__fixtures__/sidebars/sidebars-unknown-type.json

@@ -1,14 +0,0 @@
-{
-  "docs": {
-    "Test": [
-      "foo/bar",
-      "foo/baz",
-      {
-        "type": "superman"
-      }
-    ],
-    "Guides": [
-      "hello"
-    ]
-  }
-}

package/src/sidebars/__tests__/__fixtures__/sidebars/sidebars-wrong-field.json

@@ -1,20 +0,0 @@
-{
-  "docs": {
-    "Test": [
-      "foo/bar",
-      "foo/baz",
-      {
-        "type": "category",
-        "label": "category",
-        "href": "https://github.com"
-      },
-      {
-        "type": "ref",
-        "id": "hello"
-      }
-    ],
-    "Guides": [
-      "hello"
-    ]
-  }
-}

package/src/sidebars/__tests__/__fixtures__/sidebars/sidebars.json

@@ -1,20 +0,0 @@
-{
-  "docs": {
-    "Test": [
-      "foo/bar",
-      "foo/baz",
-      {
-        "type": "link",
-        "label": "Github",
-        "href": "https://github.com"
-      },
-      {
-        "type": "ref",
-        "id": "hello"
-      }
-    ],
-    "Guides": [
-      "hello"
-    ]
-  }
-}