From d72f760e4df57e66e9b3d679e7db4d387e8abd93 Mon Sep 17 00:00:00 2001
From: Alexey Pyltsyn <lex61rus@gmail.com>
Date: Wed, 2 Jun 2021 17:52:41 +0300
Subject: [PATCH] refactor(v2): remove sidebar_label filed from doc metadata
 file (#4863)

---
 .../src/__tests__/docs.test.ts                              | 3 +--
 .../src/__tests__/index.test.ts                             | 1 -
 packages/docusaurus-plugin-content-docs/src/docs.ts         | 2 --
 packages/docusaurus-plugin-content-docs/src/props.ts        | 6 +++++-
 packages/docusaurus-plugin-content-docs/src/types.ts        | 1 -
 5 files changed, 6 insertions(+), 7 deletions(-)

diff --git a/packages/docusaurus-plugin-content-docs/src/__tests__/docs.test.ts b/packages/docusaurus-plugin-content-docs/src/__tests__/docs.test.ts
index bbfb3b1043..72a8696b4b 100644
--- a/packages/docusaurus-plugin-content-docs/src/__tests__/docs.test.ts
+++ b/packages/docusaurus-plugin-content-docs/src/__tests__/docs.test.ts
@@ -76,7 +76,7 @@ function createTestUtils({
     docFileSource: string,
     expectedMetadata: Optional<
       DocMetadataBase,
-      'source' | 'lastUpdatedBy' | 'lastUpdatedAt' | 'sidebar_label' | 'editUrl'
+      'source' | 'lastUpdatedBy' | 'lastUpdatedAt' | 'editUrl'
     >,
   ) {
     const docFile = await readDoc(docFileSource);
@@ -89,7 +89,6 @@ function createTestUtils({
     expect(metadata).toEqual({
       lastUpdatedBy: undefined,
       lastUpdatedAt: undefined,
-      sidebar_label: undefined,
       editUrl: undefined,
       source: path.posix.join(
         '@site',
diff --git a/packages/docusaurus-plugin-content-docs/src/__tests__/index.test.ts b/packages/docusaurus-plugin-content-docs/src/__tests__/index.test.ts
index 9a52d0d7e7..3bd8944ed6 100644
--- a/packages/docusaurus-plugin-content-docs/src/__tests__/index.test.ts
+++ b/packages/docusaurus-plugin-content-docs/src/__tests__/index.test.ts
@@ -57,7 +57,6 @@ const defaultDocMetadata: Partial<DocMetadata> = {
   editUrl: undefined,
   lastUpdatedAt: undefined,
   lastUpdatedBy: undefined,
-  sidebar_label: undefined,
   formattedLastUpdatedAt: undefined,
 };
 
diff --git a/packages/docusaurus-plugin-content-docs/src/docs.ts b/packages/docusaurus-plugin-content-docs/src/docs.ts
index 7e515c6bc6..12809041a8 100644
--- a/packages/docusaurus-plugin-content-docs/src/docs.ts
+++ b/packages/docusaurus-plugin-content-docs/src/docs.ts
@@ -125,7 +125,6 @@ export function processDocMetadata({
   const frontMatter = validateDocFrontMatter(unsafeFrontMatter);
 
   const {
-    sidebar_label: sidebarLabel,
     custom_edit_url: customEditURL,
 
     // Strip number prefixes by default (01-MyFolder/01-MyDoc.md => MyFolder/MyDoc) by default,
@@ -261,7 +260,6 @@ export function processDocMetadata({
           lastUpdate.lastUpdatedAt * 1000,
         )
       : undefined,
-    sidebar_label: sidebarLabel,
     sidebarPosition,
     frontMatter,
   };
diff --git a/packages/docusaurus-plugin-content-docs/src/props.ts b/packages/docusaurus-plugin-content-docs/src/props.ts
index 2e7781daa8..9908f67902 100644
--- a/packages/docusaurus-plugin-content-docs/src/props.ts
+++ b/packages/docusaurus-plugin-content-docs/src/props.ts
@@ -33,7 +33,11 @@ Available document ids=
       );
     }
 
-    const {title, permalink, sidebar_label: sidebarLabel} = docMetadata;
+    const {
+      title,
+      permalink,
+      frontMatter: {sidebar_label: sidebarLabel},
+    } = docMetadata;
 
     return {
       type: 'link',
diff --git a/packages/docusaurus-plugin-content-docs/src/types.ts b/packages/docusaurus-plugin-content-docs/src/types.ts
index cee48a6e5e..1ae535e2e3 100644
--- a/packages/docusaurus-plugin-content-docs/src/types.ts
+++ b/packages/docusaurus-plugin-content-docs/src/types.ts
@@ -198,7 +198,6 @@ export type DocMetadataBase = LastUpdateData & {
   slug: string;
   permalink: string;
   // eslint-disable-next-line camelcase
-  sidebar_label?: string;
   sidebarPosition?: number;
   editUrl?: string | null;
   frontMatter: FrontMatter;