fix: schema generation when property name cannot be escaped #2018
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
baloghbence0915
force-pushed
the
fix-2017-property-names-resolution
branch
from
bf9616f
to
d4faecd
Compare
arthurfiorette
requested changes
Jul 9, 2024
arthurfiorette
requested changes
Jul 10, 2024
arthurfiorette
approved these changes
Jul 10, 2024
domoritz
approved these changes
Jul 10, 2024
| // `escapedText` or `text` is available. | ||
| // Only `text` will be available when propertyName contains strange characters and it cannot be escaped | ||
| // or if it is a number. | ||
| return ((propertyName as ts.Identifier).escapedText as string) || (propertyName as ts.StringLiteral).text; |
There was a problem hiding this comment.
Should this use ?? Instead so that it doesn't fall through for empty strings (if that's possible)?
There was a problem hiding this comment.
good catch, hey @baloghbence0915 can you test this out?
There was a problem hiding this comment.
Good point. Weirdly both TS and JS allows empty strings as property names.
Regardless, in such a case escapedText won't be available at all and will fall back to text, altough I aggree with the general approach of trusting escapedText if it present so changed OR to nullish coalescing (??) operator.
Also extended the testing with this case.
baloghbence0915
force-pushed
the
fix-2017-property-names-resolution
branch
from
5fb2463
to
b1c5743
Compare
arthurfiorette
approved these changes
Jul 11, 2024
|
thanks! |
arthurfiorette
changed the title
|
🚀 PR was released in |
This was referenced Aug 13, 2024
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.
Fixes: #2017
Conclusion:
After deeper insight, the described issue only occured, in case of nested properties and when the property doesn't have explict type definition and it's key is a string literal that cannot be escaped or a number.
By that, it didn't impact interfaces since they are explicit type definitions themselves, but unit test was provided for class and interface anyway.
Version
Published prerelease version:
v2.4.0-next.1Changelog
🎉 This release contains work from a new contributor! 🎉
Thank you, Bence Balogh (@baloghbence0915), for all your work!
🚀 Enhancement
--expose allwith generic types #2009 (@arthurfiorette)🐛 Bug Fix
next🔩 Dependency Updates
Authors: 4