Auto-generate routes for components #7
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| #!/usr/bin/env node | ||
|
|
||
| const esbuild = require('esbuild'); | ||
| const cssModules = require('esbuild-css-modules-plugin'); | ||
|
|
||
| const format = process.env.FORMAT; | ||
|
|
||
| esbuild.build({ | ||
| logLevel: 'info', | ||
| sourcemap: true, | ||
| bundle: false, | ||
| outbase: 'src', | ||
| format: format, | ||
| outdir: format === 'esm' ? 'pkg/dist-src' : 'pkg/dist-node', | ||
| platform: 'node', | ||
| plugins: [cssModules()], | ||
| entryPoints: [ | ||
| 'src/index.ts', | ||
| 'src/hooks/useDynamicImport.ts', | ||
| 'src/theme/ReactDocLayout/index.tsx', | ||
| 'src/theme/ReactDocLayout/styles.module.css', | ||
| 'src/theme/ReactComponentPage/index.tsx', | ||
| 'src/theme/ReactComponentItem/index.tsx', | ||
| 'src/theme/ReactPropTable/index.tsx', | ||
| ], | ||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,12 @@ | ||
| import path from 'path'; | ||
| import globby from 'globby'; | ||
| import docgen, { ParserOptions, ComponentDoc, FileParser } from 'react-docgen-typescript'; | ||
| import { DEFAULT_PLUGIN_ID } from '@docusaurus/core/lib/constants'; | ||
|
|
||
| import { Plugin, LoadContext, RouteConfig } from '@docusaurus/types'; | ||
| import { docuHash } from '@docusaurus/utils'; | ||
| import { CompilerOptions } from 'typescript'; | ||
| import { PropSidebarItem } from '@docusaurus/plugin-content-docs-types'; | ||
|
|
||
| type Route = Pick<RouteConfig, 'exact' | 'component' | 'path' | 'priority'>; | ||
|
|
||
|
|
@@ -18,10 +21,13 @@ type Union = | |
| }; | ||
|
|
||
| type Options = Union & { | ||
| id: string; | ||
| src: string | string[]; | ||
| tsConfig?: string; | ||
| compilerOptions?: CompilerOptions; | ||
| parserOptions?: ParserOptions; | ||
| createRoutes?: boolean; | ||
| baseRoute?: string; | ||
| }; | ||
|
|
||
| const getParser = ( | ||
|
|
@@ -39,23 +45,37 @@ const getParser = ( | |
| }; | ||
|
|
||
| export default function plugin( | ||
| context: LoadContext, | ||
| { | ||
| id, | ||
| src, | ||
| global = false, | ||
| route, | ||
| tsConfig, | ||
| compilerOptions, | ||
| parserOptions, | ||
| createRoutes, | ||
| baseRoute = '/docs/react', | ||
| }: Options | ||
| ): Plugin<ComponentDoc[]> { | ||
| const { generatedFilesDir } = context; | ||
|
|
||
| const pluginId = id ?? DEFAULT_PLUGIN_ID; | ||
|
There was a problem hiding this comment. Inspired by docusaurus-plugin-openapi setup. |
||
| const pluginName = 'docusaurus-plugin-react-docgen-typescript'; | ||
| const pluginDataDirRoot = path.join(generatedFilesDir, pluginName); | ||
|
|
||
| const dataDir = path.join(pluginDataDirRoot, pluginId); | ||
|
|
||
| return { | ||
| name: pluginName, | ||
| async loadContent() { | ||
| return getParser(tsConfig, compilerOptions, parserOptions)(await globby(src)); | ||
| }, | ||
| configureWebpack() { | ||
| return { | ||
| resolve: { | ||
| alias: { | ||
| '@docgen': dataDir, | ||
| }, | ||
| }, | ||
| }; | ||
|
|
@@ -77,10 +97,63 @@ export default function plugin( | |
| }, | ||
| }); | ||
| } else { | ||
| const sidebarName = `react-docgen-typescript-sidebar-${pluginId}`; | ||
| const sidebar: PropSidebarItem[] = content.map(component => ({ | ||
| type: 'link', | ||
| href: `${baseRoute}/${component.displayName}`, | ||
| label: component.displayName, | ||
| })); | ||
|
|
||
| const componentMetadataPath = await createData( | ||
| `${docuHash('component-metadata-prop')}.json`, | ||
| JSON.stringify( | ||
| { | ||
| apiSidebars: { | ||
| [sidebarName]: sidebar, | ||
| }, | ||
| }, | ||
| null, | ||
| 2 | ||
| ) | ||
| ); | ||
|
|
||
| const routes: RouteConfig[] = await Promise.all( | ||
| content.map(async component => { | ||
| const componentData = await createData( | ||
| `${component.displayName}.json`, | ||
| JSON.stringify(component) | ||
|
There was a problem hiding this comment. This was the only breaking change: |
||
| ); | ||
|
|
||
| if (createRoutes) { | ||
| return { | ||
| path: `${baseRoute}/${component.displayName}`, | ||
| exact: true, | ||
| component: '@theme/ReactComponentItem', | ||
| sidebar: sidebarName, | ||
| modules: { | ||
| componentMetadata: componentMetadataPath, | ||
| data: componentData, | ||
| }, | ||
| }; | ||
| } | ||
| }) | ||
| ); | ||
|
|
||
| if (createRoutes) { | ||
| addRoute({ | ||
| path: baseRoute, | ||
| component: '@theme/ReactComponentPage', | ||
| sidebar: sidebarName, | ||
| routes, | ||
| modules: { | ||
| componentMetadata: componentMetadataPath, | ||
| }, | ||
| }); | ||
| } | ||
| } | ||
| }, | ||
| getThemePath(): string { | ||
| return path.resolve(__dirname, './theme'); | ||
| }, | ||
| }; | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| export type ReactComponentMetadata = { | ||
| apiSidebars: import('@docusaurus/plugin-content-docs-types').PropSidebars; | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| import React from 'react'; | ||
|
|
||
| import type { Props } from '@theme/DocPage'; | ||
| import { ComponentDoc } from 'react-docgen-typescript'; | ||
| import ReactPropTable from '@theme/ReactPropTable'; | ||
|
|
||
| export type ReactComponentItemProps = Omit<Props, 'versionMetadata'> & { | ||
| data: ComponentDoc; | ||
| }; | ||
|
|
||
| export default function ReactComponentItem(props: ReactComponentItemProps): JSX.Element { | ||
| const { data } = props; | ||
|
|
||
| return ( | ||
| <> | ||
| <h2>{data.displayName}</h2> | ||
| <p>{data.description}</p> | ||
| <h3>Props</h3> | ||
| <ReactPropTable data={data.props} /> | ||
| </> | ||
| ); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| import React from 'react'; | ||
| import { ComponentDoc } from 'react-docgen-typescript'; | ||
| import renderRoutes from '@docusaurus/renderRoutes'; | ||
| import type { Props } from '@theme/DocPage'; | ||
| import ReactDocLayout from '@theme/ReactDocLayout'; | ||
| import { ReactComponentMetadata } from '../../metadata'; | ||
| import { matchPath, useLocation } from '@docusaurus/router'; | ||
|
|
||
| export type ReactComponentPageProps = Omit<Props, 'versionMetadata'> & { | ||
| componentMetadata: ReactComponentMetadata; | ||
| data: ComponentDoc[]; | ||
| }; | ||
|
|
||
| export default function ReactComponentPage({ | ||
| componentMetadata, | ||
| route: { routes: componentRoutes, ...route }, | ||
| }: ReactComponentPageProps): JSX.Element { | ||
| const location = useLocation(); | ||
| const currentRoute = | ||
| componentRoutes.find(componentRoute => matchPath(location.pathname, componentRoute)) || | ||
| route; | ||
|
|
||
| return ( | ||
| <ReactDocLayout componentMetadata={componentMetadata} currentRoute={currentRoute}> | ||
| {renderRoutes(componentRoutes)} | ||
| </ReactDocLayout> | ||
| ); | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I thought it was easier to update the component's
createDatawith the whole metadata, not only the props.