README

Bevat files voor de coding standaarden die gehanteerd worden binnen PAQT. Het bevat coding standaarden voor phpstan, phpmd, phpcs en php cs fixer.

Installeren

Voeg de dependency toe als een (dev) dependency via Composer.

composer require paqtcom/coding-standards --dev

Let op! Hiermee zijn nog niet alle benodigde tools geïnstalleerd. Deze package bevat enkel configuratie bestanden.

Configuratie

phpcs

Voeg een phpcs.xml bestand toe aan je project met de volgende minimale configuratie:

<?xml version="1.0"?>
<ruleset name="PAQT.com phpcs configuration">
    <description>PAQT.com ruleset for PHP projects.</description>

    <file>app</file>
    <file>src</file>
    ...

    <rule ref="vendor/paqtcom/coding-standards/rules/phpcs.xml" />
</ruleset>

vendor/bin/phpcs -ps

Veel van de beschikbare phpcs configuratie kan worden gebruikt voor onder andere het toevoegen van mappen die gescand of genegeerd moeten worden of wanneer voorgedefinieerde regels aangepast of genegeerd moeten worden:

<rule ref="vendor/paqtcom/coding-standards/rules/phpcs.xml" />

<rule ref="PSR1.Classes.ClassDeclaration.MissingNamespace">
    <exclude-pattern>database/*</exclude-pattern>
</rule>

php-cs-fixer

Voeg een .php-cs-fixer.php bestand toe aan je project met de volgende minimale configuratie:

<?php

$finder = PhpCsFixer\Finder::create()
    ->in(__DIR__)
    ->path([
        '/^app/',
        '/^src/',
        ...
    ]);

/** @var PhpCsFixer\Config $config */
$config = include 'vendor/paqtcom/coding-standards/rules/php-cs-fixer.php';

return $config->setFinder($finder);

vendor/bin/php-cs-fixer fix --dry-run --diff --show-progress=dots --verbose

Veel van de beschikbare php-cs-fixer regels kunnen worden gebruikt om de voorgedefinieerde regels aan te passen of extra regels toe te voegen:

return $config->setFinder($finder)
    ->setRules(
        array_merge($config->getRules(), [
            'no_space_around_double_colon' => false,
        ])
    );

Let op: het gebruik van array_merge($config->getRules(), []) is nodig om de voorgedefinieerde regels aan te vullen.

phpmd

Voeg een phpmd.xml bestand toe aan je project met de volgende minimale configuratie:

<?xml version="1.0"?>
<ruleset name="PAQT.com phpmd configuration"
         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">

    <rule ref="vendor/paqtcom/coding-standards/rules/phpmd.xml" />
</ruleset>

vendor/bin/phpmd app src ... phpmd.xml

Veel van de beschikbare phpmd regels kunnen worden gebruikt in de configuratie om bijvoorbeeld de voorgedefinieerde regels aan te passen of extra regels toe te voegen:

<rule ref="vendor/paqtcom/coding-standards/rules/phpmd.xml" />

<rule ref="rulesets/codesize.xml/CyclomaticComplexity">
    <priority>1</priority>
    <properties>
        <property name="reportLevel" value="5" />
    </properties>
</rule>

<rule ref="rulesets/naming.xml">
    <exclude name="LongVariable" />
</rule>

phpstan

Voeg een phpstan.neon bestand toe aan je project met de volgende minimale configuratie:

includes:
    - ./vendor/paqtcom/coding-standards/rules/phpstan.neon

parameters:
    paths:
        - app
        - src
        ...

Of wanneer het gaat om een Laravel project:

includes:
    - ./vendor/paqtcom/coding-standards/rules/larastan.neon

parameters:
    paths:
        - app
        - src
        ...

vendor/bin/phpstan analyze --memory-limit=2G

Veel van de beschikbare phpstan configuratie kan worden gebruikt voor het aanpassen van onder andere voorgedefinieerde regels of eventueel errors die genegeerd mogen worden:

parameters:
    ignoreErrors:
        - '#Parameter \#3 \$count of method Illuminate\\Database\\Eloquent\\Builder(.*)::has\(\) expects int, Illuminate\\Database\\Query\\Expression given.#'

    checkUnionTypes: false

phpcpd

vendor/bin/phpcpd app src ...

Voor het gebruik van phpcpd is geen configuratie nodig.

paqtcom / coding-standards

Maintainers

Details