Code style

Серверная сторона

Серверная сторона проекта написана на PHP, при разработке следует придерживаться правил PSR.

Для поддержания единого стиля кода серверной стороны на проекте подключен Laravel Pint — инструмент для исправления стиля PHP-кода, сочетающий в себе правила PSR и принципы Laravel.

Перед каждым созданием запроса на слияние, в котором присутствуют изменения в .php файлах, в корне проекта следует выполнять команду:

docker exec -it ant_app ./vendor/bin/pint

Клиентская сторона

Клиентская сторона проекта написана на JavaScript (Vue.js) с использованием TypeScript.

Для поддержания единого стиля кода клиентской стороны на проекте подключен ESLint — статический анализатор .js (.ts) кода для поиска и исправления проблем; а также Prettier — инструмент для приведения .js (.ts) кода к единому формату.

Перед каждым созданием запроса на слияние, в котором присутствуют изменения в .js (.ts) файлах, в корне проекта следует последовательно выполнять команды:

docker compose -f docker-compose-dev.yml run --rm ant_npm run lint

Если в результате выполнения вышеуказанной команды будут обнаружены ошибки/замечения — их необходимо исправить.

Если ошибки/замечания после выполнения вышеуказанной команды отсутствуют, следует выполнить следующую команду:

docker compose -f docker-compose-dev.yml run --rm ant_npm run format

Общее

После выполнения команд по исправлению и форматированию кода клиентской и/или серверной стороны следует убедиться в корректности исправленных файлов, и только после этого создавать запрос на слияние.