assurance-maladie / qualytou
Outils d'analyse statique pour PHP
Package info
github.com/assurance-maladie-digital/qualytou
Type:composer-plugin
pkg:composer/assurance-maladie/qualytou
Requires
- php: ^8.1
- composer-plugin-api: ^2.2
- ekino/phpstan-banned-code: ^1.0
- friendsofphp/php-cs-fixer: ^3.48
- phpmd/phpmd: ^2.15
- phpro/grumphp: ^2.4
- phpstan/extension-installer: ^1.3
- phpstan/phpstan: ^1.10
- phpstan/phpstan-deprecation-rules: ^1.1
- phpstan/phpstan-doctrine: ^1.3
- phpstan/phpstan-phpunit: ^1.3
- phpstan/phpstan-symfony: ^1.3
- symfony/filesystem: ^6.4
Requires (Dev)
- composer/composer: ^2.0
- roave/security-advisories: dev-latest
Suggests
None
Provides
None
Conflicts
None
Replaces
None
README
Bienvenue sur Qualytou, l'outil d'analyse statique pour PHP conçu spécialement pour les projets de la CNAM utilisant Symfony.
Découvrez comment rendre votre code plus propre et performant !
🚀 Démarrage Rapide
Commencer avec Qualytou est un jeu d'enfant !
Utilisez Composer pour installer Qualytou dans votre projet :
composer require --dev assurance-maladie/qualytou
🎉 Une fois installé, Qualytou s'occupe de tout !
Des fichiers de configuration sont automatiquement ajoutés à la racine de votre projet,
guidant les outils pour une analyse optimale de votre code.
Pour lancer l'analyse, tapez simplement :
php vendor/bin/grumphp run
⚠️ N'oubliez pas : Qualytou 3 nécessite PHP version 8.1 ou ultérieure.
🌈 Fonctionnalités
Avec Qualytou, bénéficiez d'une panoplie d'analyses pour un code au top :
- PHP Coding Standards Fixer (PHP CS Fixer)
- PHPMD - PHP Mess Detector
- PHPStan - PHP Static Analysis Tool
🛠 Utilisation
Après l'installation rapide,
personnalisez les fichiers de configuration pour une expérience sur mesure.
Exécutez cette commande pour lancer tous les outils en simultané :
php vendor/bin/grumphp run
Ils travailleront ensemble, se concentrant sur les modifications que vous êtes prêt à valider.
🔕 Gestion des Avertissements
Parfois, vous voudrez ignorer certains avertissements.
Sauf pour PHPMD - PHP Mess Detector,
nous recommandons de le faire directement dans les fichiers de configuration :
Ignorer les avertissements dans les fichiers de configuration vous permet de maintenir un code
propre sans y intégrer des spécificités liées aux outils d'analyse.
Et si vous décidez de retirer une règle, votre code restera impeccable.