Laravel 新程式碼分析生態系 — surveyor / ranger / roster

composer require laravel/surveyor

use Laravel\Surveyor\Analyzer\Analyzer;

$analyzer = app(Analyzer::class);

// 以檔案路徑分析
$result = $analyzer->analyze('/path/to/your/File.php');

// 取得已分析 scope
$scope = $result->analyzed();

// 取得類別結果
$classResult = $result->result();

$result = $analyzer->analyzeClass(\App\Models\User::class);
$classResult = $result->result();

$classResult = $analyzer->analyzeClass(App\Models\User::class)->result();

// 類別資訊
$name = $classResult->name();            // 'App\Models\User'
$namespace = $classResult->namespace();  // 'App\Models'
$filePath = $classResult->filePath();

// 繼承關係
$extends = $classResult->extends();
$implements = $classResult->implements();

// 方法資訊
$method = $classResult->getMethod('store');
$returnType = $method->returnType();
$parameters = $method->parameters();
$rules = $method->validationRules(); // 也可取得驗證規則

// 屬性資訊
$property = $classResult->getProperty('email');
$type = $property->type;
$visibility = $property->visibility; // 'public'、'protected'、'private'

// 取得公開方法與屬性清單
$publicMethods = $classResult->publicMethods();
$publicProperties = $classResult->publicProperties();

use Laravel\Surveyor\Types\Type;

// 建立各種型別
$stringType = Type::string();
$intType = Type::int();
$boolType = Type::bool();
$nullType = Type::null();

// Union 型別（如 string|null）
$unionType = Type::union(Type::string(), Type::null());

// 型別判斷
use Laravel\Surveyor\Types\StringType;

if (Type::is($returnType, StringType::class)) {
    // 字串型別的處理
}

use Laravel\Surveyor\Analyzer\AnalyzedCache;

// 啟用磁碟快取
AnalyzedCache::enableDiskCache(storage_path('surveyor-cache'));

// 清除快取
AnalyzedCache::clear();

SURVEYOR_CACHE_ENABLED=true
SURVEYOR_CACHE_DIR=/path/to/cache

$result = $analyzer->analyzeClass(App\Models\User::class)->result();

// 資料庫屬性會被自動偵測
$emailProperty = $result->getProperty('email');

// 判斷關聯方法
$method = $result->getMethod('posts');
if ($method->isModelRelation()) {
    // 這個方法為關聯
}

composer require laravel/ranger

use Laravel\Ranger\Ranger;
use Laravel\Ranger\Components;
use Illuminate\Support\Collection;

$ranger = app(Ranger::class);

// 每發現一個路由就被呼叫
$ranger->onRoute(function (Components\Route $route) {
    echo $route->uri();
});

// 每發現一個模型就被呼叫
$ranger->onModel(function (Components\Model $model) {
    foreach ($model->getAttributes() as $name => $type) {
        // 處理屬性名與型別
    }
});

// 每發現一個 Enum 就被呼叫
$ranger->onEnum(function (Components\Enum $enum) {
    //
});

// 每發現一個廣播事件就被呼叫
$ranger->onBroadcastEvent(function (Components\BroadcastEvent $event) {
    //
});

// 所有路由收集完後只呼叫一次
$ranger->onRoutes(function (Collection $routes) {
    //
});

// 所有模型收集完後只呼叫一次
$ranger->onModels(function (Collection $models) {
    //
});

// 走訪整個應用並觸發 callback
$ranger->walk();

composer require laravel/roster --dev

use Laravel\Roster\Roster;
use Laravel\Roster\Packages;

// 掃描目錄取得 Roster
$roster = Roster::scan($directory);

// 已安裝套件清單
$roster->packages();

// 只列出正式環境套件
$roster->packages()->production();

// 只列出開發專用套件
$roster->packages()->dev();

// 確認是否使用特定套件
$roster->uses(Packages::INERTIA);        // bool
$roster->uses(Packages::LIVEWIRE);       // bool

// 指定版本條件確認
$roster->usesVersion(Packages::INERTIA, '2.0.0', '>=');   // Inertia 2.0.0 以上？
$roster->usesVersion(Packages::LIVEWIRE, '3.0.0', '>=');  // Livewire 3.0.0 以上？

// 偵測 JavaScript 套件管理器
$packageManager = $roster->nodePackageManager(); // 'npm'、'yarn'、'bun' 等

use Laravel\Roster\Roster;
use Laravel\Roster\Packages;

$roster = Roster::scan(base_path());

if ($roster->uses(Packages::INERTIA)) {
    // 針對 Inertia 的處理
    if ($roster->usesVersion(Packages::INERTIA, '2.0.0', '>=')) {
        // 針對 Inertia v2 以上的處理
    }
}

if ($roster->uses(Packages::LIVEWIRE)) {
    // 針對 Livewire 的處理
}

// 依 JavaScript 套件管理器改變安裝指令
$pm = $roster->nodePackageManager();
echo "Run: {$pm} install your-package";

use Laravel\Ranger\Ranger;
use Laravel\Ranger\Components;

$ranger = app(Ranger::class);
$docs = [];

$ranger->onRoute(function (Components\Route $route) use (&$docs) {
    $docs['routes'][] = [
        'uri' => $route->uri(),
        // 路由的驗證規則、回應型別亦可取得
    ];
});

$ranger->onModel(function (Components\Model $model) use (&$docs) {
    $docs['models'][] = [
        'attributes' => $model->getAttributes(),
    ];
});

$ranger->walk();

// $docs 中會收集整個應用的結構資訊