Add exhaustiveness check for config validation #5089
Merged
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
Codecov Report
@@ Coverage Diff @@
## main #5089 +/- ##
===========================================
+ Coverage 0 84.92% +84.92%
- Complexity 0 3613 +3613
===========================================
Files 0 502 +502
Lines 0 11886 +11886
Branches 0 2237 +2237
===========================================
+ Hits 0 10094 +10094
- Misses 0 689 +689
- Partials 0 1103 +1103
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
BraisGabin
reviewed
Jul 20, 2022
...in/io/gitlab/arturbosch/detekt/core/config/validation/DeprecatedPropertiesConfigValidator.kt
Show resolved
Hide resolved
...otlin/io/gitlab/arturbosch/detekt/core/config/validation/InvalidPropertiesConfigValidator.kt
Outdated
Show resolved
Hide resolved
Member
|
And thanks for the refactor! This code looks way better now :) |
BraisGabin
reviewed
Jul 21, 2022
...-core/src/main/kotlin/io/gitlab/arturbosch/detekt/core/config/validation/ConfigValidation.kt
Outdated
Show resolved
Hide resolved
BraisGabin
reviewed
Jul 23, 2022
...ain/kotlin/io/gitlab/arturbosch/detekt/core/config/validation/AbstractYamlConfigValidator.kt
Outdated
Show resolved
Hide resolved
...otlin/io/gitlab/arturbosch/detekt/core/config/validation/InvalidPropertiesConfigValidator.kt
Outdated
Show resolved
Hide resolved
...ain/kotlin/io/gitlab/arturbosch/detekt/core/config/validation/MissingRulesConfigValidator.kt
Outdated
Show resolved
Hide resolved
...kotlin/io/gitlab/arturbosch/detekt/core/config/validation/AbstractYamlConfigValidatorSpec.kt
Fixed
Show fixed
Hide fixed
cortinico
reviewed
Jul 30, 2022
Contributor
Author
|
Do we want this feature or should I open a PR with just the refactoring? |
BraisGabin
approved these changes
Aug 7, 2022
Member
|
LGTM |
cortinico
approved these changes
Aug 8, 2022
This was referenced Sep 10, 2022
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 #4873
I know this is a completely different approach than originally outlined and quite a change set but it turned out that checking for exhaustiveness could just be a part of to already existing config validation. If this is not the direction we want to go, just let me know. It is totally fine.
Refactoring prior to adding the feature:
config/validation.ValidateConfig.kt) into separate config validators (one for invalid properties and one for deprecated properties)The feature itself:
checkExhaustiveness: falseto the config block in the detekt default configurationtruethis flag is alsotruea new validator checks if all rules from the default configuration are mentioned in the user config (unless the entire rule set is marked asactive: false)