Possible to make PHPCS ignore one given rule for a particular file?

[rodrigoprimo]

I wonder if it is possible to make PHPCS ignore one given rule for a particular file or line of code? Sometimes for different reasons I have to use // @codingStandardsIgnoreLine but this will make PHPCS completely ignore the line.

As a example, I would like to be able to do something like // @codingStandardsIgnoreLine Generic.WhiteSpace.ScopeIndent to make PHPCS ignore just indentation for the line. Is there a way to do that?

[gsherwood]

There is no way to do this using annotations in your files. See issue #604 for a feature request.

You can add exclusions for entire files using a ruleset.xml file. See https://github.com/squizlabs/PHP_CodeSniffer/wiki/Annotated-ruleset.xml for an example of hard-coding exclude patterns for specific sniffs. But you cannot do this for individual lines.

[geoffreyvanwyk]

Put this at the top of the file:

// phpcs:disable PSR1.Classes.ClassDeclaration.MissingNamespace

[linaori]

@systemovich this does not work for me in combination with slevomat, it will either remove the comment or keep complaining. No other solution than to remove it for me.

[jrfnl]

@iltar Not sure about the details of your issue, but...

1. You can add the annotation to a file docblock like so:

   <?php
   /**
    * File description
    *
    * @tags
    * @phpcs:disable Standard.Cat.SniffName
    */

2. You can exclude a file for a particular rule or errorcode from a custom ruleset:

   <rule ref="Standard.Cat.SniffName.ErrorCode">
       <exclude-pattern>/path/to/file\.php</exclude-pattern>
   </rule>

[linaori]

@jrfnl That seems to work, thanks!

[bkdotcom]

Now we just need the ability to do it at the class and method level
#2367

[tiagofrancafernandes]

Put this at the top of the file:

// phpcs:disable PSR1.Classes.ClassDeclaration.MissingNamespace

Can you show a example?

[jrfnl]

@tiagofrancafernandes See #1179 (comment)

[darius-v]

@iltar Not sure about the details of your issue, but...

1. You can add the annotation to a file docblock like so:

   <?php
   /**
    * File description
    *
    * @tags
    * @phpcs:disable Standard.Cat.SniffName
    */
   

2. You can exclude a file for a particular rule or errorcode from a custom ruleset:

   <rule ref="Standard.Cat.SniffName.ErrorCode">
       <exclude-pattern>/path/to/file\.php</exclude-pattern>
   </rule>
   

is the @tags needed? or this is just example of other random tags? I tried without @tags and for me it did not work

[darius-v]

@systemovich this does not work for me in combination with slevomat, it will either remove the comment or keep complaining. No other solution than to remove it for me.

I also cannot make it work with

SlevomatCodingStandard.TypeHints.DeclareStrictTypes rule unless I add exclude pattern tag in phpcs.xml

[jrfnl]

is the @tags needed? or this is just example of other random tags? I tried without @tags and for me it did not work

@tags was just an example of other random tags and should not be needed.