Coder sans filet, vraiment ?

Pourquoi l’analyse statique change vraiment la donne

Détection précoce des bugs

• Les erreurs de types (TypeError latents)
• Les accès à des propriétés ou méthodes inexistantes
• Les variables non initialisées
• Les code paths jamais atteints
• Les retours de fonction incompatibles avec leur signature

Documentation vivante du code

Refactoring en confiance

Uniformisation du code

Automatisation naturelle

Les outils de l’arsenal

PHP CS Fixer — le gardien du style

Installation

[pastacode lang= »bash » manual= »composer%20require%20–dev%20friendsofphp%2Fphp-cs-fixer » message= » » highlight= » » provider= »manual »/]

Configuration (.php-cs-fixer.php)

[pastacode lang= »php » manual= »%24finder%20%3D%20PhpCsFixer%5CFinder%3A%3Acreate()%0A%20%20%20%20-%3Ein(%5B__DIR__%20.%20’%2Fsrc’%2C%20__DIR__%20.%20’%2Ftests’%5D)%0A%20%20%20%20-%3Eexclude(%5B’var’%2C%20’vendor’%5D)%3B%0A%0Areturn%20(new%20PhpCsFixer%5CConfig())%0A%20%20%20%20-%3EsetRules(%5B%0A%20%20%20%20%20%20%20%20’%40PER-CS’%20%3D%3E%20true%2C%0A%20%20%20%20%20%20%20%20’%40Symfony’%20%3D%3E%20true%2C%0A%20%20%20%20%20%20%20%20’%40autoPHPMigration’%20%3D%3E%20true%2C%0A%20%20%20%20%20%20%20%20’array_syntax’%20%3D%3E%20%5B’syntax’%20%3D%3E%20’short’%5D%2C%0A%20%20%20%20%20%20%20%20’ordered_imports’%20%3D%3E%20%5B’sort_algorithm’%20%3D%3E%20’alpha’%5D%2C%0A%20%20%20%20%20%20%20%20’no_unused_imports’%20%3D%3E%20true%2C%0A%20%20%20%20%20%20%20%20’strict_comparison’%20%3D%3E%20true%2C%0A%20%20%20%20%5D)%0A%20%20%20%20-%3EsetFinder(%24finder)%3B » message= » » highlight= » » provider= »manual »/]

Utilisation

[pastacode lang= »bash » manual= »%23%20V%C3%A9rifier%20sans%20corriger%20(pour%20la%20CI)%0Avendor%2Fbin%2Fphp-cs-fixer%20fix%20–dry-run%20–diff%0A%0A%23%20Corriger%0Avendor%2Fbin%2Fphp-cs-fixer%20fix » message= » » highlight= » » provider= »manual »/]

Ce que CS Fixer normalise

• Indentation, espaces, sauts de ligne
• Ordre et groupement des use
• Déclarations strict_types
• Casts, opérateurs, virgules trailing
• PHPDoc et annotations

PHPStan — l’analyse statique de référence

Installation

[pastacode lang= »bash » manual= »composer%20require%20–dev%20phpstan%2Fphpstan%0Acomposer%20require%20–dev%20phpstan%2Fextension-installer%0Acomposer%20require%20–dev%20phpstan%2Fphpstan-symfony%0Acomposer%20require%20–dev%20phpstan%2Fphpstan-doctrine » message= » » highlight= » » provider= »manual »/]

Configuration (phpstan.neon)

[pastacode lang= »bash » manual= »parameters%3A%0A%20%20%20%20level%3A%206%0A%20%20%20%20paths%3A%0A%20%20%20%20%20%20%20%20-%20src%0A%20%20%20%20%20%20%20%20-%20tests%0A%20%20%20%20symfony%3A%0A%20%20%20%20%20%20%20%20containerXmlPath%3A%20var%2Fcache%2Fdev%2FApp_KernelDevDebugContainer.xml%0A%20%20%20%20ignoreErrors%3A%0A%20%20%20%20%20%20%20%20-%20’%23Call%20to%20an%20undefined%20method%20Doctrine%5C%5CORM%5C%5CQueryBuilder%23′ » message= » » highlight= » » provider= »manual »/]

Les niveaux de rigueur (0 à 10)

Ce que PHPStan détecte

[pastacode lang= »php » manual= »%2F%2F%20PHPStan%20niveau%205%2B%20d%C3%A9tecte%20ce%20probl%C3%A8me%0Aclass%20UserService%0A%7B%0A%20%20%20%20public%20function%20findUser(int%20%24id)%3A%20User%0A%20%20%20%20%7B%0A%20%20%20%20%20%20%20%20return%20%24this-%3Erepository-%3Efind(%24id)%3B%20%2F%2F%20%E2%9A%A0%EF%B8%8F%20retourne%20User%7Cnull%2C%20pas%20User%20!%0A%20%20%20%20%7D%0A%7D » message= » » highlight= » » provider= »manual »/]

------ -----------------------------------------------
 Line   src/Service/UserService.php
------ -----------------------------------------------
 8      Method UserService::findUser() should return
        App\Entity\User but returns App\Entity\User|null.
