Ability to customise $checkedTokens in Generic.CodeAnalysis.EmptyStatement from within a custom rule

[u01jmg3]

• At Generic.CodeAnalysis.EmptyStatement#L41-50 it would be useful to be able to customise $checkedTokens from within a custom rule
  • Currently I have had to edit Generic.CodeAnalysis.EmptyStatement to exclude T_IF but if I could do this within my ruleset it would be much better. Unless I am missing a way of doing this without editing the file?

e.g.

<rule ref="Generic.CodeAnalysis.EmptyStatement">
    <properties>
        <property name="checkedTokens" type="array" value="T_CATCH,T_DO,T_ELSE,T_ELSEIF,T_FOR,T_FOREACH,T_SWITCH,T_TRY,T_WHILE" />
    </properties>
</rule>

[aik099]

👍 to make it configurable.

Just of curiosity how empty statements can be useful to you?

[u01jmg3]

That's a good question 😄
Apart from having the option to choose to configure, sometimes I come across applications with if statements ready for code to be inserted should say extra validation be required and I don't want PHPCS to complain. The very fact PHPCS has checked tokens within its internals suggests there should be the ability to turn tokens on/off at will.

[aik099]

Coding Standard is called as such to enforce standard. Fact, that empty IF exists and user must fill content in should trigger an error, so user know that he must fill code in.

If you don't need that empty IF to happen, then just comment it out.

[u01jmg3]

Yep, I agree but it would still be useful to be able to configure this rule as you can with others. If my suggestion is not applicable then this issue can be closed.

[aik099]

Indeed, that's why I also put +1 before.

[u01jmg3]

👍

[gsherwood]

I've decided to do this in a different way because the sniff pre-dates ruleset files and is showing its age. Instead, I've removed that member var and changed the message codes to include the type of statement that was detected.

So to turn off empty IF statement errors, use this:

<rule ref="Generic.CodeAnalysis.EmptyStatement.DetectedIF">
   <severity>0</severity>
</rule>

Or to turn empty IF statement errors into warnings, use this:

<rule ref="Generic.CodeAnalysis.EmptyStatement.DetectedIF">
  <type>warning</type>
</rule>

The messages codes are:

Generic.CodeAnalysis.EmptyStatement.DetectedCATCH
Generic.CodeAnalysis.EmptyStatement.DetectedDO
Generic.CodeAnalysis.EmptyStatement.DetectedELSE
Generic.CodeAnalysis.EmptyStatement.DetectedELSEIF
Generic.CodeAnalysis.EmptyStatement.DetectedFOR
Generic.CodeAnalysis.EmptyStatement.DetectedFOREACH
Generic.CodeAnalysis.EmptyStatement.DetectedIF
Generic.CodeAnalysis.EmptyStatement.DetectedSWITCH
Generic.CodeAnalysis.EmptyStatement.DetectedTRY
Generic.CodeAnalysis.EmptyStatement.DetectedWHILE

Hopefully that gives you enough flexibility to do what you need without having to change the core sniffs or write your own.

[u01jmg3]

Works perfectly for me - thanks for implementing