@docusaurus/plugin-content-docs 2.0.0-beta.1 → 2.0.0-beta.10

package/src/__tests__/index.test.ts

@@ -5,8 +5,6 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-/* eslint-disable @typescript-eslint/no-non-null-assertion */
-
 import path from 'path';
 import {isMatch} from 'picomatch';
 import commander from 'commander';
@@ -16,25 +14,23 @@ import fs from 'fs-extra';
 import pluginContentDocs from '../index';
 import {loadContext} from '@docusaurus/core/src/server/index';
 import {applyConfigureWebpack} from '@docusaurus/core/src/webpack/utils';
-import {RouteConfig} from '@docusaurus/types';
-import {posixPath} from '@docusaurus/utils';
+import type {RouteConfig} from '@docusaurus/types';
+import {posixPath, DEFAULT_PLUGIN_ID} from '@docusaurus/utils';
 import {sortConfig} from '@docusaurus/core/src/server/plugins';
-import {DEFAULT_PLUGIN_ID} from '@docusaurus/core/lib/constants';
 
 import * as cliDocs from '../cli';
 import {OptionsSchema} from '../options';
 import {normalizePluginOptions} from '@docusaurus/utils-validation';
-import {
-  DocMetadata,
-  LoadedVersion,
+import type {DocMetadata, LoadedVersion} from '../types';
+import type {
   SidebarItem,
   SidebarItemsGeneratorOption,
   SidebarItemsGeneratorOptionArgs,
-} from '../types';
+} from '../sidebars/types';
 import {toSidebarsProp} from '../props';
 
 import {validate} from 'webpack';
