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.

Type	Libelle	Def
Dossier	quality	Permet de configurer les standards et règles qualités sur votre projet
Fichier	Makefile	Ajoute des recettes

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

Make	Def
make twc.stan	Lance une analyse statique avec phpstan
make twc.fixer	Fix les standards avec php-cs-fixer
make twc.fix	Fix les standards avec php-code-sniffer
make twc.rules	Retourne les erreurs suites au non respect des standards php-cs
make twc.test	Lancer les tests avec phpunit

Commandes

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

Commande	Def
composer twc:make:install	Installe un Makefile ou ajoute une extension pour bénéficier des recettes du composant
composer twc:hooks:install	Installe des hooks Git à votre projet
↘ --mode=force	Ecrase vos hooks s'ils existent
↘ --only-hook=pre-commit	Installe un hook pre-commit à votre projet
↘ --only-hook=commit-msg	Installe un hook commit-msg à votre projet
composer twc:quality:install	Installe un dossier de configuration nommé quality à la racine de votre projet
↘ --mode=force	Ecrase le dossier quality s'il existe
composer twc:commit:force "MSGCOMMIT"	Permet de désactiver le temps du commit les règles et analyses qualités. (A utiliser en cas de force majeure) Votre MSGCOMMIT sera préfixé [commit-forced]