refactor

facebook · Apr 6, 2022 · 7127b4d · 7127b4d
1 parent c6c5355
commit 7127b4d
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 15 deletions.
diff --git a/packages/docusaurus-plugin-content-docs/src/index.ts b/packages/docusaurus-plugin-content-docs/src/index.ts
@@ -19,7 +19,7 @@ import {
   createSlugger,
   DEFAULT_PLUGIN_ID,
 } from '@docusaurus/utils';
-import type {LoadContext, Plugin, TagsListItem} from '@docusaurus/types';
+import type {LoadContext, Plugin} from '@docusaurus/types';
 import {loadSidebars} from './sidebars';
 import {CategoryMetadataFilenamePattern} from './sidebars/generator';
 import {
@@ -50,6 +50,7 @@ import logger from '@docusaurus/logger';
 import {getVersionTags} from './tags';
 import {createVersionRoutes} from './routes';
 import type {
+  PropTagsListPage,
   PluginOptions,
   DocMetadataBase,
   VersionMetadata,
@@ -224,13 +225,13 @@ export default async function pluginContentDocs(
 
         // TODO tags should be a sub route of the version route
         async function createTagsListPage() {
-          const tagsProp: TagsListItem[] = Object.values(versionTags).map(
-            (tag) => ({
-              label: tag.label,
-              permalink: tag.permalink,
-              count: tag.docIds.length,
-            }),
-          );
+          const tagsProp: PropTagsListPage['tags'] = Object.values(
+            versionTags,
+          ).map((tagValue) => ({
+            label: tagValue.label,
+            permalink: tagValue.permalink,
+            count: tagValue.docIds.length,
+          }));
 
           // Only create /tags page if there are tags.
           if (tagsProp.length > 0) {
@@ -251,14 +252,14 @@ export default async function pluginContentDocs(
 
         // TODO tags should be a sub route of the version route
         async function createTagDocListPage(tag: VersionTag) {
-          const tagItemsProp = toTagDocListProp({
+          const tagProps = toTagDocListProp({
             allTagsPath: version.tagsPath,
             tag,
             docs: version.docs,
           });
           const tagPropPath = await createData(
             `${docuHash(`tag-${tag.permalink}`)}.json`,
-            JSON.stringify(tagItemsProp, null, 2),
+            JSON.stringify(tagProps, null, 2),
           );
           addRoute({
             path: tag.permalink,

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
@@ -488,9 +488,7 @@ declare module '@docusaurus/plugin-content-docs' {
     DocMetadata,
     'id' | 'title' | 'description' | 'permalink'
   >;
-  export type PropTagDocList = {
-    tag: TagModule & {items: PropTagDocListDoc[]};
-  };
+  export type PropTagDocList = TagModule & {items: PropTagDocListDoc[]};
 
   export type PropTagsListPage = {
     tags: TagsListItem[];
@@ -551,7 +549,9 @@ declare module '@theme/DocTagsListPage' {
 declare module '@theme/DocTagDocListPage' {
   import type {PropTagDocList} from '@docusaurus/plugin-content-docs';
 
-  export interface Props extends PropTagDocList {}
+  export interface Props {
+    readonly tag: PropTagDocList;
+  }
   export default function DocTagDocListPage(props: Props): JSX.Element;
 }
 

diff --git a/packages/docusaurus-plugin-content-docs/src/props.ts b/packages/docusaurus-plugin-content-docs/src/props.ts
@@ -138,7 +138,7 @@ export function toTagDocListProp({
   allTagsPath: string;
   tag: VersionTag;
   docs: DocMetadata[];
-}): PropTagDocList['tag'] {
+}): PropTagDocList {
   function toDocListProp(): PropTagDocListDoc[] {
     const list = _.compact(
       tag.docIds.map((id) => docs.find((doc) => doc.id === id)),