Skip to content

README.md

Latest commit

 

History

History
64 lines (46 loc) · 1.27 KB

README.md

File metadata and controls

64 lines (46 loc) · 1.27 KB

Arty Coding Style

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.
  • PHPAt as phpstan extension for architecture validation

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

PHPAT

Validate Architecture.

A minimal Clean Architecture validation is provided, activate it by adding this to your phpstan.neon:

services:
    -
        class: ArtyCodingStandard\PHPAt\CleanArchitectureTest
        tags:
            - phpat.test