dead code detector下载 - dead code detector源代码下载

dead code detector

其他类别

0.7.0

下载

PHP的死代码检测器

PHPSTAN扩展程序可以轻松找到您项目中未使用的PHP代码！

概括：

phpstan扩展
♻️死周期检测
？及时死亡会员检测
？自动删除未使用的代码
流行的库支持
可自定义的用法提供商

安装：

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服务（规则，扩展，...）

Nette：

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

自动删除死亡代码

如果您确定报告的方法已经死了，则可以通过使用removeDeadCode错误格式运行Phpstan自动将其删除：

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

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

未知类型的呼叫

为了防止误报，我们通过将所有名为method $unknown->method()的方法标记为使用
- 对于严格键入的代码库，可能不需要这种行为，因为例如，单个new $unknown()将标记所有使用的构造函数
- 因此，您可以在phpstan.neon.dist中禁用此功能：
同样适用于未知类型的常数获取（例如$unknown::CONSTANT ）

 parameters :
    shipmonkDeadCode :
        trackMixedAccess : false

如果您想检查代码库中存在多少个情况，可以使用-vvv运行Phpstan分析，并且您会看到一些诊断：

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

与tomasvotruba/未使用的公共场所进行比较

您可以看到详细的比较PR
基本上，他们的分析不那么精确且灵活。主要：
- 它无法检测到死去的构造函数
- 它无法正确检测继承层次结构中的呼叫
- 它不提供对使用方法的任何自定义调整
- 它几乎没有内置库扩展名
- 它忽略了特质方法
- 缺少许多次要功能，例如类弦呼叫，动态方法调用，阵列回调，nullsafe呼叫链等
- 它无法检测到死周期或传统的死法
- 它没有内置的死代码删除

限制：

匿名类的方法从未报告为死亡（phpstan限制）
抽象特征方法从未报告为死亡
大多数魔术方法（例如__get ， __set等）从未报告为死亡
- 仅支持的是： __construct ， __clone

其他有问题的情况：

构造函数：

对于Symfony Apps和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 ();
    }
}