feat: add JSON docgen generator to feed docusaurus website with accurate prop definitions #7927
Conversation
| @@ -0,0 +1,73 @@ | |||
| import { EuiBasicTable, EuiMarkdownFormat, EuiBasicTableColumn, EuiTextColor, EuiCode } from '@elastic/eui'; | |||
There was a problem hiding this comment.
This component is just for demonstration purposes only and will be heavily refactored in a separate PR.
| "dist", | ||
| "lib" | ||
| ], | ||
| "types": "./lib/index.d.ts", |
There was a problem hiding this comment.
The only exports are the type definitions for the interfaces this package defines
| @@ -0,0 +1,96 @@ | |||
| import type { PropItem } from 'react-docgen-typescript'; | |||
There was a problem hiding this comment.
Most of this source code comes from https://github.com/elastic/eui/blob/main/packages/eui/scripts/babel/react-docgen-typescript.js and is purposefully left as is to keep the prop table data the same as on the current documentation site.
There was a problem hiding this comment.
🗒️ Considering that it's mainly copied, I won't do an in depth review of it.
| @@ -0,0 +1,96 @@ | |||
| import type { PropItem } from 'react-docgen-typescript'; | |||
There was a problem hiding this comment.
🗒️ Considering that it's mainly copied, I won't do an in depth review of it.
💚 Build Succeeded
History
cc @tkajtoch |
Summary
Resolves #7926
This PR adds a new private package
@elastic/eui-docgenthat generates docgen JSON files for all EUI source files just like the babel script did. It reuses most of the old code and results in lots of definition JSON files being generated. This PR also adds an example page to docusaurus and very, very basicPropTablecomponent to thedocusaurus-themepackage. These will be updated and improved in following PRs.QA
yarnpackages/websiteand build all of its local dependencies:yarn workspaces foreach -Rpt --from @elastic/eui-website run buildyarn start