From d35649adb4207d21a504fc93c58d1456ede4fa0e Mon Sep 17 00:00:00 2001 From: Matthew Haughton <3flex@users.noreply.github.com> Date: Mon, 1 Aug 2022 15:11:18 +1000 Subject: [PATCH] Revert "Add information about exhaustiveness check to documentation (#5160)" This reverts commit d50bd957916d63a8f10423344a77205b0f74a4cf. --- website/docs/introduction/configurations.md | 6 ------ 1 file changed, 6 deletions(-) diff --git a/website/docs/introduction/configurations.md b/website/docs/introduction/configurations.md index 5b8a908e669..f2fd226b221 100644 --- a/website/docs/introduction/configurations.md +++ b/website/docs/introduction/configurations.md @@ -27,17 +27,11 @@ If config validation is enabled, _detekt_ will verify that your configuration fi config: validation: true warningsAsErrors: false - checkExhaustiveness: false excludes: '' ``` Invalid or deprecated rules and configuration options are by default printed as warnings unless `warningsAsErrors` is set to `true`. -### Checking for exhaustiveness -If you want to make a conscious decision about activation of every available first party rule, you can set `checkExhaustiveness` to `true`. This will typically happen when new rules become available after updating _detekt_. -You can deactivate all rules from a specific rule set and the exhaustiveness check for this rule set by marking it with `active: false`. - -### Excluding custom properties _Note:_ Custom rules sets are excluded from config validation by default. If you have extended _detekt_ and rely on a custom properties, you will need to exclude those from config validation by adding their paths to the `excludes` attribute. Multiple values are separated by comma and `.*` can be used as a wildcard (e.g. `propA,build>.*>propB`).