Allow formatting of nowdoc/heredoc contents (for example GraphQL or JSON contents)

[ruudk]

In our codebase we use heredocs that we identify as GRAPHQL:

$this->execute(query: <<<'GRAPHQL'
    query {
        user {
            firstName
        }
    }
    GRAPHQL,
    variables: []
);

I would like to detect these heredocs and apply custom code that reformats those queries. Would something like that be possible?

Same could be done for <<<'JSON' where it prettyfies a JSON document for example.

Could somebody give me a suggestion on the best approach to create such a rule?

Thanks 💙

[Wirone]

@ruudk did you find solution? Would you mind sharing it?

[ruudk]

Sure, this is the solution I came up with. Works pretty well:

<?php

declare(strict_types=1);

namespace Dev\CodeStyle;

use GraphQL\Language\Parser;
use GraphQL\Language\Printer;
use PhpCsFixer\Fixer\FixerInterface;
use PhpCsFixer\FixerDefinition\FixerDefinition;
use PhpCsFixer\Tokenizer\Token;
use PhpCsFixer\Tokenizer\Tokens;
use SplFileInfo;
use Throwable;

final class GraphQLOperationFixer implements FixerInterface
{
    public function getName() : string
    {
        return 'app/graphql_operation_fixer';
    }

    public function getDefinition() : FixerDefinition
    {
        return new FixerDefinition(
            'Formats GraphQL documents in nowdoc.',
            [],
        );
    }

    public function isRisky() : bool
    {
        return false;
    }

    public function supports(SplFileInfo $file) : bool
    {
        return true;
    }

    public function getPriority() : int
    {
        return 0;
    }

    public function isCandidate(Tokens $tokens) : bool
    {
        return $tokens->isTokenKindFound(T_START_HEREDOC);
    }

    public function fix(SplFileInfo $file, Tokens $tokens) : void
    {
        for ($index = count($tokens) - 1; 0 <= $index; --$index) {
            if ($tokens[$index]->isGivenKind(T_END_HEREDOC) === false) {
                continue;
            }

            $start = $tokens->getPrevTokenOfKind($index, [[T_START_HEREDOC]]);
            if ($start === null) {
                continue;
            }

            if (str_contains($tokens[$start]->getContent(), 'GRAPHQL') === false) {
                continue;
            }

            $contentIndex = $tokens->getNextMeaningfulToken($start);

            if ($contentIndex === null) {
                continue;
            }

            $operation = $tokens[$contentIndex]->getContent();

            if (preg_match('/^(?<indent>[[:space:]]*)/', $operation, $match) !== 1) {
                continue;
            }

            try {
                $ast = Parser::parse($operation);
            } catch (Throwable) {
                continue;
            }

            $formattedOperation = Printer::doPrint($ast);

            if (str_starts_with($formattedOperation, '{')) {
                $formattedOperation = 'query ' . $formattedOperation;
            }

            $formattedOperation = preg_replace('/^/m', $match['indent'], $formattedOperation);

            if ($formattedOperation === null) {
                continue;
            }

            if ($formattedOperation === $operation) {
                continue;
            }

            $tokens[$contentIndex] = new Token([T_ENCAPSED_AND_WHITESPACE, $formattedOperation]);
        }
    }
}