在 Laravel 5.7 使用 Larastan 程式碼檢查工具

Laravel
, , ,

做法

安裝 nunomaduro/larastan 套件。

1
composer require --dev nunomaduro/larastan

執行檢查。

1
php artisan code:analyse --level=5 --paths="app"
  • 參數 level 表示嚴格程度，0 表示最寬鬆，7 表示最嚴格，默認為 5。
  • 參數 path 表示指定路徑。

客製化設定

如果是檢查專案，在專案根目錄新增 phpstan.neon 檔：

1
2
3
4
5
6
7
8
9
includes:
    - ./vendor/nunomaduro/larastan/extension.neon
parameters:
    level: 5
    ignoreErrors:
        - '#Access to an undefined property App\\Demo\\[a-zA-Z0-9\\_]+::\$[a-zA-Z0-9\\_]+\.#'
        - '#Call to an undefined method App\\Http\\Resources\\DemoResource::DemoMethod\(\)\.#'
    excludes_analyse:
        - /*/*/FileToBeExcluded.php

如果是檢查套件，在套件根目錄新增 phpstan.neon.dist 檔：

1
2
3
4
5
6
includes:
    - ./vendor/nunomaduro/larastan/extension.neon
parameters:
    level: 5
    paths:
        - src

執行檢查。

1
./vendor/bin/phpstan analyse