fix generated types for self-referential attributes#28
Merged
ElMassimo merged 2 commits intoElMassimo:mainfrom Jan 2, 2026
Merged
fix generated types for self-referential attributes#28ElMassimo merged 2 commits intoElMassimo:mainfrom
ElMassimo merged 2 commits intoElMassimo:mainfrom
Conversation
Contributor
Author
|
@ElMassimo I don't think the failing checks are due to my code, seems to be an issue with the pipeline. |
Owner
|
Thanks Adrian! |
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.
Description 📖
Fixes TypeScript compilation errors when serializers have self-referencing associations (e.g., comments with comment replies, folders containing folders).
Previously, self-referencing serializers generated imports that caused TS2440 and TS2652 errors:
Now generates valid TypeScript without the self-import:
Background 📜
TypeScript interfaces can reference themselves without imports, but the generator was adding import statements for all association serializers without checking if they referenced the current serializer.
This pattern is common in hierarchical data structures:
The Fix 🔨
Added a filter in
Interface#used_imports(generator.rb) to skip imports when an association serializer references itself:Note: this is probably not the clearest-written comment...my words failed me a little with this issue.
The fix compares TypeScript interface names to detect self-references. Properties still include the self-referencing type, but no import is generated.
Test coverage includes both standard and namespace modes with a
CommentSerializerthat hashas_many :replies, serializer: CommentSerializer.