Suppress RedundantVisibilityModifierRule if explicit API mode enabled #3175
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
Explicit API mode was added in Kotlin 1.4 It prevents libraries' authors from making APIs public unintentionally. In this mode, the visibility modifier should be defined explicitly even if it is public. See: https://kotlinlang.org/docs/reference/whatsnew14.html#explicit-api-mode-for-library-authors Closes #3125
Codecov Report
@@ Coverage Diff @@
## master #3175 +/- ##
============================================
+ Coverage 79.44% 79.56% +0.11%
- Complexity 2596 2611 +15
============================================
Files 437 439 +2
Lines 7818 7937 +119
Branches 1484 1512 +28
============================================
+ Hits 6211 6315 +104
- Misses 819 820 +1
- Partials 788 802 +14 Continue to review full report at Codecov.
|
cortinico
reviewed
Oct 26, 2020
| @@ -53,11 +55,21 @@ class RedundantVisibilityModifierRule(config: Config = Config.empty) : Rule(conf | |||
|
|
|||
| private fun KtModifierListOwner.isExplicitlyPublic() = this.hasModifier(KtTokens.PUBLIC_KEYWORD) | |||
|
|
|||
| /** | |||
| * Explicit API mode was added in Kotlin 1.4 | |||
There was a problem hiding this comment.
Maybe add a note in the KDoc on top of the file so it gets propagated in the generated documentation?
cortinico
approved these changes
Oct 26, 2020
|
Thank you for making this change. I meant to report a new issue but found that this is already addressed! |
arturbosch
pushed a commit
that referenced
this pull request
Nov 15, 2020
…#3175) * Suppress RedundantVisibilityModifierRule if explicit API mode enabled Explicit API mode was added in Kotlin 1.4 It prevents libraries' authors from making APIs public unintentionally. In this mode, the visibility modifier should be defined explicitly even if it is public. See: https://kotlinlang.org/docs/reference/whatsnew14.html#explicit-api-mode-for-library-authors Closes #3125 * Add explicit API mode to rule documentation
arturbosch
pushed a commit
that referenced
this pull request
Dec 21, 2020
…#3175) * Suppress RedundantVisibilityModifierRule if explicit API mode enabled Explicit API mode was added in Kotlin 1.4 It prevents libraries' authors from making APIs public unintentionally. In this mode, the visibility modifier should be defined explicitly even if it is public. See: https://kotlinlang.org/docs/reference/whatsnew14.html#explicit-api-mode-for-library-authors Closes #3125 * Add explicit API mode to rule documentation
arturbosch
pushed a commit
that referenced
this pull request
Jan 16, 2021
…#3175) * Suppress RedundantVisibilityModifierRule if explicit API mode enabled Explicit API mode was added in Kotlin 1.4 It prevents libraries' authors from making APIs public unintentionally. In this mode, the visibility modifier should be defined explicitly even if it is public. See: https://kotlinlang.org/docs/reference/whatsnew14.html#explicit-api-mode-for-library-authors Closes #3125 * Add explicit API mode to rule documentation
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.
Explicit API mode was added in Kotlin 1.4
It prevents library authors from making APIs public unintentionally.
In this mode, the visibility modifier should be defined explicitly even if it is public.
See: https://kotlinlang.org/docs/reference/whatsnew14.html#explicit-api-mode-for-library-authors
Closes #3125