PhpCodeArcheology

phpcodearcheology

PHPCodearcheologyは、PHPプロジェクトを分析し、ファイル、クラス、方法、機能に関する詳細なメトリックを提供します。包括的なHTMLレポートは、プロジェクトの評価に必要な深い洞察を提供します。

なぜphpcodearcheology？

PHPCODERACHEOLOGYは、詳細なメトリックと洞察を提供することにより、開発者がPHPコードベースをより深く理解するのを支援するために作成されました。レガシーシステムを維持している場合でも、新しいプロジェクトに取り組んでいる場合でも、このツールはコードの品質と保守性の向上を促進することを目的としています。

前提条件

環境が次の要件を満たしていることを確認してください。

• PHPバージョン8.2以上
• 作曲家がインストールされました

インストール

端末で次のコマンドを実行して、Composerを使用してphpcodearcheologyをインストールしてください。

 composer require --dev php-code-archeology/php-code-archeology

クイックスタート

phpcodearcheologyを開始するには、プロジェクトルートで次のコマンドを実行します。

 ./vendor/bin/phpcodearcheology

箱から出して、phpcodearcheologyはSRC dirをスキャンし、 TMP/レポートでレポートを作成します。

フォルダーを含める、または除外されるなどのスキャンをカスタマイズするには、カスタムPHPファイル拡張機能、またはその他の設定を定義するには、プロジェクトルートにphp-codearch-config.yaml構成ファイルを作成します。ガイダンスについては、このサンプル構成ファイルを参照してください。

レポート

phpcodearcheologyによって生成された典型的なレポートには、次のようなメトリックが含まれます。

• ファイル：プロジェクト内のファイルの総数。
• ファイルエラー：ファイルにあるエラーのカウント。
• 関数カウント：関数の総数。
• クラス数：クラスの総数。
• 抽象クラス：抽象クラスのカウント。
• インターフェイスカウント：インターフェイスの総数。
• メソッド数：パブリック、プライベート、および静的メソッドを含むメソッドの総数。
• パブリック方法：パブリック方法のカウント。
• プライベート方法：プライベート方法のカウント。
• 静的方法：静的方法のカウント。
• 出力ステートメント：エコーとprintfコールのカウント。
• コードの行（loc） ：コメントや空の行を含むコードの合計行。
• コードの論理行（LLOC） ：コメントと空の行を除くコードの合計行。
• コメントの行（CLOC） ：コメントを含むコードの行。
• HTMLコード行：HTMLを含むコードの行。
• Cyclomaticの複雑さ（CC） ：コードの複雑さの尺度。
• 保守性インデックス（MI） ：コードの保守性を示すインデックス。
• LCOM ：クラスの方法の結束の欠如。
• 不安定性：依存関係に基づくクラスの安定性の測定。
• Efferent Coupling（CE） ：クラスが依存しているクラスの数。
• 求心性カップリング（CA） ：クラスに依存するクラスの数。
• 難易度：コードが理解するのがどれほど難しいかの尺度。
• 取り組み：コードを理解するために必要な努力の推定。
• 語彙：コード内の一意のオペレーターとオペランドの数。
• 長さ：コード内のオペレーターとオペランドの総数。
• ボリューム：コードの語彙と長さのサイズ。
• コメントの重み：コードのコメントの重み。
• メインラインからの距離：クラスが抽象的で安定している尺度。

HTMLレポートのサンプルスクリーンショットは次のとおりです。

ドキュメント

私は現在、ドキュメントに取り組んでいます。私は主に自分のプロジェクトにツールを使用しており、継続的な開発に焦点を当てているため、包括的なドキュメントを完成させるには時間がかかる場合があります。

著者

Marcus Kober、@mrcskbr、Github