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 ();
    }
}