phpstan-custom-rule-development

PHPStanのCustom Rule開発環境サンプル

ディレクトリ構成

.
|-- phpstan.neon       # config（実行したいCustom Ruleをここで指定する）
|-- src                  
|   `-- SomeClass.php  # 解析対象のコード
|-- Rules
|   `-- MyRule.php     # カスタムルール
`-- Tests
    `-- MyRuleTest
        |-- data
        |   `-- my-rule.php  # テストデータ
        `-- MyRuleTest.php   # テストコード

参考

• PHPStan公式 - Custom Rules
• PHPStan公式 - Testing
• Docker×PHPStorm×Xdebugでステップ実行する設定

起動

make run

イメージ、コンテナの削除

make clean

Rector実行

XDEBUG_MODE=off ./vendor/bin/phpstan analyze -l 0 src
XDEBUG_MODE=off ./vendor/bin/phpstan analyse -l 0 --debug src
XDEBUG_MODE=off ./vendor/bin/phpstan clear-result-cache

ユニットテスト

XDEBUG_MODE=off ./vendor/bin/phpunit Tests

デバッグ

rector.phpを修正して並行処理を無効化してから--xdebugオプションを付けて実行する。

./vendor/bin/phpstan analyze --debug --xdebug -l 0 src