plugin_settings_summary.php

<?php

declare(strict_types=1);

use imperazim\commons\collection\Arr;
use imperazim\commons\diagnostics\Report;
use imperazim\commons\filesystem\DataFile;
use imperazim\commons\filesystem\Path;
use imperazim\commons\number\Number;
use imperazim\commons\text\Text;
use imperazim\commons\time\Duration;
use imperazim\commons\validation\Validator;

/**
 * Example: load plugin-owned settings, normalize display values and return a
 * small diagnostic report that can be sent to a command sender or logger.
 *
 * @param array<string, mixed> $defaults
 */
function buildSettingsSummary(string $dataFolder, array $defaults = []): string {
    $settings = DataFile::at(Path::join($dataFolder, 'settings.json'));
    $settings->ensure($defaults + [
        'server' => [
            'name' => 'Crystal Lobby',
            'max-players' => 100,
        ],
        'cooldown-seconds' => 300,
    ]);

    $data = $settings->read();
    $serverName = (string) Arr::get($data, 'server.name', 'Server');
    $slug = Text::slug($serverName);
    if (!Validator::filename($slug . '.json')) {
        throw new InvalidArgumentException('Generated settings filename is not safe.');
    }

    $maxPlayers = (int) Arr::get($data, 'server.max-players', 0);
    $cooldownSeconds = (int) Arr::get($data, 'cooldown-seconds', 0);

    return Report::create('Plugin Settings')
        ->item('Name', Text::title($serverName))
        ->item('Slug', $slug)
        ->item('Max players', Number::compact($maxPlayers))
        ->item('Cooldown', Duration::formatShort($cooldownSeconds))
        ->toString();
}