@docusaurus/theme-classic 2.0.0-beta.15d451942 → 2.0.0-beta.18

package/src/translations.ts

@@ -5,40 +5,42 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import {TranslationFile, TranslationFileContent} from '@docusaurus/types';
-import {
+import type {TranslationFile, TranslationFileContent} from '@docusaurus/types';
+import type {
   ThemeConfig,
   Navbar,
   NavbarItem,
   Footer,
+  MultiColumnFooter,
+  SimpleFooter,
 } from '@docusaurus/theme-common';
 
-import {keyBy, chain, flatten} from 'lodash';
+import _ from 'lodash';
 import {mergeTranslations} from '@docusaurus/utils';
 
 function getNavbarTranslationFile(navbar: Navbar): TranslationFileContent {
   // TODO handle properly all the navbar item types here!
   function flattenNavbarItems(items: NavbarItem[]): NavbarItem[] {
-    const subItems = flatten(
-      items.map((item) => {
-        const allSubItems = flatten([item.items ?? []]);
-        return flattenNavbarItems(allSubItems);
-      }),
-    );
+    const subItems = items.flatMap((item) => {
+      const allSubItems = [item.items ?? []].flat();
+      return flattenNavbarItems(allSubItems);
+    });
     return [...items, ...subItems];
   }
 
   const allNavbarItems = flattenNavbarItems(navbar.items);
 
-  const navbarItemsTranslations: TranslationFileContent = chain(
-    allNavbarItems.filter((navbarItem) => !!navbarItem.label),
-  )
-    .keyBy((navbarItem) => `item.label.${navbarItem.label}`)
-    .mapValues((navbarItem) => ({
-      message: navbarItem.label!,
-      description: `Navbar item with label ${navbarItem.label}`,
-    }))
-    .value();
+  const navbarItemsTranslations: TranslationFileContent = Object.fromEntries(
+    allNavbarItems
+      .filter((navbarItem) => navbarItem.label)
+      .map((navbarItem) => [
+        `item.label.${navbarItem.label}`,
+        {
+          message: navbarItem.label!,
+          description: `Navbar item with label ${navbarItem.label}`,
+        },
+      ]),
+  );
 
   const titleTranslations: TranslationFileContent = navbar.title
     ? {title: {message: navbar.title, description: 'The title in the navbar'}}
@@ -48,8 +50,11 @@ function getNavbarTranslationFile(navbar: Navbar): TranslationFileContent {
 }
 function translateNavbar(
   navbar: Navbar,
-  navbarTranslations: TranslationFileContent,
+  navbarTranslations: TranslationFileContent | undefined,
 ): Navbar {
+  if (!navbarTranslations) {
+    return navbar;
+  }
   return {
     ...navbar,
     title: navbarTranslations.title?.message ?? navbar.title,
@@ -71,31 +76,40 @@ function translateNavbar(
   };
 }
 
+function isMultiColumnFooterLinks(
+  links: MultiColumnFooter['links'] | SimpleFooter['links'],
+): links is MultiColumnFooter['links'] {
+  return links.length > 0 && 'title' in links[0]!;
+}
+
 function getFooterTranslationFile(footer: Footer): TranslationFileContent {
-  // TODO POC code
-  const footerLinkTitles: TranslationFileContent = chain(
-    footer.links.filter((link) => !!link.title),
-  )
-    .keyBy((link) => `link.title.${link.title}`)
-    .mapValues((link) => ({
-      message: link.title!,
-      description: `The title of the footer links column with title=${link.title} in the footer`,
-    }))
-    .value();
-
-  const footerLinkLabels: TranslationFileContent = chain(
-    flatten(footer.links.map((link) => link.items)).filter(
-      (link) => !!link.label,
-    ),
-  )
-    .keyBy((linkItem) => `link.item.label.${linkItem.label}`)
-    .mapValues((linkItem) => ({
-      message: linkItem.label!,
-      description: `The label of footer link with label=${
-        linkItem.label
-      } linking to ${linkItem.to ?? linkItem.href}`,
-    }))
-    .value();
+  const footerLinkTitles: TranslationFileContent = Object.fromEntries(
+    (isMultiColumnFooterLinks(footer.links)
+      ? footer.links.filter((link) => link.title)
+      : []
+    ).map((link) => [
+      `link.title.${link.title}`,
+      {
+        message: link.title!,
+        description: `The title of the footer links column with title=${link.title} in the footer`,
+      },
+    ]),
+  );
+
+  const footerLinkLabels: TranslationFileContent = Object.fromEntries(
+    (isMultiColumnFooterLinks(footer.links)
+      ? footer.links.flatMap((link) => link.items).filter((link) => link.label)
+      : footer.links.filter((link) => link.label)
+    ).map((link) => [
+      `link.item.label.${link.label}`,
+      {
+        message: link.label!,
+        description: `The label of footer link with label=${
+          link.label
+        } linking to ${link.to ?? link.href}`,
+      },
+    ]),
+  );
 
   const copyright: TranslationFileContent = footer.copyright
     ? {
@@ -110,19 +124,29 @@ function getFooterTranslationFile(footer: Footer): TranslationFileContent {
 }
 function translateFooter(
   footer: Footer,
-  footerTranslations: TranslationFileContent,
+  footerTranslations: TranslationFileContent | undefined,
 ): Footer {
-  const links = footer.links.map((link) => ({
-    ...link,
-    title:
-      footerTranslations[`link.title.${link.title}`]?.message ?? link.title,
-    items: link.items.map((linkItem) => ({
-      ...linkItem,
-      label:
-        footerTranslations[`link.item.label.${linkItem.label}`]?.message ??
-        linkItem.label,
-    })),
-  }));
+  if (!footerTranslations) {
+    return footer;
+  }
+  const links = isMultiColumnFooterLinks(footer.links)
+    ? footer.links.map((link) => ({
+        ...link,
+        title:
+          footerTranslations[`link.title.${link.title}`]?.message ?? link.title,
+        items: link.items.map((linkItem) => ({
+          ...linkItem,
+          label:
+            footerTranslations[`link.item.label.${linkItem.label}`]?.message ??
+            linkItem.label,
+        })),
+      }))
+    : footer.links.map((link) => ({
+        ...link,
+        label:
+          footerTranslations[`link.item.label.${link.label}`]?.message ??
+          link.label,
+      }));
 
   const copyright = footerTranslations.copyright?.message ?? footer.copyright;
 
@@ -155,10 +179,12 @@ export function translateThemeConfig({
   themeConfig,
   translationFiles,
 }: {
+  // To make TS correctly figure out the contravariance in parameter.
+  // In practice it's always normalized
   themeConfig: ThemeConfig;
   translationFiles: TranslationFile[];
 }): ThemeConfig {
-  const translationFilesMap: Record<string, TranslationFile> = keyBy(
+  const translationFilesMap: {[fileName: string]: TranslationFile} = _.keyBy(
     translationFiles,
     (f) => f.path,
   );
@@ -167,10 +193,10 @@ export function translateThemeConfig({
     ...themeConfig,
     navbar: translateNavbar(
       themeConfig.navbar,
-      translationFilesMap.navbar.content,
+      translationFilesMap.navbar?.content,
     ),
     footer: themeConfig.footer
-      ? translateFooter(themeConfig.footer, translationFilesMap.footer.content)
+      ? translateFooter(themeConfig.footer, translationFilesMap.footer?.content)
       : undefined,
   };
 }