Clean up and normalize class description comments

[caendesilva]

Made this crude script to help, posting here in case of me wanting it in the future again.

<?php

// Create a list of all class descriptions (the first line in a PHPDoc) in the Framework package.

require_once __DIR__.'/../vendor/autoload.php';

$files = (new \Illuminate\Filesystem\Filesystem())->allFiles(__DIR__.'/../packages/framework/src');

$html = '';


foreach ($files as $file) {
    $source = file_get_contents($file->getPathname());
    // If file is not a class, skip it.
    if (!str_contains($source, 'class ')) {
        continue;
    }

    $reflection = new ReflectionClass('Hyde\\'.str_replace('/', '\\', substr($file->getPathname(), strlen(__DIR__.'/../packages/framework/src/'), -4)));

    $doc = $reflection->getDocComment();
    if (empty($doc)) {
        $commentText = '<span style="color: red">Missing PHPDoc</span>';
    } else {
        $commentText = trim(str_replace(['*', '/', '@experimental', '@internal', '@property', '@mixin', '@see'], '', getFirstLine($doc) ?: $doc)) ?: '<span style="color: red">Empty PHPDoc</span>';
    }

    $html .= sprintf('<tr><td><a href="%s">%s</a></td><td>%s</td></tr>'."\n", $file->getPathname(), $reflection->getName(), $commentText);
}

$html = "<table><tbody>{$html}</tbody></table>";
file_put_contents(__DIR__.'/framework-classes.html', $html);
echo $html;

function getFirstLine(string $doc): string
{
    $lines = explode("\n", $doc);
    return $lines[1] ?? '';
}

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (5029740) 100.00% compared to head (724fc2b) 100.00%.

Additional details and impacted files

@@              Coverage Diff              @@
##              master     #1502     +/-   ##
=============================================
  Coverage     100.00%   100.00%             
- Complexity      1740      3480   +1740     
=============================================
  Files            180       360    +180     
  Lines           4715      9430   +4715     
=============================================
+ Hits            4715      9430   +4715     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.