dtk/Makefile at main · ssc-php/dtk · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
# Parameters (optional)
# * `arg`: arbitrary arguments to pass to rules (default: none)
# * `env`: used to set `APP_ENV` (default: `test`)
arg ?=
env ?= test

# Docker containers
DTK_SERVICE = app

# Executables
COMPOSER = docker compose exec $(DTK_SERVICE) composer
CONSOLE = docker compose exec -e APP_ENV=$(env) $(DTK_SERVICE) php bin/console
DTK = docker compose exec -e APP_ENV=$(env) $(DTK_SERVICE) php dtk
PHP_CS_FIXER = docker compose exec $(DTK_SERVICE) php vendor/bin/php-cs-fixer
PHPSTAN = docker compose exec $(DTK_SERVICE) php vendor/bin/phpstan --memory-limit=256M
PHPUNIT = docker compose exec $(DTK_SERVICE) php vendor/bin/phpunit
RECTOR = docker compose exec $(DTK_SERVICE) php vendor/bin/rector
SWISS_KNIFE = docker compose exec $(DTK_SERVICE) php vendor/bin/swiss-knife

# Misc
.DEFAULT_GOAL = help
.PHONY: *

## ——  🍪 The DTK Makefile  ——————————————————————————————————————————————
## Based on https://github.com/dunglas/symfony-docker
## (arg) denotes the possibility to pass "arg=" parameter to the target
##     this allows to add command and options, example: make composer arg='dump --optimize'
## (env) denotes the possibility to pass "env=" parameter to the target
##     this allows to set APP_ENV environment variable (default: test), example: make console env='prod' arg='cache:warmup'
help: ## Outputs this help screen
	@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/'

## —— Docker 🐳 ————————————————————————————————————————————————————————————————
docker: ## Runs Docker (arg, eg `arg='compose logs --tail=0 --follow'`)
	@docker $(arg)

docker-compose: ## Runs Docker Compose (arg, eg `arg='logs --tail=0 --follow'`)
	@docker compose $(arg)

docker-init: ## Builds the Docker images and starts the services in detached mode (no logs)
	@docker compose build --pull
	@docker compose up --detach

docker-down: ## Stops the services
	@docker compose down --remove-orphans

docker-bash: ## Opens a (bash) shell in the container
	@docker compose exec $(DTK_SERVICE) bash

## —— PHP 🐘 ———————————————————————————————————————————————————————————————————
composer: ## Runs Composer (arg, eg `arg='outdated'`)
	@$(COMPOSER) $(arg)

composer-install: ## Install dependencies (arg, eg `arg='--no-dev'`)
	@$(COMPOSER) install --optimize-autoloader $(arg)

composer-update: ## Updates dependencies (arg, eg `arg='--no-dev'`)
	@$(COMPOSER) update --optimize-autoloader $(arg)

composer-dump: ## Dumps autoloader (arg, eg `arg='--classmap-authoritative'`)
	@$(COMPOSER) dump-autoload --optimize --strict-psr --strict-ambiguous $(arg)

console: ## Runs Symfony Console (arg, env, eg `arg='cache:clear' env='prod'`)
	@$(CONSOLE) $(arg)

cs-check: ## Checks CS with PHP-CS-Fixer (arg, eg `arg='../monolith/web'`)
	@$(PHP_CS_FIXER) check --verbose $(arg)

cs-fix: ## Fixes CS with Swiss Knife and PHP-CS-Fixer
	@$(SWISS_KNIFE) namespace-to-psr-4 src --namespace-root 'Ssc\\Dtk\\'
	@$(SWISS_KNIFE) namespace-to-psr-4 tests --namespace-root 'Ssc\\Dtk\\Tests\\'
	@$(PHP_CS_FIXER) fix --verbose $(arg)

phpstan: ## Runs phpstan (arg, eg `arg='clear-result-cache'`)
	@$(PHPSTAN) $(arg)

phpstan-analyze: ## Static Analysis with phpstan (arg, eg `arg='../monolith/web'`)
	@$(PHPSTAN) analyze $(arg)

swiss-knife: ## Automated refactorings with Swiss Knife (arg, eg `arg='namespace-to-psr-4 src --namespace-root \'App\\\''`)
	@$(SWISS_KNIFE) $(arg)

phpunit: ## Runs the tests with PHPUnit (arg, eg `arg='./tests/Smoke'`)
	@docker compose exec $(DTK_SERVICE) sh bin/sfcc-if-stale.sh test
	@$(PHPUNIT) $(arg)

rector-fix: ## Automated refactorings with Rector (arg, eg `arg='--clear-cache'`)
	@$(RECTOR) $(arg)

rector-check: ## Refactoring checks with Rector
	@$(RECTOR) process --dry-run

## —— DTK 🫂 ————————————————————————————————————————————————————————————————
dtk: ## Runs DTK CLI (arg, env, eg `arg='version'`)
	@$(DTK) $(arg)

## —— App 📱 ———————————————————————————————————————————————————————————————————
app-init: ## First install / resetting (Docker build, up, etc)
	@echo ''
	@echo '  // Stopping DTK docker services...'
	@$(MAKE) docker-down
	@echo ''
	@echo '  // Starting DTK docker services...'
	@$(MAKE) docker-init
	@echo ''
	@echo '  // Installing Composer dependencies...'
	@$(MAKE) composer-install
	@echo ''
	@echo '  [OK] DTK initialized'

app-clear: ## Clears the Symfony cache (env, eg `env='prod'`)
	@$(CONSOLE) cache:clear

app-qa: ## Runs full QA pipeline (composer-dump, cs-check, phpstan-analyze, rector-check, phpunit)
	@echo ''
	@echo '  // Running composer dump...'
	@$(MAKE) composer-dump
	@echo ''
	@echo '  // Running PHP CS Fixer...'
	@$(MAKE) cs-check
	@echo ''
	@echo '  // Running PHPStan...'
	@$(MAKE) phpstan
	@echo ''
	@echo '  // Running Rector...'
	@$(MAKE) rector-check
	@echo ''
	@echo '  // Running PHPUnit...'
	@$(MAKE) phpunit
	@echo ''
	@echo '  [OK] QA done'

app-prep-release: ## Bumps version, builds binaries and generates CHANGELOG entry, then review before app-release (version=X.Y.Z)
	@bin/bump/dtk.sh $(version)
	@docker compose exec $(DTK_SERVICE) sh bin/mk-dtk-bin.sh
	@bin/mk-changelog.sh

app-release: ## Commits, tags, pushes and creates a GitHub release, run app-prep-release first
	@bin/mk-release.sh