deptrac

デプトラック

Deptrac は、プロジェクトにおけるアーキテクチャ上の決定を伝達、視覚化し、実行するのに役立つ PHP 用の静的コード分析ツールです。クラス上のアーキテクチャ層と、それらに適用するルールを自由に定義できます。

たとえば、Deptrac を使用すると、プロジェクト内のバンドル/モジュール/拡張機能が互いに完全に独立していることを確認し、再利用しやすくなります。

Deptrac を CI パイプラインで使用すると、プル リクエストが定義したアーキテクチャ ルールに違反していないことを確認できます。オプションの Graphviz または Mermaidjs フォーマッタを使用すると、レイヤー、ルール、違反を視覚化できます。

ドキュメント

ドキュメントは /docs ディレクトリで見つけるか、ドキュメント ページ https://qossmic.github.io/deptrac にアクセスしてください。

はじめる

Deptrac は Composer 経由でインストールできます。これには、deptrac パッケージを使用することをお勧めします。

 composer require --dev qossmic/deptrac

deptrac をダウンロード/インストールしたら、レイヤーと通信ルールセットを定義する構成ファイルを作成する必要があります。この構成ファイルは YAML または php で記述され、デフォルトでは、 deptrac.yaml名前でプロジェクトのルート ディレクトリに保存されます。

Deptrac は、 initコマンドを使用してテンプレートを生成できます。

 vendor/bin/deptrac init

このファイルがあれば、 analyseコマンドを実行してコードを分析できます。

 vendor/bin/deptrac

# which is equivalent to
vendor/bin/deptrac analyse --config-file=deptrac.yaml

Deptrac を実行するには、少なくとも PHP 8.1 が必要です。

nikic/php-parser が解析できる限り、古い PHP バージョンを必要とするプロジェクトを解析できます。

貢献方法

コントリビューション ガイドを参照するか、開発リポジトリ qossmic/deptrac-src に移動してください。

さらなるドキュメント

• 下位互換性 - 下位互換性へのアプローチ方法に関する一般情報
• アップグレード ガイド - Deptrac を新しいバージョンにアップグレードするときに対処する必要がある後方互換性を損なう変更とその方法のリスト。
• 中心的な概念 - レイヤー、ルール、違反について詳しく説明します。
• 構成 - depfile で使用可能なすべての設定のリファレンス
• コレクター - Deptrac でレイヤーを定義するために使用できるコレクターのリファレンス。
• フォーマッタ - Deptrac でサポートされているさまざまな出力形式をリストします。
• デバッグ - デバッグ コマンドの概要
• 行動規範 - 私たちのコミュニティ基準
• Contribute - コード変更に貢献するためのアドバイス (例: テストの実行方法や、プロジェクトの分析に使用できる変更を含む phar ファイルの構築方法)
• セキュリティ ガイド - セキュリティの脆弱性を報告する方法