WIP refactor

facebook · Feb 4, 2022 · 321dcfe · 321dcfe
1 parent a5db12b
commit 321dcfe
Show file tree

Hide file tree

Showing 8 changed files with 26 additions and 40 deletions.
diff --git a/packages/docusaurus-plugin-content-docs/src/__tests__/options.test.ts b/packages/docusaurus-plugin-content-docs/src/__tests__/options.test.ts
@@ -56,6 +56,7 @@ describe('normalizeDocsPluginOptions', () => {
       rehypePlugins: [markdownPluginsFunctionStub],
       beforeDefaultRehypePlugins: [],
       beforeDefaultRemarkPlugins: [],
+      breadcrumbs: 'nested',
       showLastUpdateTime: true,
       showLastUpdateAuthor: true,
       admonitions: {},

diff --git a/packages/docusaurus-plugin-content-docs/src/options.ts b/packages/docusaurus-plugin-content-docs/src/options.ts
@@ -55,6 +55,7 @@ export const DEFAULT_OPTIONS: Omit<PluginOptions, 'id' | 'sidebarPath'> = {
   editLocalizedFiles: false,
   sidebarCollapsible: true,
   sidebarCollapsed: true,
+  breadcrumbs: 'nested',
 };
 
 const VersionOptionsSchema = Joi.object({
@@ -139,6 +140,10 @@ export const OptionsSchema = Joi.object({
   disableVersioning: Joi.bool().default(DEFAULT_OPTIONS.disableVersioning),
   lastVersion: Joi.string().optional(),
   versions: VersionsOptionsSchema,
+  breadcrumbs: Joi.alternatives(
+    Joi.bool(),
+    Joi.string().valid('nested'),
+  ).default(DEFAULT_OPTIONS.breadcrumbs),
 });
 
 export function validateOptions({

diff --git a/packages/docusaurus-plugin-content-docs/src/plugin-content-docs.d.ts b/packages/docusaurus-plugin-content-docs/src/plugin-content-docs.d.ts
@@ -38,6 +38,7 @@ declare module '@docusaurus/plugin-content-docs' {
     showLastUpdateTime?: boolean;
     showLastUpdateAuthor?: boolean;
     numberPrefixParser: NumberPrefixParser;
+    breadcrumbs: boolean | 'nested';
   };
 
   export type PathOptions = {

diff --git a/packages/docusaurus-theme-classic/src/__tests__/validateThemeConfig.test.ts b/packages/docusaurus-theme-classic/src/__tests__/validateThemeConfig.test.ts
@@ -701,14 +701,4 @@ describe('themeConfig tableOfContents', () => {
       `"\\"tableOfContents.minHeadingLevel\\" must be less than or equal to ref:maxHeadingLevel"`,
     );
   });
-
-  test('should accept nested breadcrumb config', () => {
-    const breadcrumbConfig = {
-      breadcrumbs: 'nested',
-    };
-    expect(testValidateThemeConfig(breadcrumbConfig)).toEqual({
-      ...DEFAULT_CONFIG,
-      ...breadcrumbConfig,
-    });
-  });
 });
diff --git a/packages/docusaurus-theme-classic/src/theme/DocBreadcrumbs/index.tsx b/packages/docusaurus-theme-classic/src/theme/DocBreadcrumbs/index.tsx
@@ -7,37 +7,35 @@
 
 import React from 'react';
 import {
-  isSamePath,
+  // isSamePath,
   ThemeClassNames,
   useSidebarBreadcrumbs,
-  useThemeConfig,
 } from '@docusaurus/theme-common';
 import styles from './styles.module.css';
 import clsx from 'clsx';
-import {useLocation} from '@docusaurus/router';
-import type {PropSidebar} from '@docusaurus/plugin-content-docs';
+// import {useLocation} from '@docusaurus/router';
+// import type {PropSidebar} from '@docusaurus/plugin-content-docs';
 
 export default function DocBreadcrumbs(): JSX.Element | null {
-  const {pathname} = useLocation();
+  // const {pathname} = useLocation();
   const breadcrumbs = useSidebarBreadcrumbs();
-  const {breadcrumbs: enabled} = useThemeConfig();
 
-  function isExact(items: PropSidebar) {
-    const singleItem = items[0];
-    return (
-      items.length === 1 &&
-      singleItem.type === 'link' &&
-      isSamePath(singleItem.href, pathname)
-    );
-  }
+  // function isExact(items: PropSidebar) {
+  //   const singleItem = items[0];
+  //   return (
+  //     items.length === 1 &&
+  //     singleItem.type === 'link' &&
+  //     isSamePath(singleItem.href, pathname)
+  //   );
+  // }
 
-  if (
-    !breadcrumbs.length ||
-    enabled === false ||
-    (enabled === 'nested' && isExact(breadcrumbs))
-  ) {
-    return null;
-  }
+  // if (
+  //   !breadcrumbs.length ||
+  //   enabled === false ||
+  //   (enabled === 'nested' && isExact(breadcrumbs))
+  // ) {
+  //   return null;
+  // }
 
   return (
     <nav

diff --git a/packages/docusaurus-theme-classic/src/validateThemeConfig.ts b/packages/docusaurus-theme-classic/src/validateThemeConfig.ts
@@ -46,7 +46,6 @@ const DEFAULT_CONFIG = {
     minHeadingLevel: 2,
     maxHeadingLevel: 3,
   },
-  breadcrumbs: 'nested',
 };
 
 const NavbarItemPosition = Joi.string().equal('left', 'right').default('left');
@@ -381,10 +380,6 @@ const ThemeConfigSchema = Joi.object({
       .max(6)
       .default(DEFAULT_CONFIG.tableOfContents.maxHeadingLevel),
   }).default(DEFAULT_CONFIG.tableOfContents),
-  breadcrumbs: Joi.alternatives(
-    Joi.bool(),
-    Joi.string().valid('nested'),
-  ).default(DEFAULT_CONFIG.breadcrumbs),
 });
 
 export {DEFAULT_CONFIG, ThemeConfigSchema};

diff --git a/packages/docusaurus-theme-common/src/utils/docsUtils.tsx b/packages/docusaurus-theme-common/src/utils/docsUtils.tsx
@@ -190,7 +190,6 @@ export function useSidebarBreadcrumbs(): PropSidebar {
   const breadcrumbs: PropSidebar = [];
 
   function extract(items: PropSidebar) {
-    // eslint-disable-next-line no-restricted-syntax
     for (const item of items) {
       if (item.type === 'category' && extract(item.items)) {
         breadcrumbs.push(item);

diff --git a/packages/docusaurus-theme-common/src/utils/useThemeConfig.ts b/packages/docusaurus-theme-common/src/utils/useThemeConfig.ts
@@ -105,8 +105,6 @@ export type TableOfContents = {
   maxHeadingLevel: number;
 };
 
-export type Breadcrumbs = boolean | 'nested';
-
 // Theme config after validation/normalization
 export type ThemeConfig = {
   docs: {
@@ -129,7 +127,6 @@ export type ThemeConfig = {
   metadata: Array<Record<string, string>>;
   sidebarCollapsible: boolean;
   tableOfContents: TableOfContents;
-  breadcrumbs: Breadcrumbs;
 };
 
 // User-provided theme config, unnormalized