eventjet/coding-standard

Eventjet Coding Standard

3.18.0 2024-10-31 18:16 UTC

Requires

• php: ^8.1
• dealerdirect/phpcodesniffer-composer-installer: ^0.5 || ^0.6 || ^0.7 || ^1.0
• friendsofphp/php-cs-fixer: ^3.32
• slevomat/coding-standard: ^8.4
• squizlabs/php_codesniffer: ^3.6.1
• webimpress/coding-standard: ^1.1

Requires (Dev)

• phpunit/phpunit: ^10.2

MIT

• Rudolph Gottesheim
• Thomas Rieschl

README

PHP-CS-Fixer

Basic Usage:

Add the following .php-cs-fixer.dist.php file to your project's root:

<?php

declare(strict_types=1);

use Eventjet\CodingStandard\PhpCsFixer\Config;

return Config::basic();

This will create a basic configuration with a Finder that includes everything in . and excludes vendor. If you need a more granular directory specification, you can pass a custom Finder:

<?php

declare(strict_types=1);

use Eventjet\CodingStandard\PhpCsFixer\Config;
use PhpCsFixer\Finder;

$finder = Finder::create()->in(['features', 'module', 'tests'])->exclude('tests/fixtures');
return Config::basic($finder);

More strict rules:

To use the strict rules, use the strict method::

<?php

declare(strict_types=1);

use Eventjet\CodingStandard\PhpCsFixer\Config;

return Config::strict();

The strict rules enforce a union syntax for nullable types, a certain method order and trailing commas everywhere. See the file for details.

PHPCS

Basic Usage:

Add the following phpcs.xml file to your project's root:

<?xml version="1.0"?>
<ruleset>
    <rule ref="Eventjet"/>

    <file>src</file>
    <file>tests</file>
</ruleset>

More strict rules:

There is also a more strict ruleset which forces type hints and return types to be set.

This sniff can be problematic: If you implement interfaces or have your own interfaces which don't have parameter type hints and return types set or if you are on legacy code, enforcing this sniff would lead to a BC break. This sniff is also set to phpcs-only, so phpcbf won't fix errors automatically.

To use this ruleset, just use the corresponding rule name in your phpcs rule ref instead of the default one:

<?xml version="1.0"?>
<ruleset>
    <rule ref="EventjetStrict"/>

    <file>src</file>
    <file>tests</file>
</ruleset>

Excluding sniffs:

For certain files:

To exclude a sniff for a certain set of files, reference the rule explicitly and add an exclude pattern:

<rule ref="SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint">
    <exclude-pattern>*Interface.php</exclude-pattern>
</rule>

Suppressing sniffs locally

To suppress a sniff directly in the code, use the @phpcsSuppress annotation:

/**
 * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint
 * @param int $bar
 */
public function foo($bar = 0): int
{
}

More info on this can be found here.

Exclude a whole sniff:

It is also possible to exclude a sniff completely:

<?xml version="1.0"?>
<ruleset>
    <rule ref="Eventjet">
        <exclude name="SlevomatCodingStandard.Classes.ClassConstantVisibility"/>
    </rule>

    <file>src</file>
    <file>tests</file>
</ruleset>