feat(v2): rename functions and fix a corner case

facebook · Jun 12, 2020 · 17c7e3a · 17c7e3a
1 parent d0f1ff3
commit 17c7e3a
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 21 deletions.
diff --git a/packages/docusaurus-plugin-content-docs/src/__tests__/index.test.ts b/packages/docusaurus-plugin-content-docs/src/__tests__/index.test.ts
@@ -163,7 +163,7 @@ describe('simple website', () => {
       source: path.join('@site', pluginPath, 'hello.md'),
       title: 'Hello, World !',
       description: 'Hi, Endilie here :)',
-      latestPermalink: undefined,
+      latestVersionMainDocPermalink: undefined,
     });
 
     expect(docsMetadata['foo/bar']).toEqual({
@@ -177,7 +177,7 @@ describe('simple website', () => {
       source: path.join('@site', pluginPath, 'foo', 'bar.md'),
       title: 'Bar',
       description: 'This is custom description',
-      latestPermalink: undefined,
+      latestVersionMainDocPermalink: undefined,
     });
 
     expect(docsSidebars).toMatchSnapshot();
@@ -337,7 +337,7 @@ describe('versioned website', () => {
         title: 'bar',
         permalink: '/docs/foo/bar',
       },
-      latestPermalink: undefined,
+      latestVersionMainDocPermalink: undefined,
     });
     expect(docsMetadata['version-1.0.0/foo/baz']).toEqual({
       id: 'version-1.0.0/foo/baz',

diff --git a/packages/docusaurus-plugin-content-docs/src/__tests__/metadata.test.ts b/packages/docusaurus-plugin-content-docs/src/__tests__/metadata.test.ts
@@ -50,15 +50,15 @@ describe('simple site', () => {
       source: path.join('@site', routeBasePath, sourceA),
       title: 'Bar',
       description: 'This is custom description',
-      latestPermalink: undefined,
+      latestVersionMainDocPermalink: undefined,
     });
     expect(dataB).toEqual({
       id: 'hello',
       permalink: '/docs/hello',
       source: path.join('@site', routeBasePath, sourceB),
       title: 'Hello, World !',
       description: `Hi, Endilie here :)`,
-      latestPermalink: undefined,
+      latestVersionMainDocPermalink: undefined,
     });
   });
 
@@ -87,7 +87,7 @@ describe('simple site', () => {
       editUrl:
         'https://github.com/facebook/docusaurus/edit/master/website/docs/foo/baz.md',
       description: 'Images',
-      latestPermalink: undefined,
+      latestVersionMainDocPermalink: undefined,
     });
   });
 
@@ -112,7 +112,7 @@ describe('simple site', () => {
       title: 'lorem',
       editUrl: 'https://github.com/customUrl/docs/lorem.md',
       description: 'Lorem ipsum.',
-      latestPermalink: undefined,
+      latestVersionMainDocPermalink: undefined,
     });
 
     // unrelated frontmatter is not part of metadata
@@ -144,7 +144,7 @@ describe('simple site', () => {
       description: 'Lorem ipsum.',
       lastUpdatedAt: 1539502055,
       lastUpdatedBy: 'Author',
-      latestPermalink: undefined,
+      latestVersionMainDocPermalink: undefined,
     });
   });
 
@@ -173,7 +173,7 @@ describe('simple site', () => {
       description: 'Lorem ipsum.',
       lastUpdatedAt: 1539502055,
       lastUpdatedBy: 'Author',
-      latestPermalink: undefined,
+      latestVersionMainDocPermalink: undefined,
     });
   });
 

diff --git a/packages/docusaurus-plugin-content-docs/src/index.ts b/packages/docusaurus-plugin-content-docs/src/index.ts
@@ -65,10 +65,10 @@ const DEFAULT_OPTIONS: PluginOptions = {
   admonitions: {},
 };
 
-function getHrefFromSideBar(sidebarItems: DocsSidebarItem[]): string | null {
+function getFirstDocLinkOfSidebar(sidebarItems: DocsSidebarItem[]): string | null {
   for (let sidebarItem of sidebarItems) {
     if (sidebarItem.type === 'category') {
-      const url = getHrefFromSideBar(sidebarItem.items);
+      const url = getFirstDocLinkOfSidebar(sidebarItem.items);
       if (url) return url;
     } else {
       return sidebarItem.href;
@@ -472,17 +472,20 @@ Available document ids=
           Object.values(content.docsMetadata),
           'version',
         );
-        const rootUrl = options.homePageId
-          ? normalizeUrl([baseUrl, homePageDocsRoutePath])
-          : getHrefFromSideBar(
-              content.docsSidebars[`version-${versioning.latestVersion}/docs`],
-            );
+        const rootUrl =
+          options.homePageId && content.docsMetadata[options.homePageId]
+            ? content.docsMetadata[options.homePageId].permalink
+            : getFirstDocLinkOfSidebar(
+                content.docsSidebars[
+                  `version-${versioning.latestVersion}/docs`
+                ],
+              );
         if (!rootUrl) {
           throw new Error('Bad sidebars file. No document linked');
         }
         Object.values(content.docsMetadata).forEach((docMetadata) => {
           if (docMetadata.version !== versioning.latestVersion)
-            docMetadata.latestPermalink = rootUrl;
+            docMetadata.latestVersionMainDocPermalink = rootUrl;
         });
         await Promise.all(
           Object.keys(docsMetadataByVersion).map(async (version) => {

diff --git a/packages/docusaurus-plugin-content-docs/src/types.ts b/packages/docusaurus-plugin-content-docs/src/types.ts
@@ -118,7 +118,7 @@ export interface MetadataRaw extends LastUpdateData {
   sidebar_label?: string;
   editUrl?: string;
   version?: string;
-  latestPermalink?: string;
+  latestVersionMainDocPermalink?: string;
 }
 
 export interface Paginator {

diff --git a/packages/docusaurus-theme-classic/src/theme/DocItem/index.js b/packages/docusaurus-theme-classic/src/theme/DocItem/index.js
@@ -69,7 +69,7 @@ function DocItem(props) {
     lastUpdatedAt,
     lastUpdatedBy,
     version,
-    latestPermalink,
+    latestVersionMainDocPermalink,
   } = metadata;
   const {
     frontMatter: {
@@ -110,7 +110,7 @@ function DocItem(props) {
             className={clsx('col', {
               [styles.docItemCol]: !hideTableOfContents,
             })}>
-            {latestPermalink && (
+            {latestVersionMainDocPermalink && (
               <div
                 className="alert alert--warning margin-bottom--md"
                 role="alert">
@@ -129,7 +129,7 @@ function DocItem(props) {
                 <div className="margin-top--md">
                   For up-to-date documentation, see the{' '}
                   <strong>
-                    <Link to={latestPermalink}>latest version</Link>.
+                    <Link to={latestVersionMainDocPermalink}>latest version</Link>.
                   </strong>
                 </div>
               </div>