Clarify WildcardImport rule configuration
#1888
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
Add information about conflict between `formatting:``NoWildcardImports` and `style:``WildcardImport` rules.
cortinico
requested changes
Sep 2, 2019
docs/pages/documentation/style.md
Outdated
| @@ -1410,6 +1410,11 @@ Library updates can introduce naming clashes with your own classes which might r | |||
| Define a whitelist of package names that should be allowed to be imported | |||
| with wildcard imports. | |||
|
|
|||
| **NOTE:** This rule conflicts with `NoWildcardImports` formatting rule. | |||
There was a problem hiding this comment.
I do believe that conflicts here is probably not the best term.
I would rephrase with something like:
Suggested change
| **NOTE:** This rule conflicts with `NoWildcardImports` formatting rule. | |
| **NOTE:** This rule is similar to the `NoWildcardImports` formatting rule (a wrapper of a KtLint rule). | |
| If you need to specify a `excludeImports` configuration, please consider disabling the other rule. |
Or something like that.
There was a problem hiding this comment.
I like the wrapper clarification suggestion.
Regarding conflict/similarity: this pull request was born exactly because of the conflict between these two rules and confusion surrounding it. Yes they are indeed similar, but they are also in conflict and the most restrictive one wins.
I have adjusted the wording a bit based on @cortinico 's comment.
schalkms
reviewed
Sep 2, 2019
There was a problem hiding this comment.
@AlexCzar We are really thankful for this doc improvement. Can you please checkout the source file of the WildcardImportRule and add this to the documentation there?
We generate the Markdown documentation for our website based on these source files. This means you need to execute gradle build once on your local machine.
A bit of a language adjustment for the rule clash description.
cortinico
approved these changes
Sep 2, 2019
schalkms
approved these changes
Sep 4, 2019
sowmyav24
pushed a commit
to sowmyav24/detekt
that referenced
this pull request
Sep 17, 2019
* Clarify `WildcardImport` rule configuration Add information about conflict between `formatting:``NoWildcardImports` and `style:``WildcardImport` rules. * NoWildcardImports/WildcardImport clash wording A bit of a language adjustment for the rule clash description. * Regenerate rules documentation (style.md)
sowmyav24
pushed a commit
to sowmyav24/detekt
that referenced
this pull request
Sep 17, 2019
* Clarify `WildcardImport` rule configuration Add information about conflict between `formatting:``NoWildcardImports` and `style:``WildcardImport` rules. * NoWildcardImports/WildcardImport clash wording A bit of a language adjustment for the rule clash description. * Regenerate rules documentation (style.md)
smyachenkov
pushed a commit
to smyachenkov/detekt
that referenced
this pull request
Dec 9, 2019
* Clarify `WildcardImport` rule configuration Add information about conflict between `formatting:``NoWildcardImports` and `style:``WildcardImport` rules. * NoWildcardImports/WildcardImport clash wording A bit of a language adjustment for the rule clash description. * Regenerate rules documentation (style.md)
smyachenkov
pushed a commit
to smyachenkov/detekt
that referenced
this pull request
Dec 9, 2019
* Clarify `WildcardImport` rule configuration Add information about conflict between `formatting:``NoWildcardImports` and `style:``WildcardImport` rules. * NoWildcardImports/WildcardImport clash wording A bit of a language adjustment for the rule clash description. * Regenerate rules documentation (style.md)
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.
Add information about conflict between
formatting:NoWildcardImportsandstyle:WildcardImportrules.There is a conflict between
formatting:NoWildcardImportsandstyle:WildcardImport, effectively the latter and its configuration do not matter when former is enabled. This PR adds a note about the fact to the documentation.