-import {DefaultSidebarItemsGenerator} from '../sidebarItemsGenerator';
+import {DefaultSidebarItemsGenerator} from '../sidebars/generator';
 import {DisabledSidebars} from '../sidebars';
 
 function findDocById(version: LoadedVersion, unversionedId: string) {
@@ -60,6 +56,7 @@ const defaultDocMetadata: Partial<DocMetadata> = {
   lastUpdatedAt: undefined,
   lastUpdatedBy: undefined,
   formattedLastUpdatedAt: undefined,
+  tags: [],
 };
 
 const createFakeActions = (contentDir: string) => {
@@ -105,9 +102,6 @@ Entries created:
         `version-${kebabCase(version.versionName)}-metadata-prop`,
       );
       expect(versionMetadataProp.docsSidebars).toEqual(toSidebarsProp(version));
-      expect(versionMetadataProp.permalinkToSidebar).toEqual(
-        version.permalinkToSidebar,
-      );
     },
 
     expectSnapshot: () => {
@@ -252,7 +246,6 @@ describe('simple website', () => {
       normalizePluginOptions(OptionsSchema, {
         path: 'docs',
         sidebarPath,
-        homePageId: 'hello',
       }),
     );
     const pluginContentDir = path.join(context.generatedFilesDir, plugin.name);
@@ -273,6 +266,8 @@ describe('simple website', () => {
     expect(mock).toHaveBeenCalledWith('1.0.0', siteDir, DEFAULT_PLUGIN_ID, {
       path: 'docs',
       sidebarPath,
+      sidebarCollapsed: true,
+      sidebarCollapsible: true,
     });
     mock.mockRestore();
   });
@@ -309,6 +304,8 @@ describe('simple website', () => {
   test('configureWebpack', async () => {
     const {plugin} = await loadSite();
 
+    const content = await plugin.loadContent?.();
+
     const config = applyConfigureWebpack(
       plugin.configureWebpack,
       {
@@ -319,6 +316,8 @@ describe('simple website', () => {
         },
       },
       false,
+      undefined,
+      content,
     );
     const errors = validate(config);
     expect(errors).toBeUndefined();
@@ -336,7 +335,6 @@ describe('simple website', () => {
       id: 'foo/baz',
       unversionedId: 'foo/baz',
       sourceDirName: 'foo',
-      isDocsHomePage: false,
       permalink: '/docs/foo/bazSlug.html',
       slug: '/foo/bazSlug.html',
       previous: {
@@ -344,10 +342,11 @@ describe('simple website', () => {
         permalink: '/docs/foo/bar',
       },
       next: {
-        title: 'Hello sidebar_label',
-        permalink: '/docs/',
+        title: 'rootAbsoluteSlug',
+        permalink: '/docs/rootAbsoluteSlug',
       },
       sidebar: 'docs',
+      sidebarPosition: undefined,
       source: path.posix.join(
         '@site',
         posixPath(path.relative(siteDir, currentVersion.contentPath)),
@@ -361,7 +360,23 @@ describe('simple website', () => {
         title: 'baz',
         slug: 'bazSlug.html',
         pagination_label: 'baz pagination_label',
+        tags: [
+          'tag 1',
+          'tag-1', // This one will be de-duplicated as it would lead to the same permalink as the first
+          {label: 'tag 2', permalink: 'tag2-custom-permalink'},
+        ],
       },
+
+      tags: [
+        {
+          label: 'tag 1',
+          permalink: '/docs/tags/tag-1',
+        },
+        {
+          label: 'tag 2',
+          permalink: '/docs/tags/tag2-custom-permalink',
+        },
+      ],
     });
 
     expect(findDocById(currentVersion, 'hello')).toEqual({
@@ -370,12 +385,11 @@ describe('simple website', () => {
       id: 'hello',
       unversionedId: 'hello',
       sourceDirName: '.',
-      isDocsHomePage: true,
       permalink: '/docs/',
       slug: '/',
       previous: {
-        title: 'baz pagination_label',
-        permalink: '/docs/foo/bazSlug.html',
+        title: 'My heading as title',
+        permalink: '/docs/headingAsTitle',
       },
       sidebar: 'docs',
       source: path.posix.join(
@@ -389,7 +403,19 @@ describe('simple website', () => {
         id: 'hello',
         title: 'Hello, World !',
         sidebar_label: 'Hello sidebar_label',
+        slug: '/',
+        tags: ['tag-1', 'tag 3'],
       },
+      tags: [
+        {
+          label: 'tag-1',
+          permalink: '/docs/tags/tag-1',
+        },
+        {
+          label: 'tag 3',
+          permalink: '/docs/tags/tag-3',
+        },
+      ],
     });
 
     expect(getDocById(currentVersion, 'foo/bar')).toEqual({
@@ -398,7 +424,6 @@ describe('simple website', () => {
       id: 'foo/bar',
       unversionedId: 'foo/bar',
       sourceDirName: 'foo',
-      isDocsHomePage: false,
       next: {
         title: 'baz pagination_label',
         permalink: '/docs/foo/bazSlug.html',
@@ -450,7 +475,6 @@ describe('versioned website', () => {
       normalizePluginOptions(OptionsSchema, {
         routeBasePath,
         sidebarPath,
-        homePageId: 'hello',
       }),
     );
     const pluginContentDir = path.join(context.generatedFilesDir, plugin.name);
@@ -477,6 +501,8 @@ describe('versioned website', () => {
     expect(mock).toHaveBeenCalledWith('2.0.0', siteDir, DEFAULT_PLUGIN_ID, {
       path: routeBasePath,
       sidebarPath,
+      sidebarCollapsed: true,
+      sidebarCollapsible: true,
     });
     mock.mockRestore();
   });
@@ -544,12 +570,8 @@ describe('versioned website', () => {
     const {siteDir, plugin, pluginContentDir} = await loadSite();
     const content = await plugin.loadContent!();
     expect(content.loadedVersions.length).toEqual(4);
-    const [
-      currentVersion,
-      version101,
-      version100,
-      versionWithSlugs,
-    ] = content.loadedVersions;
+    const [currentVersion, version101, version100, versionWithSlugs] =
+      content.loadedVersions;
 
     // foo/baz.md only exists in version -1.0.0
     expect(findDocById(currentVersion, 'foo/baz')).toBeUndefined();
@@ -561,7 +583,6 @@ describe('versioned website', () => {
       id: 'foo/bar',
       unversionedId: 'foo/bar',
       sourceDirName: 'foo',
-      isDocsHomePage: false,
       permalink: '/docs/next/foo/barSlug',
       slug: '/foo/barSlug',
       source: path.posix.join(
@@ -574,6 +595,11 @@ describe('versioned website', () => {
       description: 'This is next version of bar.',
       frontMatter: {
         slug: 'barSlug',
+        tags: [
+          'barTag 1',
+          'barTag-2',
+          {label: 'barTag 3', permalink: 'barTag-3-permalink'},
+        ],
       },
       version: 'current',
       sidebar: 'docs',
@@ -581,13 +607,42 @@ describe('versioned website', () => {
         title: 'hello',
         permalink: '/docs/next/',
       },
+      tags: [
+        {label: 'barTag 1', permalink: '/docs/next/tags/bar-tag-1'},
+        {label: 'barTag-2', permalink: '/docs/next/tags/bar-tag-2'},
+        {label: 'barTag 3', permalink: '/docs/next/tags/barTag-3-permalink'},
+      ],
+    });
+    expect(getDocById(version101, 'foo/bar')).toEqual({
+      ...defaultDocMetadata,
+      id: 'version-1.0.1/foo/bar',
+      unversionedId: 'foo/bar',
+      sourceDirName: 'foo',
+      permalink: '/docs/foo/bar',
+      slug: '/foo/bar',
+      source: path.posix.join(
+        '@site',
+        posixPath(path.relative(siteDir, version101.contentPath)),
+        'foo',
+        'bar.md',
+      ),
+      title: 'bar',
+      description: 'Bar 1.0.1 !',
+      frontMatter: {},
+      version: '1.0.1',
+      sidebar: 'VersionedSideBarNameDoesNotMatter/docs',
+      next: {
+        title: 'hello',
+        permalink: '/docs/',
+      },
+      tags: [],
     });
+
     expect(getDocById(currentVersion, 'hello')).toEqual({
       ...defaultDocMetadata,
       id: 'hello',
       unversionedId: 'hello',
       sourceDirName: '.',
-      isDocsHomePage: true,
       permalink: '/docs/next/',
       slug: '/',
       source: path.posix.join(
@@ -597,7 +652,9 @@ describe('versioned website', () => {
       ),
       title: 'hello',
       description: 'Hello next !',
-      frontMatter: {},
+      frontMatter: {
+        slug: '/',
+      },
       version: 'current',
       sidebar: 'docs',
       previous: {
@@ -610,7 +667,6 @@ describe('versioned website', () => {
       id: 'version-1.0.1/hello',
       unversionedId: 'hello',
       sourceDirName: '.',
-      isDocsHomePage: true,
       permalink: '/docs/',
       slug: '/',
       source: path.posix.join(
@@ -620,9 +676,11 @@ describe('versioned website', () => {
       ),
       title: 'hello',
       description: 'Hello 1.0.1 !',
-      frontMatter: {},
+      frontMatter: {
+        slug: '/',
+      },
       version: '1.0.1',
-      sidebar: 'version-1.0.1/docs',
+      sidebar: 'VersionedSideBarNameDoesNotMatter/docs',
       previous: {
         title: 'bar',
         permalink: '/docs/foo/bar',
@@ -633,7 +691,6 @@ describe('versioned website', () => {
       id: 'version-1.0.0/foo/baz',
       unversionedId: 'foo/baz',
       sourceDirName: 'foo',
-      isDocsHomePage: false,
       permalink: '/docs/1.0.0/foo/baz',
       slug: '/foo/baz',
       source: path.posix.join(
@@ -710,13 +767,8 @@ describe('versioned website (community)', () => {
   }
 
   test('extendCli - docsVersion', async () => {
-    const {
-      siteDir,
-      routeBasePath,
-      sidebarPath,
-      pluginId,
-      plugin,
-    } = await loadSite();
+    const {siteDir, routeBasePath, sidebarPath, pluginId, plugin} =
+      await loadSite();
     const mock = jest
       .spyOn(cliDocs, 'cliDocsVersionCommand')
       .mockImplementation();
@@ -728,6 +780,8 @@ describe('versioned website (community)', () => {
     expect(mock).toHaveBeenCalledWith('2.0.0', siteDir, pluginId, {
       path: routeBasePath,
       sidebarPath,
+      sidebarCollapsed: true,
+      sidebarCollapsible: true,
     });
     mock.mockRestore();
   });
@@ -784,7 +838,6 @@ describe('versioned website (community)', () => {
       id: 'team',
       unversionedId: 'team',
       sourceDirName: '.',
-      isDocsHomePage: false,
       permalink: '/community/next/team',
       slug: '/team',
       source:
@@ -800,7 +853,6 @@ describe('versioned website (community)', () => {
       id: 'version-1.0.0/team',
       unversionedId: 'team',
       sourceDirName: '.',
-      isDocsHomePage: false,
       permalink: '/community/team',
       slug: '/team',
       source: path.posix.join(
@@ -842,7 +894,6 @@ describe('site with doc label', () => {
       normalizePluginOptions(OptionsSchema, {
         path: 'docs',
         sidebarPath,
-        homePageId: 'hello-1',
       }),
     );
 
@@ -906,6 +957,7 @@ describe('site with full autogenerated sidebar', () => {
           type: 'category',
           label: 'Guides',
           collapsed: true,
+          collapsible: true,
           items: [
             {
               type: 'doc',
@@ -937,6 +989,7 @@ describe('site with full autogenerated sidebar', () => {
           type: 'category',
           label: 'API (label from _category_.json)',
           collapsed: true,
+          collapsible: true,
           items: [
             {
               type: 'doc',
@@ -946,6 +999,7 @@ describe('site with full autogenerated sidebar', () => {
               type: 'category',
               label: 'Core APIs',
               collapsed: true,
+              collapsible: true,
               items: [
                 {
                   type: 'doc',
@@ -962,6 +1016,7 @@ describe('site with full autogenerated sidebar', () => {
               type: 'category',
               label: 'Extension APIs (label from _category_.yml)',
               collapsed: true,
+              collapsible: true,
               items: [
                 {
                   type: 'doc',
@@ -983,7 +1038,7 @@ describe('site with full autogenerated sidebar', () => {
     });
   });
 
-  test('docs in fully generated sidebar have correct metadatas', async () => {
+  test('docs in fully generated sidebar have correct metadata', async () => {
     const {content, siteDir} = await loadSite();
     const version = content.loadedVersions[0];
 
@@ -992,7 +1047,6 @@ describe('site with full autogenerated sidebar', () => {
       id: 'getting-started',
       unversionedId: 'getting-started',
       sourceDirName: '.',
-      isDocsHomePage: false,
       permalink: '/docs/getting-started',
       slug: '/getting-started',
       source: path.posix.join(
@@ -1018,7 +1072,6 @@ describe('site with full autogenerated sidebar', () => {
       id: 'installation',
       unversionedId: 'installation',
       sourceDirName: '.',
-      isDocsHomePage: false,
       permalink: '/docs/installation',
       slug: '/installation',
       source: path.posix.join(
@@ -1047,7 +1100,6 @@ describe('site with full autogenerated sidebar', () => {
       id: 'Guides/guide1',
       unversionedId: 'Guides/guide1',
       sourceDirName: 'Guides',
-      isDocsHomePage: false,
       permalink: '/docs/Guides/guide1',
       slug: '/Guides/guide1',
       source: path.posix.join(
@@ -1080,7 +1132,6 @@ describe('site with full autogenerated sidebar', () => {
       id: 'Guides/guide2',
       unversionedId: 'Guides/guide2',
       sourceDirName: 'Guides',
-      isDocsHomePage: false,
       permalink: '/docs/Guides/guide2',
       slug: '/Guides/guide2',
       source: path.posix.join(
@@ -1112,7 +1163,6 @@ describe('site with full autogenerated sidebar', () => {
       id: 'Guides/guide2.5',
       unversionedId: 'Guides/guide2.5',
       sourceDirName: 'Guides',
-      isDocsHomePage: false,
       permalink: '/docs/Guides/guide2.5',
       slug: '/Guides/guide2.5',
       source: path.posix.join(
@@ -1145,7 +1195,6 @@ describe('site with full autogenerated sidebar', () => {
       id: 'Guides/guide3',
       unversionedId: 'Guides/guide3',
       sourceDirName: 'Guides',
-      isDocsHomePage: false,
       permalink: '/docs/Guides/guide3',
       slug: '/Guides/guide3',
       source: path.posix.join(
@@ -1178,7 +1227,6 @@ describe('site with full autogenerated sidebar', () => {
       id: 'Guides/guide4',
       unversionedId: 'Guides/guide4',
       sourceDirName: 'Guides',
-      isDocsHomePage: false,
       permalink: '/docs/Guides/guide4',
       slug: '/Guides/guide4',
       source: path.posix.join(
@@ -1210,7 +1258,6 @@ describe('site with full autogenerated sidebar', () => {
       id: 'Guides/guide5',
       unversionedId: 'Guides/guide5',
       sourceDirName: 'Guides',
-      isDocsHomePage: false,
       permalink: '/docs/Guides/guide5',
       slug: '/Guides/guide5',
       source: path.posix.join(
@@ -1242,7 +1289,6 @@ describe('site with full autogenerated sidebar', () => {
       id: 'API/api-overview',
       unversionedId: 'API/api-overview',
       sourceDirName: '3-API',
-      isDocsHomePage: false,
       permalink: '/docs/API/api-overview',
       slug: '/API/api-overview',
       source: path.posix.join(
@@ -1272,7 +1318,6 @@ describe('site with full autogenerated sidebar', () => {
       id: 'API/Core APIs/Client API',
       unversionedId: 'API/Core APIs/Client API',
       sourceDirName: '3-API/01_Core APIs',
-      isDocsHomePage: false,
       permalink: '/docs/API/Core APIs/Client API',
       slug: '/API/Core APIs/Client API',
       source: path.posix.join(
@@ -1303,7 +1348,6 @@ describe('site with full autogenerated sidebar', () => {
       id: 'API/Core APIs/Server API',
       unversionedId: 'API/Core APIs/Server API',
       sourceDirName: '3-API/01_Core APIs',
-      isDocsHomePage: false,
       permalink: '/docs/API/Core APIs/Server API',
       slug: '/API/Core APIs/Server API',
       source: path.posix.join(
@@ -1334,7 +1378,6 @@ describe('site with full autogenerated sidebar', () => {
       id: 'API/Extension APIs/Plugin API',
       unversionedId: 'API/Extension APIs/Plugin API',
       sourceDirName: '3-API/02_Extension APIs',
-      isDocsHomePage: false,
       permalink: '/docs/API/Extension APIs/Plugin API',
       slug: '/API/Extension APIs/Plugin API',
       source: path.posix.join(
@@ -1365,7 +1408,6 @@ describe('site with full autogenerated sidebar', () => {
       id: 'API/Extension APIs/Theme API',
       unversionedId: 'API/Extension APIs/Theme API',
       sourceDirName: '3-API/02_Extension APIs',
-      isDocsHomePage: false,
       permalink: '/docs/API/Extension APIs/Theme API',
       slug: '/API/Extension APIs/Theme API',
       source: path.posix.join(
@@ -1396,7 +1438,6 @@ describe('site with full autogenerated sidebar', () => {
       id: 'API/api-end',
       unversionedId: 'API/api-end',
       sourceDirName: '3-API',
-      isDocsHomePage: false,
       permalink: '/docs/API/api-end',
       slug: '/API/api-end',
       source: path.posix.join(
@@ -1460,6 +1501,7 @@ describe('site with partial autogenerated sidebars', () => {
           type: 'category',
           label: 'Some category',
           collapsed: true,
+          collapsible: true,
           items: [
             {
               type: 'doc',
@@ -1479,18 +1521,17 @@ describe('site with partial autogenerated sidebars', () => {
     });
   });
 
-  test('docs in partially generated sidebar have correct metadatas', async () => {
+  test('docs in partially generated sidebar have correct metadata', async () => {
     const {content, siteDir} = await loadSite();
     const version = content.loadedVersions[0];
 
-    // Only looking at the docs of the autogen sidebar, others metadatas should not be affected
+    // Only looking at the docs of the autogen sidebar, others metadata should not be affected
 
     expect(getDocById(version, 'API/api-end')).toEqual({
       ...defaultDocMetadata,
       id: 'API/api-end',
       unversionedId: 'API/api-end',
       sourceDirName: '3-API',
-      isDocsHomePage: false,
       permalink: '/docs/API/api-end',
       slug: '/API/api-end',
       source: path.posix.join(
@@ -1517,7 +1558,6 @@ describe('site with partial autogenerated sidebars', () => {
       id: 'API/api-overview',
       unversionedId: 'API/api-overview',
       sourceDirName: '3-API',
-      isDocsHomePage: false,
       permalink: '/docs/API/api-overview',
       slug: '/API/api-overview',
       source: path.posix.join(
@@ -1547,7 +1587,6 @@ describe('site with partial autogenerated sidebars', () => {
       id: 'API/Extension APIs/Plugin API',
       unversionedId: 'API/Extension APIs/Plugin API',
       sourceDirName: '3-API/02_Extension APIs',
-      isDocsHomePage: false,
       permalink: '/docs/API/Extension APIs/Plugin API',
       slug: '/API/Extension APIs/Plugin API',
       source: path.posix.join(
@@ -1578,7 +1617,6 @@ describe('site with partial autogenerated sidebars', () => {
       id: 'API/Extension APIs/Theme API',
       unversionedId: 'API/Extension APIs/Theme API',
       sourceDirName: '3-API/02_Extension APIs',
-      isDocsHomePage: false,
       permalink: '/docs/API/Extension APIs/Theme API',
       slug: '/API/Extension APIs/Theme API',
       source: path.posix.join(
@@ -1649,6 +1687,7 @@ describe('site with partial autogenerated sidebars 2 (fix #4638)', () => {
           type: 'category',
           label: 'Core APIs',
           collapsed: true,
+          collapsible: true,
           items: [
             {
               type: 'doc',
@@ -1665,6 +1704,7 @@ describe('site with partial autogenerated sidebars 2 (fix #4638)', () => {
           type: 'category',
           label: 'Extension APIs (label from _category_.yml)', // Fix #4638
           collapsed: true,
+          collapsible: true,
           items: [
             {
               type: 'doc',
@@ -1734,12 +1774,11 @@ describe('site with custom sidebar items generator', () => {
   });
 
   test('sidebar is autogenerated according to a custom sidebarItemsGenerator', async () => {
-    const customSidebarItemsGenerator: SidebarItemsGeneratorOption = async () => {
-      return [
+    const customSidebarItemsGenerator: SidebarItemsGeneratorOption =
+      async () => [
         {type: 'doc', id: 'API/api-overview'},
         {type: 'doc', id: 'API/api-end'},
       ];
-    };
 
     const {content} = await loadSite(customSidebarItemsGenerator);
     const version = content.loadedVersions[0];
@@ -1781,6 +1820,7 @@ describe('site with custom sidebar items generator', () => {
           type: 'category',
           label: 'API (label from _category_.json)',
           collapsed: true,
+          collapsible: true,
           items: [
             {
               type: 'doc',
@@ -1790,6 +1830,7 @@ describe('site with custom sidebar items generator', () => {
               type: 'category',
               label: 'Extension APIs (label from _category_.yml)',
               collapsed: true,
+              collapsible: true,
               items: [
                 {
                   type: 'doc',
@@ -1805,6 +1846,7 @@ describe('site with custom sidebar items generator', () => {
               type: 'category',
               label: 'Core APIs',
               collapsed: true,
+              collapsible: true,
               items: [
                 {
                   type: 'doc',
@@ -1826,6 +1868,7 @@ describe('site with custom sidebar items generator', () => {
           type: 'category',
           label: 'Guides',
           collapsed: true,
+          collapsible: true,
           items: [
             {
               type: 'doc',

package/src/__tests__/lastUpdate.test.ts

@@ -31,15 +31,16 @@ describe('lastUpdate', () => {
   test('non-existing file', async () => {
     const consoleMock = jest.spyOn(console, 'error');
     consoleMock.mockImplementation();
+    const nonExistingFileName = '.nonExisting';
     const nonExistingFilePath = path.join(
       __dirname,
       '__fixtures__',
-      '.nonExisting',
+      nonExistingFileName,
     );
     expect(await getFileLastUpdate(nonExistingFilePath)).toBeNull();
     expect(consoleMock).toHaveBeenCalledTimes(1);
     expect(consoleMock.mock.calls[0][0].message).toContain(
-      `Command failed with exit code 128: git log -1 --format=%ct, %an ${nonExistingFilePath}`,
+      ' with exit code 128',
     );
     expect(await getFileLastUpdate(null)).toBeNull();
     expect(await getFileLastUpdate(undefined)).toBeNull();