slevomat/coding-standard

Slevomat Coding Standard for PHP_CodeSniffer complements Consistence Coding Standard by providing sniffs with additional checks.

Wednesday, August 1, 2018
by slevomat
Repository
26 Watchers
285 Stars
535,336 Installations

PHP
212 Dependents
0 Suggesters
43 Forks
13 Open issues
68 Versions
31 % Grown

The README.md

Slevomat Coding Standard

, _(*1)

Slevomat Coding Standard for PHP_CodeSniffer provides sniffs that fall into three categories:, _(*2)

Functional - improving the safety and behaviour of code
Cleaning - detecting dead code
Formatting - rules for consistent code looks

Alphabetical list of sniffs
Installation
How to run the sniffs
- Choose which sniffs to run
- Exclude sniffs you don't want to run
Fixing errors automatically
Suppressing sniffs locally
Contributing

Alphabetical list of sniffs

🔧 = Automatic errors fixing, _(*3)

🚧 = Sniff check can be suppressed locally, _(*4)

Installation

The recommended way to install Slevomat Coding Standard is through Composer., _(*5)

{
    "require-dev": {
        "slevomat/coding-standard": "~8.0"
    }
}

It's also recommended to install php-parallel-lint/php-parallel-lint which checks source code for syntax errors. Sniffs count on the processed code to be syntactically valid (no parse errors), otherwise they can behave unexpectedly. It is advised to run PHP-Parallel-Lint in your build tool before running PHP_CodeSniffer and exiting the build process early if PHP-Parallel-Lint fails., _(*6)

How to run the sniffs

You can choose one of two ways to run only selected sniffs from the standard on your codebase:, _(*7)

Choose which sniffs to run

The recommended way is to write your own ruleset.xml by referencing only the selected sniffs. This is a sample ruleset.xml:, _(*8)

<?xml version="1.0"?>
<ruleset name="AcmeProject">
    <config name="installed_paths" value="../../slevomat/coding-standard"/><!-- relative path from PHPCS source location -->
    <rule ref="SlevomatCodingStandard.Arrays.TrailingArrayComma"/>
    <!-- other sniffs to include -->
</ruleset>

Then run the phpcs executable the usual way:, _(*9)

vendor/bin/phpcs --standard=ruleset.xml --extensions=php --tab-width=4 -sp src tests

Exclude sniffs you don't want to run

You can also mention Slevomat Coding Standard in your project's ruleset.xml and exclude only some sniffs:, _(*10)

<?xml version="1.0"?>
<ruleset name="AcmeProject">
    <rule ref="vendor/slevomat/coding-standard/SlevomatCodingStandard/ruleset.xml"><!-- relative path to your ruleset.xml -->
        <!-- sniffs to exclude -->
    </rule>
</ruleset>

However it is not a recommended way to use Slevomat Coding Standard, because your build can break when moving between minor versions of the standard (which can happen if you use ^ or ~ version constraint in composer.json). We regularly add new sniffs even in minor versions meaning your code won't most likely comply with new minor versions of the package., _(*11)

Fixing errors automatically

Sniffs in this standard marked by the 🔧 symbol support automatic fixing of coding standard violations. To fix your code automatically, run phpcbf instead of phpcs:, _(*12)

vendor/bin/phpcbf --standard=ruleset.xml --extensions=php --tab-width=4 -sp src tests

Always remember to back up your code before performing automatic fixes and check the results with your own eyes as the automatic fixer can sometimes produce unwanted results., _(*13)

Suppressing sniffs locally

Selected sniffs in this standard marked by the 🚧 symbol can be suppressed for a specific piece of code using an annotation. Consider the following example:, _(*14)

/**
 * @param int $max
 */
public function createProgressBar($max = 0): ProgressBar
{

}

The parameter $max could have a native int scalar typehint. But because the method in the parent class does not have this typehint, so this one cannot have it either. PHP_CodeSniffer shows a following error:, _(*15)

----------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
----------------------------------------------------------------------
 67 | ERROR | [x] Method ErrorsConsoleStyle::createProgressBar()
    |       |     does not have native type hint for its parameter $max
    |       |     but it should be possible to add it based on @param
    |       |     annotation "int".
    |       |     (SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint)

If we want to suppress this error instead of fixing it, we can take the error code (SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint) and use it with a @phpcsSuppress annotation like this:, _(*16)

/**
 * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint
 * @param int $max
 */
public function createProgressBar($max = 0): ProgressBar
{

}

Contributing

To make this repository work on your machine, clone it and run these two commands in the root directory of the repository:, _(*17)

composer install
bin/phing

After writing some code and editing or adding unit tests, run phing again to check that everything is OK:, _(*18)

bin/phing

We are always looking forward to your bugreports, feature requests and pull requests. Thank you., _(*19)

Code of Conduct

This project adheres to a Contributor Code of Conduct. By participating in this project and its community, you are expected to uphold this code., _(*20)

The Versions

01/08 2018

dev-master

9999999-dev

Slevomat Coding Standard for PHP_CodeSniffer complements Consistence Coding Standard by providing sniffs with additional checks.

phpcodesniffer-standard coding-standard