How to configure PHP_CodeSniffer code standards?

By default, Codacy uses the PHP_CodeSniffer configuration on the Code patterns page when analyzing your repositories.

To enforce a specific PHP_CodeSniffer code standard you must create a configuration file on the root of your repository that references one or more of the following code standards:

• Default code standards packaged together with PHP_CodeSniffer:

  https://github.com/squizlabs/PHP_CodeSniffer/tree/master/src/Standards

• Additional code standards that Codacy packages on the PHP_CodeSniffer tool plugin. Check the repository the additional code standards to learn how you can reference them in your configuration files:

  https://github.com/codacy/codacy-codesniffer/blob/master/composer.json

For example, create a text file with the name .phpcs.xml to use the PSR12 coding standard but excluding the sniffs Generic.WhiteSpace.DisallowTabIndent and PSR12.Operators.OperatorSpacing:

<?xml version="1.0"?>
<ruleset name="PHP_CodeSniffer">
  <description>PHP_CodeSniffer configuration</description>
  <rule ref="PSR12">
    <exclude name="Generic.WhiteSpace.DisallowTabIndent"/>
    <exclude name="PSR12.Operators.OperatorSpacing"/>
  </rule>
</ruleset>

See also

Check these external resources for more help on customizing your PHP_CodeSniffer configuration:

• PHP_CodeSniffer configuration file syntax
• PHP Coding Standard Generator

Feedback

Did this page help you?

Yes No

Thank you for the feedback!

We're sorry to hear that. Please let us know what we can improve.

If you have a question, please ask our community or contact support@codacy.com.

Last modified April 13, 2021