twc/code-quality-plugin

pre-configure fixer and analyse code quality

v3.0.3 2022-12-16 14:11 UTC

Requires

• php: ^7.2|^8.1
• composer-plugin-api: ^1.1|^2.0
• composer/composer: ^1.1|^2.0
• friendsofphp/php-cs-fixer: ^3.0
• phpstan/phpstan: ^1.0
• squizlabs/php_codesniffer: ^3.5
• symfony/filesystem: ^4.0|^5.0
• symfony/finder: ^4.0|^5.0
• symfony/framework-bundle: ^4.0|^5.0
• symfony/process: ^4.0|^5.0

Requires (Dev)

• phpunit/phpunit: ^7.0

MIT

README

Plugin composer permettant la mise en place d'outils pour une analyse qualité et respect des standards sur un projet symfony.

Pré-requis

• git >=2.17
• symfony (website-skeleton) >=4.4 ou symfony >=4.4 (skeleton) avec le pack symfony/test-pack
• composer 2.x

Installation

composer require twc/code-quality-plugin --dev

If you use composer v1.x try

composer require twc/code-quality-plugin:^1.0 --dev

Après l'installation plusieurs élements auront été créés.

Utilisation

Une fois installé lors de vos commits les actions suivantes seront réalisées.

• Fix du code avec php cs fixer
• Fix du code avec php code sniffer
• Analyse statique du code avec phpstan

La moindre erreur arrête le process de commit pour que vous puissiez fixer le problème.

Makefile

Lors de l'installation un Makefile sera créé s'il n'est pas présent, ou une liste de recettes seront ajoutées à votre Makefile s'il existe.

include vendor/twc/code-quality-plugin/make/quality.mk

Liste des recettes du Makefile

Commandes

Ce composant étant un plugin composer, plusieurs commandes sont disponibles.