Ability to ignore certain extensions

[MartinMystikJonas]

In our setup we use just few handpicked rules from some opinionated extensions. When we use extension installer all rules from these extensions are included. It would ne nice to have option to disable loading of certain extensions.

[ondrejmirtes]

If you want some extension to be configurable, please open a feature request at that extension. It's possible to do it with the help of conditionalTags section in .neon files, like here for example: https://github.com/phpstan/phpstan-src/blob/d866a66f6e43abac86c697f28dc780904dc5399b/conf/config.neon#L380-L390

[MartinMystikJonas]

One example is phpstan-strict-rules. We want to use few of these rules but not entire strict rule set. So I should open issue/PR in phpstan-strict-rules for config value to turn off all rules?

[MartinMystikJonas]

Now I see this issue is already there and closed https://github.com/phpstan/phpstan-strict-rules/issues/150

So if I want to use it with extension loader I should prepare PR and add config to turn or rules?

[ondrejmirtes]

Yes please :)

Here's an example of a single rule converted to a new config parameter:

diff --git a/rules.neon b/rules.neon
index d70a911..07a7e2a 100644
--- a/rules.neon
+++ b/rules.neon
@@ -14,9 +14,15 @@ parameters:
    reportMaybesInPropertyPhpDocTypes: true
    featureToggles:
        illegalConstructorMethodCall: %featureToggles.bleedingEdge%
+   strictRules:
+       booleansInConditions: true
+
+parametersSchema:
+   strictRules: structure([
+       booleansInConditions: bool()
+   ])

 rules:
-   - PHPStan\Rules\BooleansInConditions\BooleanInBooleanAndRule
    - PHPStan\Rules\BooleansInConditions\BooleanInBooleanNotRule
    - PHPStan\Rules\BooleansInConditions\BooleanInBooleanOrRule
    - PHPStan\Rules\BooleansInConditions\BooleanInElseIfConditionRule
@@ -55,6 +61,8 @@ rules:
 conditionalTags:
    PHPStan\Rules\DisallowedConstructs\DisallowedLooseComparisonRule:
        phpstan.rules.rule: %featureToggles.bleedingEdge%
+   PHPStan\Rules\BooleansInConditions\BooleanInBooleanAndRule:
+       phpstan.rules.rule: %strictRules.booleansInConditions%

 services:
    -
@@ -78,3 +86,6 @@ services:

    -
        class: PHPStan\Rules\DisallowedConstructs\DisallowedLooseComparisonRule
+
+   -
+       class: PHPStan\Rules\BooleansInConditions\BooleanInBooleanAndRule

[MartinMystikJonas]

So this would allow to disable rules one by one. Would it be possible to add another config value to turn off all strict rules unless explicitly enabled? It might be more convenient for people that wants to use just few rules.

[ondrejmirtes]

There could be a "turn-off-all-rules.neon" file in the repo.

[MartinMystikJonas]

@ondrejmirtes Would this be valid approach to configuration too?

strictRules:
    enabled: true
    booleansInConditions: %strictRules.enabled%
    cast: %strictRules.enabled%
    classes: %strictRules.enabled%
    disallowedConstructs: %strictRules.enabled%
    foreachLoop: %strictRules.enabled%
    forLoop: %strictRules.enabled%
    functions: %strictRules.enabled%
    methods: %strictRules.enabled%
    operators: %strictRules.enabled%
    strictCalls: %strictRules.enabled%
    switchConditions: %strictRules.enabled%
    variableVariables: %strictRules.enabled%

All rules would be disabled by

strictRules:
  enabled: false

and the rules could be enabled either by configs:

strictRules:
  enabled: false
  booleansInConditions: true

or by manually adding rules/services.

[MartinMystikJonas]

First draft here: https://github.com/MartinMystikJonas/phpstan-strict-rules/commit/fe0674e8b28bf408b0c80d89a9dbbf52e3171e9f

[MartinMystikJonas]

PR ready here: https://github.com/phpstan/phpstan-strict-rules/pull/182

[github-actions[bot]]

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.