Makefile

# Paramètre
SHELL         = sh
PROJECT       = pasteur
GIT_AUTHOR    = Papoel
HTTP_PORT     = 8000
HOST_NAME	  = 127.0.0.1
DB_NAME       = db_pasteur
DB_USER       = root
DB_PASS       =
DB_PORT       = 3306
DB_SERVER     = MariaDB-10.8.3&charset=utf8mb4
DATABASE_URL  = \"mysql://$(DB_USER):$(DB_PASS)@$(HOST_NAME):$(DB_PORT)/$(DB_NAME)?serverVersion=$(DB_SERVER)\"

# Executables
EXEC_PHP      = php
COMPOSER      = composer
REDIS         = redis-cli
GIT           = git
YARN          = yarn
NPX           = npx

# Alias
SYMFONY       = $(EXEC_PHP) bin/console
SF            = symfony
SYMFONY_LINT  = $(SYMFONY) lint:

# Executables: vendors
PHPUNIT       = ./vendor/bin/phpunit
#PHPUNIT       = APP_ENV=test $(SF) php bin/phpunit
PHPSTAN       = ./vendor/bin/phpstan
PHP_CS_FIXER  = ./vendor/bin/phpcs
PHP_CBF       = ./vendor/bin/phpcbf
PHPMETRICS    = ./vendor/bin/phpmetrics

# Executables: uniquement en local
SYMFONY_BIN    = symfony
BREW           = brew
DOCKER         = docker
DOCKER_COMPOSE = docker-compose
DOCKER_RUN     = docker run

# Executables: uniquement en production
CERTBOT       = certbot

