Как повысить качество вашего Laravel-приложения до уровня 9 с помощью Larastan
Larastan — это обертка над PHPStan, предназначенная для статического анализа кода, которая поддерживает особенности Laravel. Использование Larastan позволяет выявить потенциальные ошибки в коде на ранних стадиях разработки, что улучшает качество кода и снижает затраты на исправление багов. В этом руководстве мы рассмотрим, как установить, настроить и использовать Larastan для повышения качества вашего Laravel-приложения до уровня 9.
Первым шагом является установка Larastan в ваш проект. Это делается с помощью Composer:
composer require larastan/larastan:^2.0 --dev
Этот шаг добавит Larastan как зависимость разработки в ваш проект. После этого необходимо создать файл конфигурации PHPStan.
В корне вашего проекта создайте файл phpstan.neon. Этот файл будет содержать конфигурацию для PHPStan и Larastan:
includes:
- vendor/larastan/larastan/extension.neon
parameters:
paths:
- app/
level: 0
В этом файле мы указываем, что будем использовать расширение Larastan и задаем начальный уровень проверки кода.
Теперь мы можем запустить первый анализ кода:
./vendor/bin/phpstan analyse
Этот анализ покажет ошибки и предупреждения в вашем коде. На начальном уровне (level 0) будет выявлено минимальное количество проблем. Ваша задача — исправить все выявленные ошибки перед тем, как повышать уровень.
Larastan и PHPStan поддерживают уровни анализа от 0 до 9. Каждый уровень включает в себя более строгие правила проверки кода. После того как вы исправите все ошибки на текущем уровне, можно повышать уровень в файле конфигурации:
neonКопировать кодparameters:
level: 1
После изменения уровня снова запустите анализ и исправьте выявленные ошибки. Повторяйте этот процесс, пока не достигнете уровня 9.
Помимо базовой проверки, Larastan предлагает дополнительные возможности для улучшения качества кода:
- Анализ типов: Larastan проверяет типы данных, что помогает избежать ошибок, связанных с неправильным использованием типов.
- Поддержка анотаций: Larastan понимает анотации в вашем коде, такие как @var, @param, @return, и использует их для проверки соответствия типов.
- Интеграция с тестами: Larastan можно интегрировать с вашими тестами, что позволяет выявлять ошибки еще до выполнения тестов.
Рассмотрим несколько примеров, как Larastan может помочь улучшить ваш код.
function add(int $a, int $b): int {
return $a + $b;
}
echo add(1, '2');
В этом примере функция ожидает два параметра типа int, но второй параметр передается как строка. Larastan выявит эту ошибку и предупредит вас.
/**
* @param int $a
* @param int $b
* @return int
*/
function add($a, $b) {
return $a + $b;
}
Если вы забудете указать типы параметров в функции, Larastan проверит анотации и укажет на несоответствие типов.
Использование Larastan в вашем Laravel-проекте позволяет значительно улучшить качество кода, выявляя ошибки на ранних стадиях разработки. Последовательное повышение уровня проверки от 0 до 9 поможет вам сделать код более надежным и безопасным.
Пікірлер 4
Кіру пікір қалдыру үшін
Nursultan Kabenov · Там. 23, 2024 22:16
🔥
ЕРКЕН УСИНОВ · Там. 7, 2024 08:23
Interesting
Алмат Қуанышбаев · Там. 5, 2024 14:16
Комментарий для получения 1хр
Laura Meir · Там. 5, 2024 13:45
Комментарий для получения 1хр