Add option to add a reason to ForbiddenImport
#4909
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
Codecov Report
@@ Coverage Diff @@
## main #4909 +/- ##
=========================================
Coverage 84.83% 84.84%
- Complexity 3511 3515 +4
=========================================
Files 497 497
Lines 11548 11551 +3
Branches 2138 2142 +4
=========================================
+ Hits 9797 9800 +3
Misses 686 686
Partials 1065 1065
Continue to review full report at Codecov.
|
marschwar
reviewed
Jun 23, 2022
...t-rules-style/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/style/ForbiddenImportSpec.kt
Outdated
Show resolved
Hide resolved
marschwar
reviewed
Jun 23, 2022
detekt-rules-style/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/style/ForbiddenImport.kt
Outdated
Show resolved
Hide resolved
marschwar
approved these changes
Jun 23, 2022
…/rules/style/ForbiddenImportSpec.kt Co-authored-by: marschwar <marschwar@users.noreply.github.com>
VitalyVPinchuk
pushed a commit
to VitalyVPinchuk/detekt
that referenced
this pull request
Jul 25, 2022
* Improve tests * Improve issue message * Add utility to help testing ValueWithReason configurations * Add support for reasons in ForbiddenImport * Improve non-compilant * Update detekt-rules-style/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/style/ForbiddenImportSpec.kt Co-authored-by: marschwar <marschwar@users.noreply.github.com> * data class Co-authored-by: marschwar <marschwar@users.noreply.github.com>
|
There is no documentation for this? I got here from release notes, and I'm wondering how to use this [edit] Looks like this works for example: ForbiddenImport:
active: true
imports:
- reason: 'Use Kotest assertions instead.'
value: 'org.junit.Assert'
- reason: 'Use Kotest assertions instead.'
value: 'org.junit.Assert.*' |
|
Probably it is not. Do you want to create a PR to help improve the 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.
I'm really happy to be able to introduce this feature :). Thanks @marschwar for creating the necesary tooling to be able to implement it.
Important: This introduces a breaking change in
ForbiddenImport. It no longer allows comma-separated imports as a String. It should use yml lists. I'm targetting this to1.22.0because on1.21.0we added make that all those usages will be a warning. Tell me is we should be more conservative.The reason that this is a draft is just to avoid accidental merges. But the code should be ready to merge.
Related with #3501