🚧 Derive component docs.json from TS #6641
Draft
Conversation
This file contains hidden or 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
|
github-actions
bot
added
the
integration-tests: recommended
|
👋 Hi, this pull request contains changes to the source code that github/github depends on. If you are GitHub staff, we recommend testing these changes with github/github using the integration workflow. Thanks! |
size-limit report 📦
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 change builds upon some of the foundations from #6047 to enable us to progressively move towards more colocated documentation for our prop types inline with the TS source-code.
As a first-step, the list of properties to expose to documentation will still remain in the
*.docs.jsonfile, but each now have the option of using the"derive": trueflag to gather any pertinent information from the TS types, includingdescription(JSDoc),defaultValue,type, andrequired. Fields specified in the*.docs.jsonwill override any from TS, allowing for customization as more is moved into each component.This reduces the amount of overhead for maintaining the separate
*.docs.jsonper Component and also has the added benefit of exposing better documentation for users within their IDEs (which already pull from JSDoc comments and tags like@default)