docgen: Add function to handle list of types for theme.json schema #46375
Conversation
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
mikachan
added
[Type] Bug
mikachan
requested review from
ntwb,
nerrad,
ajitbohra,
ryanwelcher,
juanmaguitar and
fabiankaegy
as code owners
|
Size Change: 0 B Total Size: 1.32 MB ℹ️ View Unchanged
|
vcanales
requested changes
Dec 19, 2022
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.
What?
This PR enables docgen to list multiple types for the theme.json style properties listed in theme-json-living.md.
Why?
Currently, the generated theme.json docs will not list multiple types and instead will print
undefined. See the current generated entry for theradiusstyle property.How?
Adds a new function called
formatType, which takes the style property object and checks if thetypekey exists. If it does, it will default to that (the same as the current behavior). If it doesn't exist, it checks for theanyOforoneOfproperties and makes a comma-separated list of those types.Testing Instructions
Run
node ./bin/api-docs/gen-theme-reference.js, and the generated type for theradiusproperty should be "string, object" instead of "undefined".Testing Instructions for Keyboard
Screenshots or screencast