Autogenerate UI adapter props with ts-morph #315
Merged
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.
This PR uses ts-morph AST to autogenerate prop documentation for the component adapters.
For more context on alternative approaches explored see the slack thread here.
The summary at a high level behind the decision to go this way:
This approach uses ts-morph which allows us to get all props (including picked html props) and format them to a single file according to our needs. This is also an approach that requires the most custom config. In the event that this script proves brittle or challenging to maintain, we may ultimately need to revisit and just deal with the limitations of typedoc + markdown plugin. But team consensus was that we could give this a try and adjust as needed down the road.
Proof of functionality
View output markdown file on the branch here https://github.com/Gusto/embedded-react-sdk/blob/chore/GWS-5000-ts-morph/docs/06/01/component-inventory.md