🚀PHPのソースコードからPlantUMLのクラス図を出力するツール php-class-diagram v0.1.0 をリリースしました

PHPのソースコードからPlantUMLのクラス図を出力するツール php-class-diagram v0.1.0 をリリースしました。

v0.1.0 (2202-12-08)

Features

* add package diagram description to README.
* Updated the PHP version of the development environment to 8.1.
* add `--include` option. Enabled to specify the search pattern of the PHP source code to be processed.
* add `--exclude` option. Enabled to specify the exclusion pattern of the PHP source code to be processed.

https://packagist.org/packages/smeghead/php-class-diagram

 

最近追加したオプションについて紹介します。

header

PlantUMLのヘッダーに、指定した文字列を出力します。title や   skinparam コマンドを挿入することが可能になります。skinparam コマンドを挿入できるので、スタイルのカスタマイズ等も可能になります。

$ vendor/bin/php-class-diagram --header='title "This is the class diagram"' path/to/src

include

対象のPHPのソースコードファイルを検索する際に、パターンを指定することができます。デフォルトでは、*.php を検索しますが、事情によってはphp以外の拡張子も合わせて検索したい場合に利用できます。複数のパターンを指定することができます。

$ vendor/bin/php-class-diagram --include='*.php' --include='*.php4' path/to/src

exclude

対象のPHPのソースコードファイルを検索する際に、除外するファイル名やディレクトリ名のパターンを指定することができます。複数の除外パターンを指定することができます。

$ vendor/bin/php-class-diagram --exclude='test' --exclude='*Exception.php' path/to/src

exclude オプションが追加された事によって、対象のファイル数が多い場合にディレクトリ単位だったり、ファイルパターンによって除外できるようになったので、更に効果的にクラス図を出力できます。

試してみてください。

 

Leave a Comment

Your email address will not be published. Required fields are marked *

This site uses Akismet to reduce spam. Learn how your comment data is processed.