savinmikhail / Comments-Density

src/AnalyzeComments/File/CommentFinder.php

<?php

declare(strict_types=1);

namespace SavinMikhail\CommentsDensity\AnalyzeComments\File;

use PhpParser\NodeTraverser;
use PhpParser\Parser;
use PhpParser\ParserFactory;
use SavinMikhail\CommentsDensity\AnalyzeComments\Analyzer\DTO\Output\CommentDTO;
use SavinMikhail\CommentsDensity\AnalyzeComments\Analyzer\Visitors\Checkers\NodeNeedsDocblockChecker;
use SavinMikhail\CommentsDensity\AnalyzeComments\Analyzer\Visitors\CommentVisitor;
use SavinMikhail\CommentsDensity\AnalyzeComments\Analyzer\Visitors\MissingDocBlockVisitor;
use SavinMikhail\CommentsDensity\AnalyzeComments\Comments\CommentTypeFactory;
use SavinMikhail\CommentsDensity\AnalyzeComments\Comments\MissingDocBlock;
use SavinMikhail\CommentsDensity\AnalyzeComments\Config\DTO\Config;

use function in_array;

final readonly class CommentFinder

A parse error occurred: Syntax error, unexpected T_READONLY, expecting T_CLASS on line 20 at column 6

{
    private Parser $parser;

    public function __construct(
        private CommentTypeFactory $commentFactory,
        private Config $configDTO,
        ?Parser $parser = null,
    ) {
        $this->parser = $parser ?? (new ParserFactory())->createForHostVersion();
    }

    /**
     * @return CommentDTO[]
     */
    public function __invoke(string $content, string $filename): array
    {
        $traverser = new NodeTraverser();

        $missingDocBlockVisitor = new MissingDocBlockVisitor(
            $filename,
            new NodeNeedsDocblockChecker($this->configDTO->docblockConfigDTO),
        );
        if (in_array(MissingDocBlock::NAME, $this->configDTO->getAllowedTypes(), true)) {
            $traverser->addVisitor($missingDocBlockVisitor);
        }

        $commentVisitor = new CommentVisitor(
            $filename,
            $this->commentFactory,
        );
        $traverser->addVisitor($commentVisitor);

        $traverser->traverse($this->parser->parse($content));

        return [...$missingDocBlockVisitor->missingDocBlocks, ...$commentVisitor->comments];
    }
}