# PHPQA
PHPQA     = jakzal/phpqa
PHPQA_RUN = $(DOCKER_RUN) --init -it --rm -v $(PWD):/project -w /project $(PHPQA)
## —— 🤞 The Papoel Symfony Makefile 🤞 ————————————————————————————————————————————————————————————————————————————————————————————————————
help: ## Affiche l'écran d'aide
	@grep -E '(^[a-zA-Z0-9_-]+:.*?##.*$$)|(^##)' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}{printf "\033[32m%-30s\033[0m %s\n", $$1, $$2}' | sed -e 's/\[32m##/[33m/'

## —— Composer 🧙‍♂️             ———————————————————————————————————————————————————————————————————————————————————————————————————————————
install: composer.lock ## Installer les dépendances selon le fichier composer.lock actuel
	$(COMPOSER) install --no-progress --prefer-dist --optimize-autoloader
.PHONY: install

autoloader: ## Met à jour l'autoloader
	$(COMPOSER) dump-autoload --optimize

update: ## Mettre à jour les dépendances
	$(COMPOSER) update
.PHONY: update

recipes-update: ## Mettre à jour les recettes
	$(COMPOSER) recipes:update
.PHONY: recipes-update

## —— PHP 🐘 (macOS with brew)   ———————————————————————————————————————————————————————————————————————————————————————————————————————————
php-upgrade: ## Mettre à jour PHP à la dernière version
	$(BREW) upgrade php
.PHONY: php-upgrade

php-set-7-4: ## Définir php 7.4 comme la version actuelle de PHP
	$(BREW) unlink php
	$(BREW) link --overwrite php@7.4
.PHONY: php-set-7-4

php-set-8-0: ## Définir php 8.0 comme la version actuelle de PHP
	$(BREW) unlink php
	$(BREW) link --overwrite php@8.0
.PHONY: php-set-8-0

php-set-8-1: ## Définir php 8.1 comme la version actuelle de PHP
	$(BREW) unlink php
	$(BREW) link --overwrite php@8.1
.PHONY: php-set-8-1

## —— Symfony 🎵                 ———————————————————————————————————————————————————————————————————————————————————————————————————————————
sf: ## Lister toutes les commandes Symfony
	$(SYMFONY)
.PHONY: sf

cc: ## Videz le cache
	$(SYMFONY) cache:clear
	$(SYMFONY) cache:clear --no-warmup
	$(SYMFONY) cache:warmup
.PHONY: cc

db-create: ## Créer la base de données | symfony console doctrine:database:create
	$(SYMFONY) doctrine:database:create

db-drop : ## Supprimer la base de données | symfony console doctrine:database:drop --force
	$(SYMFONY) doctrine:database:drop --if-exists --force

sf-mm: ## Make migrations.
	$(SYMFONY) make:migration
.PHONY: sf-mm

sf-dmm: ## Migrate.
	$(SYMFONY) doctrine:migrations:migrate --no-interaction
.PHONY: sf-dmm

fixtures: ## Créer des fixtures | symfony console make:fixtures
	$(SYMFONY) make:fixtures

fixtures-load: ## Charger les fixtures | symfony console doctrine:fixtures:load -n
	$(MAKE) db-drop
	$(MAKE) db-create
	if test -n "$$(find migrations -name 'Version*' -print -quit)"; then \
        $(SYMFONY) doctrine:migrations:migrate --no-interaction; \
    else \
        $(SYMFONY) doctrine:schema:validate; \
		$(SYMFONY) doctrine:schema:update --force; \
    fi; \
    $(SYMFONY) doctrine:fixtures:load -n
.PHONY: fixtures-load

sf-migrations-status: ## Migrations status
	$(SYMFONY) doctrine:migrations:status

sf-routes: ## List all routes.
	$(SYMFONY) debug:router

sf-dsu: ## Migrate.
	$(SYMFONY) doctrine:schema:update --force
.PHONY: sf-dmm

fix-perms: ## Fixer les permissions de tous les fichiers var
	chmod -R 777 var/*
.PHONY: fix-perms

assets: purge ## Installez les actifs avec des liens symboliques dans le dossier public.
	$(SYMFONY) assets:install public/  # Don't use "--symlink --relative" with a Docker env
.PHONY: assets

purge: ## Purger le cache et les journaux
	rm -rf var/cache/ var/log/ var/coverage && mkdir -p var/log && touch var/log/dev.log
	rm -rf .phpcs-cache
.PHONY: purge

## —— Symfony binaire 💻         ———————————————————————————————————————————————————————————————————————————————————————————————————————————
cert-install: ## Installez les certificats HTTPS locaux
	$(SYMFONY_BIN) server:ca:install
.PHONY: cert-install

serve: ## Servez l'application avec le support HTTPS (ajoutez "--no-tls" pour désactiver https)
	$(SYMFONY_BIN) serve --daemon --port=$(HTTP_PORT)
	$(eval CONFIRM := $(shell read -p "Faut-il exécuter le server Yarn ? [y/N] " CONFIRM && echo $${CONFIRM:-N}))
	$(SYMFONY_BIN) open:local
	@if [ "$(CONFIRM)" = "y" ]; then \
		$(YARN) dev-server; \
	fi
.PHONY: serve

unserve: ## Arrêtez le serveur web
	$(SYMFONY_BIN) server:stop
.PHONY: unserve

## —— Docker 🐳                  ———————————————————————————————————————————————————————————————————————————————————————————————————————————
up: ## Démarrer le hub docker (PHP,caddy,MySQL,redis,adminer,elasticsearch)
	$(DOCKER_COMPOSE) up --detach
.PHONY: up

build: ## Construire les images (php + caddy)
	$(DOCKER_COMPOSE) build --pull --no-cache
.PHONY: build

down: ## Arrêtez le hub de docker
	$(DOCKER_COMPOSE) down --remove-orphans
.PHONY: down

logs: ## Afficher les journaux en temps réel
	$(DOCKER_COMPOSE) logs --tail=0 --follow
.PHONY: logs

bash: ## Se connecter au conteneur d'application
	$(DOCKER) container exec -it php bash
.PHONY: bash

## —— Projet ❤️                  ———————————————————————————————————————————————————————————————————————————————————————————————————————————
start: up serve

stop: down unserve ## Arrêtez docker et le serveur Symfony

commands: ## Afficher toutes les commandes dans l'espace de nom du projet
	$(SYMFONY) list $(PROJECT)
.PHONY: commands

init-db: ## Construire la base de données, contrôler la validité des schémas, charger les fixtures.
	$(SYMFONY) doctrine:cache:clear-metadata
	$(SYMFONY) doctrine:database:drop --if-exists --force
	$(SYMFONY) doctrine:database:create
	$(SYMFONY) doctrine:schema:create
	$(SYMFONY) doctrine:schema:update --force
	$(SYMFONY) doctrine:schema:validate
	$(SYMFONY) doctrine:fixtures:load --no-interaction
.PHONY: init-db

## —— Tests ✅                    ———————————————————————————————————————————————————————————————————————————————————————————————————————————
# Execute the tests in folder tests/Unit or tests/Functional according to answer of the user
test-unit: ## Exécutez les tests unitaires
	@echo "\n==> Exécution des Tests Unitaires <==\n"
	$(EXEC_PHP) bin/phpunit --testdox --verbose tests/Unit

test-func: ## Exécutez les tests fonctionnels
	@echo "\n==> Exécution des Tests Fonctionnels <==\n"
	$(EXEC_PHP) bin/phpunit --testdox --verbose tests/Functional

## ——Les normes de codage ✨      ———————————————————————————————————————————————————————————————————————————————————————————————————————————
## Lancer PHPStan mais il faut créer un fichier phpstan.neon
stan-1: ## Lancer PHPStan level 1
	$(PHPSTAN) analyse . --level=1
.PHONY: stan-1

stan-2: ## Lancer PHPStan level 2
	$(PHPSTAN) analyse . --level=2
.PHONY: stan-2

## Lancer PHPStan level 3
stan-3: ## Lancer PHPStan level 3
	$(PHPSTAN) analyse . --level=3
.PHONY: stan-3

## Lancer PHPStan level 4
stan-4: ## Lancer PHPStan level 4
	$(PHPSTAN) analyse . --level=4
.PHONY: stan-4

## Lancer PHPStan level 5
stan-5: ## Lancer PHPStan level 5
	$(PHPSTAN) analyse . --level=5
.PHONY: stan-5

## Lancer PHPStan level 6
stan-6: ## Lancer PHPStan level 6
	$(PHPSTAN) analyse . --level=6
.PHONY: stan-6

## Lancer PHPStan level 7
stan-7: ## Lancer PHPStan level 7
	$(PHPSTAN) analyse . --level=7
.PHONY: stan-7

## Lancer PHPStan level 8
stan-8: ## Lancer PHPStan level 8
	$(PHPSTAN) analyse . --level=8
.PHONY: stan-8

## Lancer PHPStan level 9
stan-9: ## Lancer PHPStan level 9
	$(PHPSTAN) analyse . --level=9
.PHONY: stan-9

lint-php: ## Lint des fichiers avec php-cs-fixer
	$(PHP_CS_FIXER) -p --colors
.PHONY: lint-php

fix-php: ## Corriger les fichiers avec php-cs-fixer
	$(PHP_CBF)
.PHONY: fix-php

## —— Déploiement & Prod 🚀      ———————————————————————————————————————————————————————————————————————————————————————————————————————————
env-check: ## Vérifier les principales variables ENV du projet
	printenv | grep -i app
.PHONY: env-check

## —— Rapports sur la qualité du code 📊 ———————————————————————————————————————————————————————————————————————————————————————————————————
report-metrics: ## Lancer le rapport phpmetrics
	$(PHPMETRICS) --report-html=var/phpmetrics/ src/
.PHONY: report-metrics

## —— 🐛  PHPQA (Avec Docker)                  ———————————————————————————————————————————————————————————————————————————————————————————————————————————
qa-cs-fixer-dry-run: ## Détecter les erreurs dans le projet
	$(PHPQA_RUN) php-cs-fixer fix ./src --rules=@Symfony --verbose --dry-run
.PHONY: qa-cs-fixer-dry-run

qa-cs-fixer: ## Fixer les erreurs détectées.
	$(PHPQA_RUN) php-cs-fixer fix ./src --rules=@Symfony --verbose
.PHONY: qa-cs-fixer

qa-phpstan-1: ## Run phpstan Level 1.
	$(PHPQA_RUN) phpstan analyse ./src --level=1
.PHONY: qa-phpstan

qa-phpstan-2: ## Run phpstan Level 2.
	$(PHPQA_RUN) phpstan analyse ./src --level=2
.PHONY: qa-phpstan

qa-phpstan-3: ## Run phpstan Level 3.
	$(PHPQA_RUN) phpstan analyse ./src --level=3
.PHONY: qa-phpstan

qa-phpstan-4: ## Run phpstan Level 4.
	$(PHPQA_RUN) phpstan analyse ./src --level=4
.PHONY: qa-phpstan

qa-phpstan-5: ## Run phpstan  Level 5.
	$(PHPQA_RUN) phpstan analyse ./src --level=5
.PHONY: qa-phpstan

qa-phpstan-6: ## Run phpstan Level 6.
	$(PHPQA_RUN) phpstan analyse ./src --level=6
.PHONY: qa-phpstan

qa-phpstan-7: ## Run phpstan Level 7.
	$(PHPQA_RUN) phpstan analyse ./src --level=7
.PHONY: qa-phpstan

qa-phpstan-8: ## Run phpstan Level 8.
	$(PHPQA_RUN) phpstan analyse ./src --level=8
.PHONY: qa-phpstan

qa-phpstan-9: ## Run phpstan Level 9.
	$(PHPQA_RUN) phpstan analyse ./src --level=9
.PHONY: qa-phpstan

qa-security-checker: ## Run security-checker.
	$(SF) security:check
.PHONY: qa-security-checker

qa-phpcpd: ## Run phpcpd (copy/paste detector).
	$(PHPQA_RUN) phpcpd ./src
.PHONY: qa-phpcpd

qa-php-metrics: ## Run php-metrics.
	$(PHPQA_RUN) phpmetrics --report-html=var/phpmetrics ./src
.PHONY: qa-php-metrics

qa-lint-twigs: ## Lint twig files.
	$(SYMFONY_LINT)twig ./templates
.PHONY: qa-lint-twigs

qa-lint-yaml: ## Lint yaml files.
	$(SYMFONY_LINT)yaml ./config
.PHONY: qa-lint-yaml

qa-lint-container: ## Lint container.
	$(SYMFONY_LINT)container
.PHONY: qa-lint-container

qa-lint-schema: ## Vérification du schéma de base de données.
	$(SYMFONY) doctrine:schema:validate --skip-sync -vvv --no-interaction
.PHONY: qa-lint-schema
#—————————————————————————————————————————————#

## —— 🔎  TESTS                  ———————————————————————————————————————————————————————————————————————————————————————————————————————————
tests: ## Exécuter les tests.
	@echo "\n==> Exécution de tous les Tests (Unitaires et Fonctionnelles) <==\n"
	$(PHPUNIT) --testdox --verbose
.PHONY: tests

tests-coverage: ## Exécuter les tests-coverage.
	$(PHPUNIT) --coverage-html var/coverage
.PHONY: tests-coverage
#---------------------------------------------#

## —— ⭐  AUTRE                   ———————————————————————————————————————————————————————————————————————————————————————————————————————————
#before-commit: ## Exécuter avant de commit.
#	$(MAKE) qa-cs-fixer
#	$(MAKE) qa-phpstan-5
#	$(MAKE) qa-security-checker
#	$(MAKE) qa-phpcpd
#	$(MAKE) qa-lint-twigs
#	$(MAKE) qa-lint-yaml
#	$(MAKE) qa-lint-container
#	$(MAKE) qa-lint-schema
#	$(MAKE) tests
#.PHONY: before-commit

before-commit: ## Exécuter avant de commit.
	$(MAKE) lint-php
	$(MAKE) fix-php
	$(SF) security:check
	$(SYMFONY_LINT)twig ./templates
	$(SYMFONY_LINT)yaml ./config
	$(SYMFONY_LINT)container
	$(SYMFONY) doctrine:schema:validate
	$(MAKE) tests
.PHONY: before-commit

reset-db: ## Réinitialiser la base de données et créer un fichier de migration.
	$(eval CONFIRM := $(shell read -p "Êtes-vous sûr de vouloir réinitialiser la base de données ? [y/N] " CONFIRM && echo $${CONFIRM:-N}))
	@if [ "$(CONFIRM)" = "y" ]; then \
		$(MAKE) sf-dd; \
		$(MAKE) sf-dc; \
		$(MAKE) sf-mm; \
		$(MAKE) sf-dmm; \
	fi
.PHONY: reset-db

token: ## Générer un token et afficher un message de succès.
	$(EXEC_PHP) generate-token.php
.PHONY: token

## —— ⭐  SANDBOX                   ———————————————————————————————————————————————————————————————————————————————————————————————————————————
show-var:
	$(SF) var:export --multiline

init-db-test:
	$(SYMFONY) doctrine:cache:clear-metadata
	$(SYMFONY) doctrine:database:drop --force --if-exists
	$(SYMFONY) doctrine:database:create --env=test --if-not-exists
	$(SYMFONY) doctrine:schema:update --env=test --force
.PHONY: init-db-test

init-db-test-with-fixtures:
	$(MAKE) init-db-test
	$(SYMFONY) doctrine:fixtures:load --no-interaction --env=test

rapport-tests:
	vendor/bin/phpunit --testdox-html $(PROJECT)_tests.html
.PHONY: rapport-tests

first-install: ## First install.
	$(COMPOSER) install    # Installe dépendances de Composer
	$(YARN)     install    # Installe dépendances de Yarn
	$(YARN)     build      # Compile les assets
	$(MAKE)     up         # Lance les containers
	$(MAKE)     env-local  # Créer le fichier .env.local et DATABASE_URL
	$(MAKE)     init-db    # Initialise la base de données
	$(MAKE)     serve      # Lance le serveur et ouvre le navigateur
	$(YARN)     dev-server # Lance le serveur de développement de Yarn
.PHONY: first-install

# create .env.local file and set APP_ENV=dev
env-local:
	touch .env.dev.local
	@echo "DATABASE_URL=$(DATABASE_URL)" > .env.dev.local
.PHONY: dev-env

# Ne lancer les tests que dans un seul dossier :
# php bin/phpunit --testdox --verbose tests/Functional/Entity/ContactTest.php