Correct generation of typealiases with type args #1162
Merged
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
If you had `typealias Foo = List<String>` then `toTypeName()` would incorrectly generate `Foo<String>` instead of `Foo`. This is because `KSType.arguments`, returns the arguments of the underlying type, _not_ the alias. In order to get the alias args you need to use `KSTypeReference.element.typeArguments` instead.
evant
commented
Sep 20, 2021
| @@ -53,7 +53,8 @@ public fun KSType.toClassName(): ClassName { | |||
| */ | |||
| @KotlinPoetKspPreview | |||
| public fun KSType.toTypeName( | |||
| typeParamResolver: TypeParameterResolver = TypeParameterResolver.EMPTY | |||
| typeParamResolver: TypeParameterResolver = TypeParameterResolver.EMPTY, | |||
| typeArguments: List<KSTypeArgument> = emptyList(), | |||
There was a problem hiding this comment.
Not sure how to handle this api-wise. I just added it as an extra argument to get this info but there may be a better way.
There was a problem hiding this comment.
Let's keep the original public signature but then move the full impl with this overload to an internal separate function. We can open it up later if there's a need for it
ZacSweers
reviewed
Sep 21, 2021
| @@ -53,7 +53,8 @@ public fun KSType.toClassName(): ClassName { | |||
| */ | |||
| @KotlinPoetKspPreview | |||
| public fun KSType.toTypeName( | |||
| typeParamResolver: TypeParameterResolver = TypeParameterResolver.EMPTY | |||
| typeParamResolver: TypeParameterResolver = TypeParameterResolver.EMPTY, | |||
| typeArguments: List<KSTypeArgument> = emptyList(), | |||
There was a problem hiding this comment.
Let's keep the original public signature but then move the full impl with this overload to an internal separate function. We can open it up later if there's a need for it
ZacSweers
reviewed
Sep 21, 2021
interop/ksp/src/main/kotlin/com/squareup/kotlinpoet/ksp/ksTypes.kt
Outdated
Show resolved
Hide resolved
ZacSweers
approved these changes
Sep 21, 2021
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.
If you had
typealias Foo = List<String>thentoTypeName()wouldincorrectly generate
Foo<String>instead ofFoo. This is becauseKSType.arguments, returns the arguments of the underlying type, notthe alias. In order to get the alias args you need to use
KSTypeReference.element.typeArgumentsinstead.