Скачать dead code detector - Загрузка исходного dead code detector Скачать

dead code detector

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

0.7.0

Скачать

Детектор мертвого кода для PHP

Расширение Phpstan, чтобы с легкостью найти неиспользованный PHP -код в вашем проекте!

Краткое содержание:

✅ Phpstan Extension
♻ Обнаружение мертвых циклов
? Обнаружение переходного мертвых членов
? Автоматическое удаление неиспользованного кода
Популярная поддержка библиотек
Настраиваемые поставщики использования

Установка:

composer require --dev shipmonk/dead-code-detector

Используйте официальный расширение-установщик или просто загрузите правила:

 # phpstan.neon.dist
includes :
    - vendor/shipmonk/dead-code-detector/rules.neon

Поддерживаемые библиотеки:

Symfony:

Звонки, сделанные DIC по вашим услугам!
- конструкторы, вызовы, фабричные методы
- phpstan/phpstan-symfony с containerXmlPath должен использоваться
#[AsEventListener] атрибут
#[AsController] атрибут
#[AsCommand] атрибут
#[Required] атрибут
#[Route] атрибуты
EventSubscriberInterface::getSubscribedEvents
onKernelResponse , onKernelRequest и т. Д.

Доктрина:

#[AsEntityListener] Атрибут
DoctrineORMEvents::* События
DoctrineCommonEventSubscriber Методы
Атрибуты события жизненного цикла #[PreFlush] , #[PostLoad] , ...

Phpunit:

Методы поставщика данных
Методы testXxx
Аннотации, такие как @test , @before , @afterClass и т. Д.
Атрибуты, такие как #[Test] , #[Before] , #[AfterClass] и т. Д.

Phpstan:

Конструктор требует служб DIC (правила, расширения, ...)

Нетте:

handleXxx , renderXxx , actionXxx , injectXxx , createComponentXxx
SmartObject Magic требует аннотаций @property

Все эти библиотеки автономны, когда они найдены в зависимости ваших композиторов. Если вы хотите заставить включить/отключить некоторые из них, вы можете:

 # phpstan.neon.dist
parameters :
    shipmonkDeadCode :
        usageProviders :
            phpunit :
                enabled : true

Поставщики общего использования:

Отражение:

Любая константа или метод, доступ к которому через ReflectionClass обнаруживается при использовании
- Например, $reflection->getConstructor() , $reflection->getConstant('NAME') , $reflection->getMethods() , ...

Продавец:

Любой переопределенный метод, который возникает у vendor , не сообщается как мертвый
- например, реализация PsrLogLoggerInterface::log автоматически рассматривается

Эти поставщики включены по умолчанию, но вы можете отключить их, если это необходимо.

Настройка:

Если ваше приложение выполняет некоторые волшебные вызовы, неизвестные в эту библиотеку, вы можете реализовать своего собственного поставщика использования.
Просто отметьте его с помощью shipmonk.deadCode.memberUsageProvider и реализовать ShipMonkPHPStanDeadCodeProviderMemberUsageProvider

 # phpstan.neon.dist
services :
    -
        class : AppApiOutputUsageProvider
        tags :
            - shipmonk.deadCode.memberUsageProvider

Важный

Интерфейс и тег изменились в 0,7. Если вы используете Phpstan 1.x, они использовались по -разному.

Настройка на основе отражения:

Для простых размышлений, вы можете просто расширить ShipMonkPHPStanDeadCodeProviderReflectionBasedMemberUsageProvider :

 use ReflectionMethod ;
use ShipMonk  PHPStan  DeadCode  Provider  ReflectionBasedMemberUsageProvider ;

class ApiOutputUsageProvider extends ReflectionBasedMemberUsageProvider
{

    public function shouldMarkMethodAsUsed ( ReflectionMethod $ method ): bool
    {
        // all methods from our ApiOutput interface are called automatically (e.g. during serialization)
        return $ method -> getDeclaringClass ()-> implementsInterface (ApiOutput::class);
    }

}

Настройка на основе AST:

Для более сложных использования, которые вычитаются только из AST (например, вызовы сериализации), вы просто придерживаетесь интерфейса RAW MemberUsageProvider :

 use ReflectionMethod ;
use ShipMonk  PHPStan  DeadCode  Graph  ClassMethodRef ;
use ShipMonk  PHPStan  DeadCode  Graph  ClassMethodUsage ;
use ShipMonk  PHPStan  DeadCode  Provider  MemberUsageProvider ;
use Symfony  Component  Serializer  SerializerInterface ;

class DeserializationUsageProvider implements MemberUsageProvider
{

    /**
     * @return list<ClassMemberUsage>
     */
    public function getUsages ( Node $ node , Scope $ scope ): array
    {
        if (! $ node instanceof MethodCall) {
            return [];
        }

        if (
            // our deserialization calls constructor
            $ scope -> getType ( $ node -> var )-> getObjectClassNames () === [SerializerInterface::class] &&
            $ node -> name -> toString () === ' deserialize '
        ) {
            $ secondArgument = $ node -> getArgs ()[ 1 ]-> value ;
            $ serializedClass = $ scope -> getType ( $ secondArgument )-> getConstantStrings ()[ 0 ];

            // record the method it was called from (needed for proper transitive dead code elimination)
            $ originRef = $ this -> getOriginMethodRef ( $ scope );

            // record the hidden constructor call
            $ constructorRef = new ClassMethodRef ( $ serializedClass -> getValue (), ' __construct ' , false );

            return [ new ClassMethodUsage ( $ originRef , $ constructorRef )];
        }

        return [];
    }