------ ----------------------------------------------

Baseline : apprivoiser un projet legacy

Rector — bien plus qu’un outil de migration

Installation

[pastacode lang= »bash » manual= »composer%20require%20–dev%20rector%2Frector%0Acomposer%20require%20–dev%20tomasvotruba%2Ftype-coverage » message= » » highlight= » » provider= »manual »/]

Rector comme outil de réduction de dette — sans migration

Quand activer les sets de migration

Mode dry-run : toujours vérifier avant d’appliquer

[pastacode lang= »php » manual= »%23%20Aper%C3%A7u%20des%20changements%20sans%20les%20appliquer%0Avendor%2Fbin%2Frector%20process%20–dry-run%0A%0A%23%20Application%20r%C3%A9elle%0Avendor%2Fbin%2Frector%20process » message= » » highlight= » » provider= »manual »/]

Levels : petit pas par petit pas

[pastacode lang= »php » manual= »use%20Rector%5CConfig%5CRectorConfig%3B%0A%0Areturn%20RectorConfig%3A%3Aconfigure()%0A%20%20%20%20-%3EwithTypeCoverageLevel(0)%0A%20%20%20%20-%3EwithTypeCoverageDocblockLevel(0)%0A%20%20%20%20-%3EwithDeadCodeLevel(0)%0A%20%20%20%20-%3EwithCodeQualityLevel(0)%0A%20%20%20%20-%3EwithCodingStyleLevel(0)%3B » message= » » highlight= » » provider= »manual »/]

Rector Swiss Knife — la boîte à outils complémentaire

Installation

[pastacode lang= »bash » manual= »composer%20require%20–dev%20rector%2Fswiss-knife » message= » » highlight= » » provider= »manual »/]

Fonctionnalités clés

Intégration dans un projet Symfony

Structure du projet

projet/
├── .php-cs-fixer.php
├── phpstan.neon
├── phpstan-baseline.neon
├── rector.php
└── composer.json

Utilisation avec Composer

{
    "scripts": {
        "cs-check": "php-cs-fixer fix --dry-run --diff",
        "cs-fix": "php-cs-fixer fix",
        "stan": "phpstan analyse",
        "rector-check": "rector process --dry-run",
        "rector-fix": "rector process",
        "psr4-fix": "swiss-knife namespace-to-psr-4 src --namespace-root \"App\\\\\"",
        "finalize-fix": "swiss-knife finalize-classes src tests",
        "swiss-check": [
            "swiss-knife check-conflicts .",
            "swiss-knife check-commented-code src tests",
            "swiss-knife find-multi-classes src"
        ],
        "qa": [
            "@cs-check",
            "@stan",
            "@rector-check",
            "@swiss-check"
        ],
        "fix": [
            "@cs-fix",
            "@rector-fix",
            "@psr4-fix",
            "@finalize-fix"
        ]
    }
}

Pipeline CI/CD (GitLab CI)

stages:
  - quality

variables:
  COMPOSER_CACHE_DIR: "$CI_PROJECT_DIR/.composer-cache"

cache:
  key: "${CI_COMMIT_REF_SLUG}"
  paths:
    - .composer-cache/
    - vendor/

image: php:8.2-cli

before_script:
  - apt-get update -yqq && apt-get install -yqq git unzip
  - curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer
  - composer install --no-progress --no-interaction

cs-check:
  stage: quality
  script:
    - composer cs-check
  rules:
    - if: '$CI_PIPELINE_SOURCE == "merge_request_event"'
    - if: '$CI_COMMIT_BRANCH'

phpstan:
  stage: quality
  script:
    - composer phpstan
  rules:
    - if: '$CI_PIPELINE_SOURCE == "merge_request_event"'
    - if: '$CI_COMMIT_BRANCH'

rector:
  stage: quality
  script:
    - composer rector-check
  rules:
    - if: '$CI_PIPELINE_SOURCE == "merge_request_event"'
    - if: '$CI_COMMIT_BRANCH'

swiss:
  stage: quality
  script:
    - composer swiss-check
  rules:
    - if: '$CI_PIPELINE_SOURCE == "merge_request_event"'
    - if: '$CI_COMMIT_BRANCH'

Par où commencer sur un projet existant ?

1. Style et formatage → Intégrez PHP CS Fixer avec les règles @Symfony. Appliquez-le une fois sur toute la base de code, commitez, et activez-le en CI.
2. Analyse statique niveau 0 → Ajoutez Rector en dry-run et mettez en place les nouvelles règles au niveau 0. → Ajoutez PHPStan niveau 0, générez une baseline. Zéro nouvelles erreurs autorisées dès maintenant.
3. Montée en niveau → Montez PHPStan niveau par niveau en corrigeant les erreurs de la baseline au fur et à mesure. Sur un projet existant le niveau 10 peut être trop exigeant, le niveau 6 est généralement suffisant. → Montez progressivement les niveaux des règles de Rector. Dès quelles sont atteintes, vous pourrez introduire de nouvelles règles.
4. Peaufiner le projet → Ajoutez Swiss-knife pour ajouter les dernières amélioration possibles.

Conclusion