HasPlatformType rule #1938
Merged
HasPlatformType rule #1938
Conversation
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
schalkms
reviewed
Sep 19, 2019
Member
schalkms
left a comment
There was a problem hiding this comment.
Cool! This rule is beneficial for all library developers. I like it.
| * Platform types must be declared explicitly in public APIs to prevent unexpected errors. | ||
| * | ||
| * Based on code from Kotlin project: | ||
| * https://github.com/JetBrains/kotlin/blob/1.3.50/idea/src/org/jetbrains/kotlin/idea/intentions/SpecifyTypeExplicitlyIntention.kt#L86-L107 |
Member
There was a problem hiding this comment.
I'm not sure if we should really reference the source location.
Source code can be changed easily. Thus, this reference could become out of date.
It's better IMHO to include the license in our project.
Member
Author
There was a problem hiding this comment.
The url is fixed to v1.3.50 of Kotlin, so the link won't break.
detekt-rules/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/bugs/HasPlatformType.kt
Outdated
Show resolved
Hide resolved
| val callable = | ||
| bindingContext[BindingContext.DECLARATION_TO_DESCRIPTOR, this] as? CallableDescriptor ?: return false | ||
| if (!callable.visibility.isPublicAPI) return false | ||
| return callable.returnType?.isFlexible() ?: return false |
Member
There was a problem hiding this comment.
What does isFlexible() check for?
Member
Author
There was a problem hiding this comment.
| import org.spekframework.spek2.Spek | ||
| import org.spekframework.spek2.style.specification.describe | ||
|
|
||
| object HasPlatformTypeSpec : Spek({ |
Member
There was a problem hiding this comment.
Could we please make sure that the tests cover all branches (if possible)?
if (containingClassOrObject?.isLocal == true) return false
val callable = bindingContext[BindingContext.DECLARATION_TO_DESCRIPTOR, this] as? CallableDescriptor ?: return false
if (!callable.visibility.isPublicAPI) return false
return callable.returnType?.isFlexible() ?: return falseCo-Authored-By: M Schalk <[email protected]>
arturbosch
approved these changes
Sep 26, 2019
smyachenkov
pushed a commit
to smyachenkov/detekt
that referenced
this pull request
Dec 9, 2019
* HasPlatformType rule * Merge ifs Co-Authored-By: M Schalk <[email protected]>
smyachenkov
pushed a commit
to smyachenkov/detekt
that referenced
this pull request
Dec 9, 2019
* HasPlatformType rule * Merge ifs Co-Authored-By: M Schalk <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
Closes #556
Rule is quite conservative and picks up usage in public APIs only. Future enhancement could be to add a config option to detect implicit usage of platform types anywhere they're found.