assurance-maladie / qualytou
Outils d'analyse statique pour PHP
Installs: 12 102
Dependents: 1
Suggesters: 0
Security: 0
Stars: 1
Watchers: 3
Forks: 4
Open Issues: 3
Type:composer-plugin
Requires
- php: ^7.3 || ^8.0
- composer-plugin-api: ^2.0
- ekino/phpstan-banned-code: ^1.0
- friendsofphp/php-cs-fixer: ^3.1
- phpmd/phpmd: ^2.10
- phpro/grumphp: ^1.4
- phpstan/extension-installer: ^1.1
- phpstan/phpstan: ^1.1
- phpstan/phpstan-deprecation-rules: ^1.0
- phpstan/phpstan-doctrine: ^1.0
- phpstan/phpstan-phpunit: ^1.0
- phpstan/phpstan-symfony: ^1.0
- symfony/filesystem: ^4.4 || ^5.1
- vimeo/psalm: ^4.9
Requires (Dev)
- composer/composer: ^2.0
- roave/security-advisories: dev-latest
This package is auto-updated.
Last update: 2024-04-05 17:37:49 UTC
README
Fournit des outils d'analyse statique pour PHP utilisé dans les projets de la CNAM sous Symfony.
Démarrage
La manière la plus simple d'utiliser Qualytou est via Composer.
composer require --dev assurance-maladie/qualytou
Une fois Qualytou installé, les fichiers de configurations sont automatiquement
installés à la racine dans votre projet pour indiquer aux outils comment
analyser votre code source.
Une fois configuré, vous pouvez le lancer via php vendor/bin/grumphp run.
Qualytou 2 dépend de PHP 7.3+.
Fonctionnalités
Qualytou est capable d'effectuer les types d'analyse suivants :
- PHP Coding Standards Fixer (PHP CS Fixer)
- PHPMD - PHP Mess Detector
- PHPStan - PHP Static Analysis Tool
- Psalm
Utilisation
Après avoir installé Qualytou, Qualytou a configuré
automatiquement les fichiers des outils.
Il est donc possible de personnaliser chaque fichier de configuration.
Cette commande php vendor/bin/grumphp run execute donc tous les outils en
parallèle, mais uniquement pour les modifications qui seront validées.
Suppression des avertissements
Dans certains cas, il est préférable d'ignorer les avertissements.
Excepté pour PHPMD - PHP Mess Detector il est conseillé
d'ignorer les avertissements dans les fichiers de configuration :
Ignorer les avertissements dans les fichiers de configuration permet de ne pas
ajouter du code spécifique pour les outils d'analyses statiques.
Si vous décidez d'en supprimer un, votre code restera propre.