fix(plugin): generate object examples from @example doc tags - #4005
Merged
Conversation
Object values in @example JSDoc tags were parsed successfully but createLiteralFromAnyValue only handled arrays and primitives, returning undefined for objects. The resulting exception was swallowed by the property visitor, dropping the entire property from _OPENAPI_METADATA_FACTORY. Handle plain objects (and null) by emitting object literal expressions with string literal keys.
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
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.
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
With
introspectCommentsenabled, an@exampledoc tag holding a JSON object is parsed successfully, butcreateLiteralFromAnyValueonly handles arrays and primitives and returnsundefinedfor objects. The resulting exception is swallowed by the property visitor, so the entire property (includingrequiredandtype) is dropped from_OPENAPI_METADATA_FACTORY:Issue Number: N/A
What is the new behavior?
createLiteralFromAnyValuenow handles plain objects (andnull) recursively, emitting object literal expressions with string literal keys so that non-identifier keys such as"Content-Type"work:Does this PR introduce a breaking change?
Other information
test/plugin/fixtures/create-cat-alt2.dto.tsfor an object@exampleon aRecord<string, string>property.