Разработческая документация

[toc] Этот раздел предназначен для участников проекта.

Стилевые нормы кода

./vendor/bin/php-cs-fixer fix src

Анализ кода

./vendor/bin/phpstan analyse

Тестирование

DuckPhp использует PHPUnit для выполнения юнит-тестов с покрытием.

./vendor/bin/phpunit

Тестирование отдельного файла

./vendor/bin/phpunit tests/Core/AppTest.php && ./vendor/bin/phpunit tests/support.php

Проверка стиля кода, анализ кода и выполнение юнит-тестов

./vendor/bin/php-cs-fixer fix && ./vendor/bin/phpstan analyse && ./vendor/bin/phpunit

Основная среда — WSL. test_coverage_dumps — это сохранённые файлы dump от PHPUnit. test_reports — это выходные отчёты.

Эти два каталога должны иметь права записи при выполнении PHPUnit. Необходимо проверять наличие прав доступа, чтобы избежать проблем у начинающих пользователей.

Примеры документов, генерация новых опций

php tests/genoptions.php

Создание SVG-графика архитектуры

dot docs/duckphp.gv -T svg -o

Объединение команд

php tests/genoptions.php && dot docs/duckphp.gv -T svg -o

Перечень команд:

Три в одном

./vendor/bin/php-cs-fixer fix && ./vendor/bin/phpstan analyse && ./vendor/bin/phpunit

Пять в одном

./vendor/bin/php-cs-fixer fix && ./vendor/bin/phpstan analyse && ./vendor/bin/phpunit && php tests/genoptions.php && dot docs/duckphp.gv -T svg -o