Rename isDraft to draft

facebook · Apr 4, 2022 · 3baa532 · 3baa532
1 parent 3f79f5f
commit 3baa532
Show file tree

Hide file tree

Showing 10 changed files with 109 additions and 112 deletions.
diff --git a/packages/docusaurus-plugin-content-docs/src/__tests__/__snapshots__/index.test.ts.snap b/packages/docusaurus-plugin-content-docs/src/__tests__/__snapshots__/index.test.ts.snap
diff --git a/packages/docusaurus-plugin-content-docs/src/__tests__/docs.test.ts b/packages/docusaurus-plugin-content-docs/src/__tests__/docs.test.ts
@@ -241,7 +241,7 @@ describe('simple site', () => {
         pagination_prev: null,
       },
       tags: [],
-      isDraft: false,
+      draft: false,
     });
     await defaultTestUtils.testMeta(path.join('hello.md'), {
       version: 'current',
@@ -269,7 +269,7 @@ describe('simple site', () => {
           permalink: '/docs/tags/tag-3',
         },
       ],
-      isDraft: false,
+      draft: false,
     });
   });
 
@@ -319,7 +319,7 @@ describe('simple site', () => {
           permalink: '/docs/tags/tag2-custom-permalink',
         },
       ],
-      isDraft: false,
+      draft: false,
     });
   });
 
@@ -341,7 +341,7 @@ describe('simple site', () => {
         unrelated_front_matter: "won't be part of metadata",
       },
       tags: [],
-      isDraft: false,
+      draft: false,
     });
   });
 
@@ -394,7 +394,7 @@ describe('simple site', () => {
           permalink: '/docs/tags/tag2-custom-permalink',
         },
       ],
-      isDraft: false,
+      draft: false,
     });
 
     expect(editUrlFunction).toHaveBeenCalledTimes(1);
@@ -440,7 +440,7 @@ describe('simple site', () => {
       formattedLastUpdatedAt: '10/14/2018',
       lastUpdatedBy: 'Author',
       tags: [],
-      isDraft: false,
+      draft: false,
     });
   });
 
@@ -465,7 +465,7 @@ describe('simple site', () => {
         draft: true,
       },
       tags: [],
-      isDraft: true,
+      draft: true,
     });
   });
 
@@ -649,7 +649,7 @@ describe('versioned site', () => {
           permalink: '/docs/next/tags/barTag-3-permalink',
         },
       ],
-      isDraft: false,
+      draft: false,
     });
     await currentVersionTestUtils.testMeta(path.join('hello.md'), {
       id: 'hello',
@@ -664,7 +664,7 @@ describe('versioned site', () => {
         slug: '/',
       },
       tags: [],
-      isDraft: false,
+      draft: false,
     });
   });
 
@@ -682,7 +682,7 @@ describe('versioned site', () => {
       frontMatter: {slug: 'barSlug'},
       version: '1.0.0',
       tags: [],
-      isDraft: false,
+      draft: false,
     });
     await version100TestUtils.testMeta(path.join('hello.md'), {
       id: 'version-1.0.0/hello',
@@ -699,7 +699,7 @@ describe('versioned site', () => {
       source:
         '@site/i18n/en/docusaurus-plugin-content-docs/version-1.0.0/hello.md',
       tags: [],
-      isDraft: false,
+      draft: false,
     });
     await version101TestUtils.testMeta(path.join('foo', 'bar.md'), {
       id: 'version-1.0.1/foo/bar',
@@ -712,7 +712,7 @@ describe('versioned site', () => {
       version: '1.0.1',
       frontMatter: {},
       tags: [],
-      isDraft: false,
+      draft: false,
     });
     await version101TestUtils.testMeta(path.join('hello.md'), {
       id: 'version-1.0.1/hello',
@@ -727,7 +727,7 @@ describe('versioned site', () => {
         slug: '/',
       },
       tags: [],
-      isDraft: false,
+      draft: false,
     });
   });
 
@@ -824,7 +824,7 @@ describe('versioned site', () => {
         '@site/i18n/en/docusaurus-plugin-content-docs/version-1.0.0/hello.md',
       editUrl: hardcodedEditUrl,
       tags: [],
-      isDraft: false,
+      draft: false,
     });
 
     expect(editUrlFunction).toHaveBeenCalledTimes(1);
@@ -869,7 +869,7 @@ describe('versioned site', () => {
       editUrl:
         'https://github.com/facebook/docusaurus/edit/main/website/versioned_docs/version-1.0.0/hello.md',
       tags: [],
-      isDraft: false,
+      draft: false,
     });
   });
 
@@ -905,7 +905,7 @@ describe('versioned site', () => {
       editUrl:
         'https://github.com/facebook/docusaurus/edit/main/website/docs/hello.md',
       tags: [],
-      isDraft: false,
+      draft: false,
     });
   });
 
@@ -942,7 +942,7 @@ describe('versioned site', () => {
       editUrl:
         'https://github.com/facebook/docusaurus/edit/main/website/i18n/fr/docusaurus-plugin-content-docs/version-1.0.0/hello.md',
       tags: [],
-      isDraft: false,
+      draft: false,
     });
   });
 
@@ -980,7 +980,7 @@ describe('versioned site', () => {
       editUrl:
         'https://github.com/facebook/docusaurus/edit/main/website/i18n/fr/docusaurus-plugin-content-docs/current/hello.md',
       tags: [],
-      isDraft: false,
+      draft: false,
     });
   });
 });

diff --git a/packages/docusaurus-plugin-content-docs/src/docs.ts b/packages/docusaurus-plugin-content-docs/src/docs.ts
@@ -131,7 +131,7 @@ function doProcessDocMetadata({
   } = parseMarkdownString(content);
   const frontMatter = validateDocFrontMatter(unsafeFrontMatter);
 
-  const isDraft =
+  const draft =
     (frontMatter.draft && process.env.NODE_ENV === 'production') || false;
 
   const {
@@ -263,7 +263,7 @@ function doProcessDocMetadata({
       : undefined,
     sidebarPosition,
     frontMatter,
-    isDraft,
+    draft,
   };
 }
 

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
@@ -407,7 +407,7 @@ declare module '@docusaurus/plugin-content-docs' {
     /** Front matter, as-is. */
     frontMatter: DocFrontMatter & {[key: string]: unknown};
     /** Is the doc going to be excluded from production builds? */
-    isDraft: boolean;
+    draft: boolean;
   };
 
   export type DocMetadata = DocMetadataBase &

diff --git a/packages/docusaurus-plugin-content-docs/src/routes.ts b/packages/docusaurus-plugin-content-docs/src/routes.ts
@@ -71,7 +71,7 @@ export async function createDocRoutes({
 }): Promise<RouteConfig[]> {
   return Promise.all(
     docs
-      .filter((metadataItem) => !metadataItem.isDraft)
+      .filter((metadataItem) => !metadataItem.draft)
       .map(async (metadataItem) => {
         await actions.createData(
           // Note that this created data path must be in sync with

diff --git a/packages/docusaurus-plugin-content-docs/src/sidebars/__tests__/generator.test.ts b/packages/docusaurus-plugin-content-docs/src/sidebars/__tests__/generator.test.ts
@@ -526,7 +526,7 @@ describe('DefaultSidebarItemsGenerator', () => {
           frontMatter: {
             draft: true,
           },
-          isDraft: true,
+          draft: true,
         },
         {
           id: 'doc2',
@@ -536,7 +536,7 @@ describe('DefaultSidebarItemsGenerator', () => {
           frontMatter: {
             draft: false,
           },
-          isDraft: false,
+          draft: false,
         },
       ],
       options: {

diff --git a/packages/docusaurus-plugin-content-docs/src/sidebars/__tests__/processor.test.ts b/packages/docusaurus-plugin-content-docs/src/sidebars/__tests__/processor.test.ts
@@ -263,11 +263,11 @@ describe('processSidebars', () => {
         docs: [
           {
             id: 'doc1',
-            isDraft: true,
+            draft: true,
           },
           {
             id: 'doc2',
-            isDraft: false,
+            draft: false,
           },
         ],
       },

diff --git a/packages/docusaurus-plugin-content-docs/src/sidebars/generator.ts b/packages/docusaurus-plugin-content-docs/src/sidebars/generator.ts
@@ -53,7 +53,7 @@ export const DefaultSidebarItemsGenerator: SidebarItemsGenerator = async ({
   item: {dirName: autogenDir},
   categoriesMetadata,
 }) => {
-  const visibleDocs = allDocs.filter((doc) => !doc.isDraft);
+  const visibleDocs = allDocs.filter((doc) => !doc.draft);
   const docsById = createDocsByIdIndex(visibleDocs);
   const findDoc = (docId: string): SidebarItemsGeneratorDoc | undefined =>
     docsById[docId];

diff --git a/packages/docusaurus-plugin-content-docs/src/sidebars/processor.ts b/packages/docusaurus-plugin-content-docs/src/sidebars/processor.ts
@@ -39,7 +39,7 @@ function toSidebarItemsGeneratorDoc(
     'source',
     'sourceDirName',
     'sidebarPosition',
-    'isDraft',
+    'draft',
   ]);
 }
 
@@ -96,10 +96,7 @@ async function processSidebar(
     if (item.type === 'autogenerated') {
       return processAutoGeneratedItem(item);
     }
-    if (
-      item.type === 'doc' &&
-      docs.find((doc) => doc.id === item.id)?.isDraft
-    ) {
+    if (item.type === 'doc' && docs.find((doc) => doc.id === item.id)?.draft) {
       return [];
     }
     return [item];

diff --git a/packages/docusaurus-plugin-content-docs/src/sidebars/types.ts b/packages/docusaurus-plugin-content-docs/src/sidebars/types.ts
@@ -227,7 +227,7 @@ export type SidebarItemsGeneratorDoc = Pick<
   | 'source'
   | 'sourceDirName'
   | 'sidebarPosition'
-  | 'isDraft'
+  | 'draft'
 >;
 export type SidebarItemsGeneratorVersion = Pick<
   VersionMetadata,