arty/php-coding-standard

Static analysis tools config for PHP projects, by arty.

v1.0.4 2024-10-27 15:18 UTC

Requires

• php: ^8.3
• jangregor/phpstan-prophecy: ^1.0
• phpmd/phpmd: ^2.15
• phpspec/prophecy-phpunit: ^2.1
• phpstan/phpstan: ^1.10
• phpstan/phpstan-phpunit: ^1.3
• phpunit/phpunit: ^10.5 || ^11.0
• slevomat/coding-standard: ^8.14
• squizlabs/php_codesniffer: ^3.8

Requires (Dev)

• roave/security-advisories: dev-latest

MIT

README

This is the coding style tools config I use everyday on my projects.

it includes :

• PHPCS for code sniffing.
• PHPStan for static bug finding into code.
• PHPMD for static performance analysis (complexity, unused expressions, optimizing).

Installation

Installation with composer :

composer require arty/php-coding-standard --dev

Usage

PHPCS

In your project, create a phpcs.xml file and fill it up with :

<?xml version="1.0"?>
<ruleset name="Arty Coding Standard" 
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
         xsi:noNamespaceSchemaLocation="../../vendor/squizlabs/php_codesniffer/phpcs.xsd">
    <rule ref="./vendor/arty/php-coding-standard/lib/phpcs/phpcs.xml" />
</ruleset>

Run it with :

$ ./vendor/bin/phpcs src

PHPStan

In your project, create a phpstan.neon file and fill it up with :

includes:
    - vendor/arty/php-coding-standard/lib/phpstan/phpstan.neon

Run it with :

$ ./vendor/bin/phpstan analyse --level=max src

PHPMD

In your project, create a phpmd.xml file and fill it up with :

<?xml version="1.0"?>
<ruleset name="Arty ruleset"
         xmlns="http://pmd.sf.net/ruleset/1.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://pmd.sf.net/ruleset/1.0.0 http://pmd.sf.net/ruleset_xml_schema.xsd"
         xsi:noNamespaceSchemaLocation="http://pmd.sf.net/ruleset_xml_schema.xsd">
    <description>
        Arty ruleset
    </description>

    <rule ref="./vendor/arty/php-coding-standard/lib/phpmd/phpmd.xml"/>
</ruleset>

Run it with :

$ ./vendor/bin/phpmd src text phpmd.xml