Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 2,259 Commits
.github		.github
SlevomatCodingStandard		SlevomatCodingStandard
build		build
doc		doc
temp		temp
tests		tests
.editorconfig		.editorconfig
.gitattributes		.gitattributes
.gitignore		.gitignore
.typos.toml		.typos.toml
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
LICENSE.md		LICENSE.md
README.md		README.md
autoload-bootstrap.php		autoload-bootstrap.php
build.xml		build.xml
codecov.yml		codecov.yml
composer.json		composer.json
phpunit.xml.dist		phpunit.xml.dist

Repository files navigation

Slevomat Coding Standard

Slevomat Coding Standard forPHP_CodeSniffer provides sniffs that fall into three categories:

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

Alphabetical list of sniffs

🔧 =Automatic errors fixing

🚧 =Sniff check can be suppressed locally

Installation

The recommended way to install Slevomat Coding Standard isthrough Composer.

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

It's also recommended to installphp-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 runPHP-Parallel-Lint in your build tool before runningPHP_CodeSniffer and exiting the build process early ifPHP-Parallel-Lint fails.

How to run the sniffs

You can choose one of two ways to run only selected sniffs from the standard on your codebase:

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:

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

Then run thephpcs executable the usual way:

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'sruleset.xml and exclude only some sniffs:

<?xml version="1.0"?><rulesetname="AcmeProject"><ruleref="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 incomposer.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.

Fixing errors automatically

Sniffs in this standard marked by the 🔧 symbol supportautomatic fixing of coding standard violations. To fix your code automatically, run phpcbf instead of phpcs:

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.

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:

/** * @param int $max */publicfunctioncreateProgressBar($max =0):ProgressBar{}

The parameter$max could have a nativeint 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:

----------------------------------------------------------------------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:

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