    private function getOriginMethodRef ( Scope $ scope ): ? ClassMethodRef
    {
        return new ClassMethodRef (
            $ scope -> getClassReflection ()-> getName (),
            $ scope -> getFunction ()-> getName (),
            false ,
        );
    }

}

Мертвые циклы и транзитивно мертвые методы

Эта библиотека автоматически обнаруживает мертвые циклы и транзитивно мертвые методы (методы, которые называются только из мертвых методов)
По умолчанию он сообщает только о первом мертвом методе в поддерево, а остальные - в качестве наконечника:

 ------ ------------------------------------------------------------------------
  Line   src/App/Facade/UserFacade.php
 ------ ------------------------------------------------------------------------
  26     Unused AppFacadeUserFacade::updateUserAddress
         ?  shipmonk.deadMethod
          Thus AppEntityUser::updateAddress is transitively also unused
          Thus AppEntityAddress::setPostalCode is transitively also unused
          Thus AppEntityAddress::setCountry is transitively also unused
          Thus AppEntityAddress::setStreet is transitively also unused
          Thus AppEntityAddress::MAX_STREET_CHARS is transitively also unused
 ------ ------------------------------------------------------------------------

Если вы хотите сообщить о всех мертвых методах индивидуально, вы можете включить их в своем phpstan.neon.dist :

 parameters :
    shipmonkDeadCode :
        reportTransitivelyDeadMethodAsSeparateError : true

Автоматическое удаление мертвого кода

Если вы уверены, что зарегистрированные методы мертвы, вы можете автоматически удалить их, запустив Phpstan с форматом ошибки removeDeadCode :

vendor/bin/phpstan analyse --error-format removeDeadCode

class UserFacade
{
-    public const TRANSITIVELY_DEAD = 1;
-
-    public function deadMethod(): void
-    {
-        echo self::TRANSITIVELY_DEAD;
-    }
}

Вызовы по неизвестным типам

Чтобы предотвратить ложные срабатывания, мы поддерживаем даже вызовы по неизвестным типам (например $unknown->method() ), отмечая все методы, названные method как используемые
- Такое поведение может быть не желательным для строго напечатанных кодовых баз, потому что, например, один new $unknown() будет отмечать все конструкторы, которые используются, используемые как используемые
- Таким образом, вы можете отключить эту функцию в своем phpstan.neon.dist :
То же самое относится и к постоянным извлечениям по неизвестным типам (например, $unknown::CONSTANT )

 parameters :
    shipmonkDeadCode :
        trackMixedAccess : false

Если вы хотите проверить, сколько из этих случаев присутствует в вашей кодовой базе, вы можете запустить анализ PHPSTAN с -vvv , и вы увидите некоторую диагностику:

 Found 2 usages over unknown type:
 • setCountry method, for example in AppEntityUser::updateAddress
 • setStreet method, for example in AppEntityUser::updateAddress

Сравнение с Tomasvotruba/Unared-Public

Вы можете увидеть подробное сравнение PR
По сути, их анализ менее точный и менее гибкий. В основном:
- Он не может обнаружить мертвые конструкторы
- Он не обнаруживает вызовы в пределах иерархии наследования
- Он не предлагает никаких пользовательских корректировок используемых методов
- У него практически нет встроенных библиотечных расширений
- Он игнорирует методы признаков
- Не хватает многих незначительных функций, таких как вызовы классов, динамические вызовы метода, обратные вызовы массива, цепочки вызовов Nullsafe и т. Д.
- Он не может обнаружить мертвые циклы, ни транзитивно мертвые методы
- У него нет встроенного удаления мертвого кода

Ограничения:

Методы анонимных классов никогда не сообщаются как мертвые (ограничение PHPSTAN)
Абстрактные методы признаков никогда не сообщаются как мертвые
Большинство магических методов (например, __get , __set и т. Д.) никогда не сообщаются как мертвые
- Только поддерживаются: __construct , __clone

Другие проблемные случаи:

Конструкторы:

Для приложений Symfony и расширений Phpstan мы упрощаем обнаружение, предполагая, что все классы DIC использовали конструктор.
Для других приложений вы можете получить ложные позиции, если услуги создаются волшебным образом.
- Чтобы избежать этого, вы можете легко отключить анализ конструктора с помощью одиночного игнорирования:

 parameters :
    ignoreErrors :
        - ' # ^Unused .*?::__construct$ # '

Частные конструкторы:

Об этом никогда не сообщаются как мертвы

Методы интерфейса:

Если вы никогда не вызовут метод интерфейса через интерфейс, но только по его реализаторам, он сообщается как мертвые
Но вы можете сохранить метод интерфейса, чтобы вызвать некоторое объединение между реализациями
- Самый простой способ проигнорировать его через Custom MemberUsageProvider :

 use ShipMonk  PHPStan  DeadCode  Provider  ReflectionBasedMemberUsageProvider ;

class IgnoreDeadInterfaceUsageProvider extends ReflectionBasedMemberUsageProvider
{
    public function shouldMarkMethodAsUsed ( ReflectionMethod $ method ): bool
    {
        return $ method -> getDeclaringClass ()-> isInterface ();
    }
}