Fix readonly nullable properties edge case #1036
Merged
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
The current logic generates invalid TypeScript code with the
`immutableTypes` option for nullable properties which include at least
one union (potentially nested):
Simple example:
type: array
nullable: true
items:
oneOf:
- type: number
- type: string
Generated code before and after this PR:
readonly before: readonly ((number | string)[]) | null; // Invalid
readonly after: (readonly (number | string)[]) | null; // OK
mtth
force-pushed
the
readonly-nullable
branch
from
6b51ad9 to
b924dbd
Compare
|
@all-contributors please add @mtth for code, bug, test |
|
I've put up a pull request to add @mtth! 🎉 |
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.
Changes
The current logic generates invalid TypeScript code for nullable array properties which include at least one union (potentially nested) when the
immutableTypesoption is set.Simple example:
Generated code before and after this PR:
How to Review
The added unit-test provides another example. You could also compile the GitHub spec with immutability enabled: it should fail without the fix and succeed with it.
Checklist
examples/directory updated (if applicable)