feat: add support for nullable relations#113
Open
Livijn wants to merge 4 commits intofumeapp:masterfrom
Open
Conversation
- Detect nullable return types in relationship methods - Mark nullable relations as optional (?) in TypeScript output - Handle union types containing null (e.g., BelongsTo|Listing|null) - Handle single nullable types (e.g., ?BelongsTo)
- Changed nullable relations to use 'Type | null' instead of 'Type?' - More explicit and follows TypeScript best practices - Optional relations (via config) still use '?' syntax
- Add tests for WriteRelationship nullable handling - Add tests for ModelInspector nullable detection - Make isReturnTypeNullable public for testability - Test nullable union types (e.g., BelongsTo|Listing|null) - Test nullable named types (e.g., ?BelongsTo) - Test non-nullable relations - Test nullable plural relations
- Remove tests for isReturnTypeNullable (implementation detail) - Keep isReturnTypeNullable protected (not public API) - Keep tests for WriteRelationship (public behavior) - All 116 tests passing
Member
|
hi @Livijn thanks for the PR!
i'd just like to reassure any changes in the future still adhere to this new functionality Thanks again for your contributions 🍻 |
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.
Summary
This PR adds support for detecting and handling nullable relationships in model:typer.
Problem
Previously, model:typer could not detect when a relationship method had a nullable return type. For example:
This would generate
listing: Listinginstead oflisting: Listing | null.Solution
ModelInspectorto detect nullable return types from relationship methodsisReturnTypeNullable()method that checks for:null(e.g.,BelongsTo|Listing|null)?BelongsTo)WriteRelationshipto generateType | nullfor nullable relationsExample
Input (PHP):
Output (TypeScript):
Changes
src/Overrides/ModelInspector.php: OverridegetRelations()to detect nullable return typessrc/Actions/WriteRelationship.php: Handle nullable relations with| nullsyntaxtest/Tests/Feature/Actions/WriteRelationshipTest.php: Add tests for nullable relationsTests
All 116 tests passing, including 4 new tests for nullable relations.