/
Makefile
175 lines (140 loc) · 7.16 KB
/
Makefile
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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
ARGS ?=
.USER = CURRENT_UID=$(shell id -u):$(shell id -g)
.DOCKER_COMPOSE_RUN = ${.USER} docker compose run --rm
.PHP = docker run --user=$(shell id -u):$(shell id -g) -it --rm -v${CURDIR}:/data -w /data php:8.1
.PHONY: help
help:
@echo " _ ____ _ ";
@echo " _ __ | |__ _ __ | _ \ ___ ___ _ _ _ __ ___ ___ _ __ | |_ ___ _ __ ";
@echo "| '_ \| '_ \| '_ \| | | |/ _ \ / __| | | | '_ ' _ \ / _ \ '_ \| __/ _ \| '__|";
@echo "| |_) | | | | |_) | |_| | (_) | (__| |_| | | | | | | __/ | | | || (_) | | ";
@echo "| .__/|_| |_| .__/|____/ \___/ \___|\__,_|_| |_| |_|\___|_| |_|\__\___/|_| ";
@echo "|_| |_| ";
@echo "";
@echo "Available commands:";
@echo "";
@echo "== Setup ==";
@echo "setup - Installs phive and all phar-based dependencies";
@echo "install-phive - Installs phive, the phar.io package manager.";
@echo "pull-containers - pulls all development docker containers";
@echo "composer - Runs composer install from within the phpdoc container";
@echo "shell - starts the phpDocumentor docker container and opens a terminal";
@echo "";
@echo "== Automated testing ==";
@echo "pre-commit-test - runs all checks needed before committing";
@echo "";
@echo "test - runs unit tests and checks the code coverage percentage";
@echo "unit-test - runs unit tests";
@echo "integration-test - runs integration tests";
@echo "functional-test - runs functional tests";
@echo "composer-require-checker - checks for any missing composer packages";
@echo "";
@echo "e2e-test - runs phpDocumentor and verifies the output using Cypress";
@echo "build/default/index.html - builds the 'default' template's example project";
@echo "build/clean/index.html - builds the 'clean' template's example project";
@echo "cypress/integration/*.spec.js - runs e2e tests on a specific specification";
@echo "";
@echo "== Code Quality ==";
@echo "lint - performs all linting on the code";
@echo "phpcs - performs code-style checks";
@echo "phpcbf - fixes most code-style issues";
@echo "phpstan - performs static analysis on the codebase using phpstan";
@echo "psalm - performs static analysis on the codebase using psalm";
@echo "";
@echo "== Release tools ==";
@echo "composer-mirror - Runs a production-version of composer install for, i.e., the phar building";
@echo "composer-pre-release - Update guides for next release";
@echo "phar - Creates the PHAR file";
@echo "docs - Creates local docs docker image";
@echo "";
.PHONY: phar
phar: composer-mirror
composer remove --dev phpstan/extension-installer; \
php -d phar.readonly=false tools/box compile --config=box.json
tools/phive.phar:
wget -O tools/phive.phar https://phar.io/releases/phive.phar; \
wget -O tools/phive.phar.asc https://phar.io/releases/phive.phar.asc; \
gpg --keyserver pool.sks-keyservers.net --recv-keys 0x9D8A98B29B2D5D79; \
gpg --verify tools/phive.phar.asc tools/phive.phar; \
chmod +x tools/phive.phar
.PHONY: install-phive
install-phive: tools/phive.phar
.PHONY: setup
setup: install-phive
docker-compose run --rm --entrypoint=/usr/local/bin/php phpdoc tools/phive.phar install --copy --trust-gpg-keys 4AA394086372C20A,D2CCAC42F6295E7D,E82B2FB314E9906E,8E730BA25823D8B5,D0254321FB74703A,8A03EA3B385DBAA1 --force-accept-unsigned
.PHONY: pull-containers
pull-containers:
docker pull phpdoc/phpcs-ga
docker pull php:8.1
docker pull node
.PHONY: phpcs
phpcs:
${.PHP} ./bin/phpcs -s ${ARGS}
.PHONY: phpcbf
phpcbf:
${.PHP} ./bin/phpcbf ${ARGS}
.PHONY: phpstan
phpstan:
${.PHP} ./bin/phpstan analyse src tests --memory-limit=1G incubator/*/src incubator/*/tests --configuration phpstan.neon ${ARGS}
.PHONY: psalm
psalm:
${.PHP} ./bin/psalm.phar
.PHONY: lint
lint: phpcs
.PHONY: test
test: unit-test
${.PHP} -f ./tests/coverage-checker.php 64
.PHONY: unit-test
unit-test: SUITE=--testsuite=unit
.PHONY: integration-test
integration-test: SUITE=--testsuite=integration --no-coverage
.PHONY: functional-test
functional-test: SUITE=--testsuite=functional --no-coverage
unit-test integration-test functional-test:
${.DOCKER_COMPOSE_RUN} --entrypoint=bin/phpunit phpdoc-pcov $(SUITE) $(ARGS)
.PHONY: e2e-test
e2e-test: node_modules/.bin/cypress build/default/index.html build/clean/index.html
docker run -it --rm -eCYPRESS_CACHE_FOLDER="/e2e/var/cache/.cypress" -v ${CURDIR}:/e2e -w /e2e cypress/included:13.8.1
cypress/integration/default/%.spec.js: node_modules/.bin/cypress build/default/index.html .RUN_ALWAYS
docker run -it --rm -eCYPRESS_CACHE_FOLDER="/e2e/var/cache/.cypress" -v ${CURDIR}:/e2e -w /e2e cypress/included:13.8.1 -s $@
cypress/integration/clean/%.spec.js: node_modules/.bin/cypress build/clean/index.html .RUN_ALWAYS
docker run -it --rm -eCYPRESS_CACHE_FOLDER="/e2e/var/cache/.cypress" -v ${CURDIR}:/e2e -w /e2e cypress/included:13.8.1 -s $@
.PHONY: composer-require-checker
composer-require-checker:
${.DOCKER_COMPOSE_RUN} --entrypoint=./tools/composer-require-checker phpdoc check --config-file /opt/phpdoc/composer-require-config.json composer.json
.PHONY: pre-commit-test
pre-commit-test: test integration-test phpcs phpstan psalm composer-require-checker
.PHONY: composer
composer:
docker run -it --rm -v${CURDIR}:/opt/project -w /opt/project composer:2 install
.PHONY: composer-mirror
composer-mirror:
rm -rf vendor/phpdocumentor/*
COMPOSER_MIRROR_PATH_REPOS=1 composer install --optimize-autoloader
composer-guides-dev:
docker run -it --rm -v${CURDIR}:/opt/project -w /opt/project composer:2 require phpdocumentor/guides:dev-main@dev phpdocumentor/guides-graphs:dev-main@dev phpdocumentor/guides-markdown:dev-main@dev phpdocumentor/guides-restructured-text:dev-main@dev
composer-pre-release:
docker run -it --rm -v${CURDIR}:/opt/project -w /opt/project composer:2 require phpdocumentor/guides phpdocumentor/guides-graphs phpdocumentor/guides-markdown phpdocumentor/guides-restructured-text
.PHONY: shell
shell:
${.DOCKER_COMPOSE_RUN} --entrypoint=/bin/bash phpdoc
node_modules/.bin/cypress:
docker run -it --rm -eCYPRESS_CACHE_FOLDER="/opt/phpdoc/var/cache/.cypress" -v ${CURDIR}:/opt/phpdoc -w /opt/phpdoc node npm install
build/default/index.html: data/examples/MariosPizzeria/**/* data/templates/default/**/* .RUN_ALWAYS
${.DOCKER_COMPOSE_RUN} phpdoc --config=data/examples/MariosPizzeria/phpdoc.xml --template=default --target=build/default --force
build/clean/index.html: data/examples/MariosPizzeria/**/* data/templates/clean/**/* .RUN_ALWAYS
${.DOCKER_COMPOSE_RUN} phpdoc --config=data/examples/MariosPizzeria/phpdoc.xml --template=clean --target=build/clean --force
.PHONY: docs
docs:
${.DOCKER_COMPOSE_RUN} phpdoc --force -vvv
.PHONY: build-website
build-website: demo docs
cp -p -r ./data/website/* ./build/website
cp -p ./data/xsd/phpdoc.xsd ./build/website/docs/
docker build -t phpdocumentor/phpdocumentor/phpdoc.org:local ./build/website
.PHONY: demo
demo:
${.DOCKER_COMPOSE_RUN} phpdoc --template=default -t ./build/website/demo/default
${.DOCKER_COMPOSE_RUN} phpdoc --template=clean -t ./build/website/demo/clean
.PHONY: .RUN_ALWAYS
.RUN_ALWAYS: