Скачать larastan - скачать исходный код larastan

larastan

Другие категории

v3.0.2

Скачать

О Ларастане

Larastan был создан Каном Вуралом и Нуно Мадуро, его обложка разработана @Caneco, поддерживается Каном Вуралом и Виктором Сепе и представляет собой расширение PHPStan для Laravel. Larastan фокусируется на поиске ошибок в вашем коде . Он выявляет целые классы ошибок еще до того, как вы напишете тесты для кода.

Добавляет статическую типизацию в Laravel для повышения производительности разработчиков и качества кода.
Поддерживает большую часть прекрасной магии Laravel.
Обнаруживает ошибки в вашем коде

Хотя по определению «статический анализ» не загружает код вашего приложения. Larastan загружает контейнер вашего приложения, поэтому он может разрешать типы, которые можно вычислить только во время выполнения. Вот почему мы используем термин «анализ кода» вместо «статический анализ».

Поддерживаемые версии Laravel

Версия Ларавел	Ларастанская версия
< 9	1.х
> 9,0 && <11,15	2.х
11.15+	3.0+

Начало работы за 3 шага

Требует:

PHP 8.2+
Ларавел 11.15+

1 : Во-первых, вы можете использовать Composer для установки Larastan в качестве зависимости разработки в ваш проект Laravel:

composer require --dev " larastan/larastan:^3.0 "

Использование Larastan для анализа пакетов Laravel? Возможно, вам придется установить orchestra/testbench .

2 : Затем создайте файл phpstan.neon или phpstan.neon.dist в корне вашего приложения. Это может выглядеть так:

 includes:
    - vendor/larastan/larastan/extension.neon
    - vendor/nesbot/carbon/extension.neon

parameters:

    paths:
        - app/

    # Level 10 is the highest level
    level: 5

#    ignoreErrors:
#        - '#PHPDoc tag @var#'
#
#    excludePaths:
#        - ./*/*/FileToBeExcluded.php

Все доступные варианты можно найти в документации PHPStan: https://phpstan.org/config-reference.

3 : Наконец, вы можете начать анализировать свой код с помощью консольной команды phpstan:

./vendor/bin/phpstan analyse

Если вы получаете сообщение об ошибке Allowed memory size exhausted , вы можете использовать опцию --memory-limit для решения проблемы:

./vendor/bin/phpstan analyse --memory-limit=2G

Игнорирование ошибок

Игнорирование конкретной ошибки можно выполнить либо с помощью комментария php, либо в файле конфигурации:

 // @phpstan-ignore-next-line
$ test -> badMethod ();

$ test -> badMethod (); // @phpstan-ignore-line

При игнорировании ошибок в файле конфигурации PHPStan они игнорируются путем написания регулярного выражения на основе сообщений об ошибках:

 parameters :
    ignoreErrors :
        - ' #Call to an undefined method .*badMethod()# '

Базовый файл

В старых базах кода может быть сложно потратить время на исправление всего кода, чтобы пройти высокий уровень PHPStan.

Чтобы обойти эту проблему, можно создать базовый файл. Базовый файл создаст файл конфигурации со всеми текущими ошибками, поэтому новый код можно будет написать в соответствии с более высокими стандартами, чем старый код. (Документация PHPStan)

./vendor/bin/phpstan analyse --generate-baseline

Правила

Список настраиваемых правил, специфичных для Laravel, можно найти здесь.

Функции

Список возможностей Larastan можно найти здесь.

Пользовательские типы PHPDoc

Список типов PHPDoc, специфичных для Larastan, можно найти здесь.

Пользовательские параметры конфигурации PHPStan

Список пользовательских параметров конфигурации, которые вы можете использовать в файле конфигурации PHPStan, можно найти здесь.

Ошибки, которые следует игнорировать

Некоторые части Laravel в настоящее время слишком волшебны, чтобы Larastan/PHPStan мог их понять. Мы перечислили распространенные ошибки, которые следует игнорировать. Добавляйте их по мере необходимости.