Download the PHP package it-nsk/dev-tools without Composer

dev-tools

Один репозиторий содержит две части:

• глобальный shell CLI управляет Docker, Traefik, dump и запуском команд;
• Composer-пакет it-nsk/dev-tools содержит PHP CS Fixer, PHPStan и Git hook.

Разработчик работает только с глобальной командой dev-tools. vendor/bin/dev-tools вызывается автоматически внутри app-контейнера.

Установка глобальной команды

Требуются Git, Docker с Compose plugin и curl. В app-образе должны быть установлены Zsh и Oh My Zsh для рабочего пользователя контейнера.

По умолчанию команда устанавливается в /usr/local/bin/dev-tools. Zsh completion устанавливается автоматически. После первой установки откройте новый терминал или выполните:

После этого dev-tools <Tab> показывает и дополняет доступные команды.

Обновление:

self-update обновляет одновременно CLI и его Zsh completion. В проектах для автодополнения ничего настраивать не нужно.

Подключение Composer-пакета

В composer.json проекта:

Пакет устанавливается командой composer install внутри app-контейнера. Отдельный VCS repository для него не нужен: релизы находятся в Packagist.

Файлы проекта

• .env — существующие настройки приложения для production/test;
• .env.local.example — локальные настройки приложения и проекта;
• .env.local — локальная копия, не хранится в Git;
• docker-compose.example.yml — шаблон в Git;
• docker-compose.yml — автоматически обновляемая копия в .gitignore;
• Dockerfile и nginx-конфигурация проекта.

Обычно в .env.local.example достаточно:

Остальные значения имеют defaults: Compose-файл docker-compose.yml, сервис приложения app, сервис БД db, сеть proxy, MySQL root-пароль root, dump dump.sql.gz, Traefik в соседнем каталоге droxy.

Поддерживаемые переменные

Проектные переменные читаются сначала из .env, затем из .env.local. Переменная окружения процесса имеет наивысший приоритет.

Служебные переменные установки и запуска задаются в окружении команды, а не в проектном .env:

Первый запуск

init:

• создает .env.local и обновляет Compose из example;
• проверяет Docker;
• клонирует и запускает multifinger/droxy, если Traefik еще не установлен;
• создает SSL-сертификат и записи /etc/hosts;
• скачивает dump, если настроен источник;
• собирает и запускает контейнеры;
• выполняет Composer, frontend build, cache clear и установку hook.

Для проекта, ранее работавшего на хосте:

Старый .env.local сохраняется как .env.local.host-backup, после чего создается Docker-конфигурация. Обычный init существующего Docker-проекта сохраняет .env.local, но синхронизирует генерируемый Compose-файл.

Команды

dev-tools sh открывает login Zsh с Oh My Zsh. Вариант с одним аргументом выполняет команду через zsh -lc внутри app:

Zsh является стандартной оболочкой. Для образа, который временно её не поддерживает, оболочку можно переопределить в .env.local:

Если настроенная оболочка отсутствует в app, команда завершится с понятной ошибкой. Это переопределение предназначено для миграции старых образов; новые проекты должны устанавливать Zsh и Oh My Zsh на этапе сборки.

dump:import удаляет и создает заново только настроенную локальную БД.

Инструменты качества

PHP CS Fixer проверяет src по общей конфигурации пакета.

PHPStan автоматически использует проектный phpstan.dist.neon. Если файла нет, используется общая конфигурация и каталог src. Переданные пути ограничивают проверку указанными файлами.

Git hook запускает форматирование staged PHP-файлов внутри Docker и повторно добавляет исправленные файлы в Git index.

Разработка и тесты

Подробности реализации находятся в docs/architecture.md и docs/quality-tools.md.