используется пакет darkaonline/l5-swagger, документация
описывается через атрибуты оберткой над которой использует этот пакет Swagger-PHP.
Описанная документация тестируется с помощью пакета spectator.
Дока находиться по пути /api/documentation
, обновляется автоматически при посещении данной страницы.
Для проверки стиля кода и исправление синтаксических ошибок используется пакет PHP Insights
docker compose exec php php artisan insights --fix
для проверки когнитивной сложности кода - cognitive-complexity, для своей работы он использует phpStan, конфиг находиться в файле - phpstan.neon
docker compose exec php vendor/bin/phpstan
Эти команда запускаются перед коммитом
используется пакет - composer-unused
# запуск
docker compose exec php ./vendor/bin/composer-unused
если пакет нужно исключить из проверки, прописываем название пакета в файле - composer-unused.php
используется пакет - gitleaks
# пулим последнюю актуальную версию
docker pull zricethezav/gitleaks:latest
# запускаем проверку
docker run -v ./:/path zricethezav/gitleaks:latest protect \
--source="/path" \
--config=/path/.gitleaks.toml \
--report-path=/path/gitleaks-report.json \
--staged
настройки в файле .gitleaks.toml, отчет в файле - gitleaks-report.json вызывается на pre-commit
Requirement described in the file
.validate-branch-namerc.json
branch name auto validate on pre-push hook using validate-branch-name package
Each commit message must follow the commit convention
Automatic message validation on commit-msg git hook. All setting described in the file
commitlint.config.js
когда что-то не сделано, а нужно коммитить а валидация не позволяет запушить, тогда используем - WIP(work in progress) commit алгоритм таков:
# commit
git commit -m 'wip: some text' --no-verify # or just 'wip'
git push --no-verify
# вернулись к работе
git reset HEAD~
Следующий пуш ОБЯЗАТЕЛЬНО з -f опцией - force push.