Aller au contenu

Qualité et automatisation

1. README

Mettre en place un README au format Markdown qui indique comment installer, configurer et exécuter le projet.

Travail à réaliser

Les étapes suivantes doivent être décrites :

  • Installation du projet
  • Configuration de la base de données
  • Création de la base de données, exécution des migrations et chargement des fixtures
  • Lancement du serveur de développement

2. PHP-CS-Fixer

"Fixer" le code PHP de votre projet avec PHP-CS-Fixer.

Travail à réaliser

  1. Installer PHP-CS-Fixer dans votre projet avec composer require --dev friendsofphp/php-cs-fixer
  2. Vérifier qu'un fichier de configuration .php-cs-fixer.dist.php est présent à la racine du projet
  3. Exécuter PHP-CS-Fixer pour le dossier src/

    Attention

    Si vous avez une erreur lors de l'installation de PHP-CS-Fixer lié à sebastian/diff, il faut mettre à jour PHPUnit avant avec composer require --dev phpunit/phpunit -W.

3. Hook git

Configurer un hook Git pour "fixer" le code à chaque commit.

Travail à réaliser

  1. Installer GrumPHP
  2. Configurer GrumPHP pour, lors d'un commit :
    • exécuter PHP-CS-Fixer (tâche phpcsfixer)
    • interdire les mots suivants dans le code commité : die(, var_dump( et dump( (tâche git_blacklist)

Pour tester vos hooks Git GrumPHP dispose d'une commande : php ./vendor/bin/grumphp run.

4. Scripts Composer

L'objectif est de mettre en place des scripts Composer pour simplifier la mise en place et l'utilisation du projet.

Travail à réaliser

Ajouter des scripts pour les actions suivantes :

  • cs : Exécution de php-cs-fixer
  • db :
    • suppression de la base de données si existante
    • création de la base de données
    • exécution des migrations
    • chargement des fixtures

Mettre à jour votre README.


Ressources :


Dernière mise à jour: February 27, 2023