dead code detectorダウンロード - dead code detectorソースコードのダウンロード

dead code detector

その他のカテゴリー

0.7.0

ダウンロード

PHPのデッドコード検出器

PHPSTAN拡張機能プロジェクトで使用されていないPHPコードを簡単に見つけてください！

まとめ：

phpstan拡張機能
Dead Cycles検出
？推移的な死んだメンバー検出
？未使用コードの自動削除
人気のあるライブラリはサポートしています
カスタマイズ可能な使用プロバイダー

インストール：

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

公式拡張機能インストラーを使用するか、ルールをロードするだけです。

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

サポートされているライブラリ：

Symfony：

あなたのサービスを介してDICによって行われた電話！
- コンストラクター、通話、工場の方法
- phpstan/phpstan-symfony with 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 Annotationsを求めています

これらのライブラリはすべて、作曲家の依存関係内にある場合、自動エンパニーです。それらのいくつかを強制的に有効/無効にしたい場合は、次のことができます。

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

一般的な使用プロバイダー：

反射：

ReflectionClassを介してアクセスされる定数またはメソッドは、使用されたときに検出されます
- Eg $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/Unush-Publicとの比較

詳細な比較PRを見ることができます
基本的に、彼らの分析は正確ではなく、柔軟性が低くなります。主に：
- 死んだコンストラクターを検出できません
- 継承階層内の呼び出しを適切に検出しません
- 使用済みの方法のカスタム調整は提供されません
- ライブラリ拡張機能が組み込まれていません
- それは特性方法を無視します
- クラスストリングコール、動的メソッドコール、配列コールバック、nullsafeコールチェーンなど、多くのマイナーな機能がありません
- 死んだサイクルを検出することも、トランタティブに死んだ方法を検出することもできません
- デッドコードの削除が組み込まれていません

制限：

匿名のクラスの方法は、死んでいると報告されません（phpstanの制限）
抽象的特性方法は、死んだとは決して報告されません
ほとんどの魔法の方法（例： __get 、 __set 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 ();
    }
}