fix(builder): use property symbol instead of type property#77
Merged
Conversation
This fixes the the documentation of type fields (e.g. interfaces) in the schema parser. Previously, the return type of the property was used to determine the description of the field. If a type property used the `Date` type, the description of the `Date` type was used instead of the actual description of the field. This commit changes the behavior to use the property symbol instead of the return type of the property. closes #76
🦋 Changeset detectedLatest commit: 573ae50 The changes in this PR will be included in the next version bump. This PR includes changesets to release 2 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Contributor
🚀 Snapshot Release (
|
| Package | Version | Info |
|---|---|---|
@getcronit/pylon-builder |
2.6.8-canary-20250311173056.573ae5085c663f87cbd7704d3975323a23288851 |
npm ↗︎ unpkg ↗︎ |
@getcronit/pylon-dev |
1.0.4-canary-20250311173056.573ae5085c663f87cbd7704d3975323a23288851 |
npm ↗︎ unpkg ↗︎ |
Contributor
Author
|
@ericzorn93 I fixed the issue. May you test out the |
|
@schettn, this works, thank you for fixing this |
ericzorn93
approved these changes
Mar 12, 2025
Merged
schettn
added a commit
that referenced
this pull request
Mar 12, 2025
This fixes the the documentation of type fields (e.g. interfaces) in the schema parser. Previously, the return type of the property was used to determine the description of the field. If a type property used the `Date` type, the description of the `Date` type was used instead of the actual description of the field. This commit changes the behavior to use the property symbol instead of the return type of the property. closes #76
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
2 participants
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.
Fix an issue where field descriptions in schema parsing did not work.
Previously, field descriptions (e.g., for interface fields) were not included in the generated schema, as the return type's description was incorrectly used instead of the field's own comments.
Now, field descriptions are correctly parsed from property symbols, ensuring that inline comments are reflected in the generated schema.
Example:
In the above example, the
profile,matching, anddatefields will now include their respective descriptions in the generated schema.