README

composer require --dev tigitz/phpcs

You only need this package, no need to require manually squizlabs/php_codesniffer.

after require, copy in your path : phpcs.xml.dist and rename to phpcs.xml̀ or add the rule below in your existing phpcs.xml.

<rule ref="./vendor/tigitz/phpcs/src/Geolid/ruleset.xml" />

Usage

Use phpcs normally.

vendor/bin/phpcs

Description

We follow the PSR-2 coding style with additional rules.

Additional rules :

• Private methods and properties MUST not be prefixed with an underscore.
• One space around concatenation operator.
• One space after casting operator.
• Array must be in short syntax.
• Trailing comma : multiline arrays must have comma in all line.
• No more 3 nesting identation levels.
• Minimal length of naming (function, variable, constant...) is 3 chars (except for i, id, em, om, to, ID, TO).
• Object instantiation must always be with parentheses.
• Must have blank line before return statement.
• Must have one space before return typehint.

  public function foo(): self {}

• Php must contains declare(strict_types=1); with one blank line between declaration and php open tag.
• Visibility MUST be declared on all constants (PSR-12).
• No unused imports (use statements).

naming

• Prefix all abstract classes with Abstract except PHPUnit *TestCase. (name of empty abstract not detected for moment).
• Suffix interfaces with Interface.
• Suffix traits with Trait.
• Suffix exceptions with Exception.

Testing

composer test