vendor/symfony/twig-bridge/Command/LintCommand.php line 224

  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Bridge\Twig\Command;
  14. use Symfony\Component\Console\Attribute\AsCommand;
  15. use Symfony\Component\Console\CI\GithubActionReporter;
  16. use Symfony\Component\Console\Command\Command;
  17. use Symfony\Component\Console\Completion\CompletionInput;
  18. use Symfony\Component\Console\Completion\CompletionSuggestions;
  19. use Symfony\Component\Console\Exception\InvalidArgumentException;
  20. use Symfony\Component\Console\Exception\RuntimeException;
  21. use Symfony\Component\Console\Input\InputArgument;
  22. use Symfony\Component\Console\Input\InputInterface;
  23. use Symfony\Component\Console\Input\InputOption;
  24. use Symfony\Component\Console\Output\OutputInterface;
  25. use Symfony\Component\Console\Style\SymfonyStyle;
  26. use Symfony\Component\Finder\Finder;
  27. use Twig\Environment;
  28. use Twig\Error\Error;
  29. use Twig\Loader\ArrayLoader;
  30. use Twig\Loader\FilesystemLoader;
  31. use Twig\Source;
  33. /**
  34.  * Command that will validate your template syntax and output encountered errors.
  35.  *
  36.  * @author Marc Weistroff <marc.weistroff@sensiolabs.com>
  37.  * @author Jérôme Tamarelle <jerome@tamarelle.net>
  38.  */
  39. #[AsCommand(name: 'lint:twig', description: 'Lint a Twig template and outputs encountered errors')]
  40. class LintCommand extends Command
  41. {
  42.     private string $format;
  44.     public function __construct(
  45.         private Environment $twig,
  46.         private array $namePatterns = ['*.twig'],
  47.     ) {
  48.         parent::__construct();
  49.     }
  51.     protected function configure()
  52.     {
  53.         $this
  54.             ->addOption('format', null, InputOption::VALUE_REQUIRED, 'The output format')
  55.             ->addOption('show-deprecations', null, InputOption::VALUE_NONE, 'Show deprecations as errors')
  56.             ->addArgument('filename', InputArgument::IS_ARRAY, 'A file, a directory or "-" for reading from STDIN')
  57.             ->setHelp(<<<'EOF'
  58. The <info>%command.name%</info> command lints a template and outputs to STDOUT
  59. the first encountered syntax error.
  61. You can validate the syntax of contents passed from STDIN:
  63.   <info>cat filename | php %command.full_name% -</info>
  65. Or the syntax of a file:
  67.   <info>php %command.full_name% filename</info>
  69. Or of a whole directory:
  71.   <info>php %command.full_name% dirname</info>
  72.   <info>php %command.full_name% dirname --format=json</info>
  74. EOF
  75.             )
  76.         ;
  77.     }
  79.     protected function execute(InputInterface $input, OutputInterface $output): int
  80.     {
  81.         $io = new SymfonyStyle($input, $output);
  82.         $filenames = $input->getArgument('filename');
  83.         $showDeprecations = $input->getOption('show-deprecations');
  84.         $this->format = $input->getOption('format') ?? (GithubActionReporter::isGithubActionEnvironment() ? 'github' : 'txt');
  86.         if (['-'] === $filenames) {
  87.             return $this->display($input, $output, $io, [$this->validate(file_get_contents('php://stdin'), uniqid('sf_', true))]);
  88.         }
  90.         if (!$filenames) {
  91.             $loader = $this->twig->getLoader();
  92.             if ($loader instanceof FilesystemLoader) {
  93.                 $paths = [];
  94.                 foreach ($loader->getNamespaces() as $namespace) {
  95.                     $paths[] = $loader->getPaths($namespace);
  96.                 }
  97.                 $filenames = array_merge(...$paths);
  98.             }
  100.             if (!$filenames) {
  101.                 throw new RuntimeException('Please provide a filename or pipe template content to STDIN.');
  102.             }
  103.         }
  105.         if ($showDeprecations) {
  106.             $prevErrorHandler = set_error_handler(static function ($level, $message, $file, $line) use (&$prevErrorHandler) {
  107.                 if (\E_USER_DEPRECATED === $level) {
  108.                     $templateLine = 0;
  109.                     if (preg_match('/ at line (\d+)[ .]/', $message, $matches)) {
  110.                         $templateLine = $matches[1];
  111.                     }
  113.                     throw new Error($message, $templateLine);
  114.                 }
  116.                 return $prevErrorHandler ? $prevErrorHandler($level, $message, $file, $line) : false;
  117.             });
  118.         }
  120.         try {
  121.             $filesInfo = $this->getFilesInfo($filenames);
  122.         } finally {
  123.             if ($showDeprecations) {
  124.                 restore_error_handler();
  125.             }
  126.         }
  128.         return $this->display($input, $output, $io, $filesInfo);
  129.     }
  131.     private function getFilesInfo(array $filenames): array
  132.     {
  133.         $filesInfo = [];
  134.         foreach ($filenames as $filename) {
  135.             foreach ($this->findFiles($filename) as $file) {
  136.                 $filesInfo[] = $this->validate(file_get_contents($file), $file);
  137.             }
  138.         }
  140.         return $filesInfo;
  141.     }
  143.     protected function findFiles(string $filename)
  144.     {
  145.         if (is_file($filename)) {
  146.             return [$filename];
  147.         } elseif (is_dir($filename)) {
  148.             return Finder::create()->files()->in($filename)->name($this->namePatterns);
  149.         }
  151.         throw new RuntimeException(sprintf('File or directory "%s" is not readable.', $filename));
  152.     }
  154.     private function validate(string $template, string $file): array
  155.     {
  156.         $realLoader = $this->twig->getLoader();
  157.         try {
  158.             $temporaryLoader = new ArrayLoader([$file => $template]);
  159.             $this->twig->setLoader($temporaryLoader);
  160.             $nodeTree = $this->twig->parse($this->twig->tokenize(new Source($template, $file)));
  161.             $this->twig->compile($nodeTree);
  162.             $this->twig->setLoader($realLoader);
  163.         } catch (Error $e) {
  164.             $this->twig->setLoader($realLoader);
  166.             return ['template' => $template, 'file' => $file, 'line' => $e->getTemplateLine(), 'valid' => false, 'exception' => $e];
  167.         }
  169.         return ['template' => $template, 'file' => $file, 'valid' => true];
  170.     }
  172.     private function display(InputInterface $input, OutputInterface $output, SymfonyStyle $io, array $files)
  173.     {
  174.         return match ($this->format) {
  175.             'txt' => $this->displayTxt($output, $io, $files),
  176.             'json' => $this->displayJson($output, $files),
  177.             'github' => $this->displayTxt($output, $io, $files, true),
  178.             default => throw new InvalidArgumentException(sprintf('The format "%s" is not supported.', $input->getOption('format'))),
  179.         };
  180.     }
  182.     private function displayTxt(OutputInterface $output, SymfonyStyle $io, array $filesInfo, bool $errorAsGithubAnnotations = false)
  183.     {
  184.         $errors = 0;
  185.         $githubReporter = $errorAsGithubAnnotations ? new GithubActionReporter($output) : null;
  187.         foreach ($filesInfo as $info) {
  188.             if ($info['valid'] && $output->isVerbose()) {
  189.                 $io->comment('<info>OK</info>'.($info['file'] ? sprintf(' in %s', $info['file']) : ''));
  190.             } elseif (!$info['valid']) {
  191.                 ++$errors;
  192.                 $this->renderException($io, $info['template'], $info['exception'], $info['file'], $githubReporter);
  193.             }
  194.         }
  196.         if (0 === $errors) {
  197.             $io->success(sprintf('All %d Twig files contain valid syntax.', \count($filesInfo)));
  198.         } else {
  199.             $io->warning(sprintf('%d Twig files have valid syntax and %d contain errors.', \count($filesInfo) - $errors, $errors));
  200.         }
  202.         return min($errors, 1);
  203.     }
  205.     private function displayJson(OutputInterface $output, array $filesInfo)
  206.     {
  207.         $errors = 0;
  209.         array_walk($filesInfo, function (&$v) use (&$errors) {
  210.             $v['file'] = (string) $v['file'];
  211.             unset($v['template']);
  212.             if (!$v['valid']) {
  213.                 $v['message'] = $v['exception']->getMessage();
  214.                 unset($v['exception']);
  215.                 ++$errors;
  216.             }
  217.         });
  219.         $output->writeln(json_encode($filesInfo, \JSON_PRETTY_PRINT | \JSON_UNESCAPED_SLASHES));
  221.         return min($errors, 1);
  222.     }
  224.     private function renderException(SymfonyStyle $output, string $template, Error $exception, string $file = null, GithubActionReporter $githubReporter = null)
  225.     {
  226.         $line = $exception->getTemplateLine();
  228.         $githubReporter?->error($exception->getRawMessage(), $file, $line <= 0 ? null : $line);
  230.         if ($file) {
  231.             $output->text(sprintf('<error> ERROR </error> in %s (line %s)', $file, $line));
  232.         } else {
  233.             $output->text(sprintf('<error> ERROR </error> (line %s)', $line));
  234.         }
  236.         // If the line is not known (this might happen for deprecations if we fail at detecting the line for instance),
  237.         // we render the message without context, to ensure the message is displayed.
  238.         if ($line <= 0) {
  239.             $output->text(sprintf('<error> >> %s</error> ', $exception->getRawMessage()));
  241.             return;
  242.         }
  244.         foreach ($this->getContext($template, $line) as $lineNumber => $code) {
  245.             $output->text(sprintf(
  246.                 '%s %-6s %s',
  247.                 $lineNumber === $line ? '<error> >> </error>' : '    ',
  248.                 $lineNumber,
  249.                 $code
  250.             ));
  251.             if ($lineNumber === $line) {
  252.                 $output->text(sprintf('<error> >> %s</error> ', $exception->getRawMessage()));
  253.             }
  254.         }
  255.     }
  257.     private function getContext(string $template, int $line, int $context = 3)
  258.     {
  259.         $lines = explode("\n", $template);
  261.         $position = max(0, $line - $context);
  262.         $max = min(\count($lines), $line - 1 + $context);
  264.         $result = [];
  265.         while ($position < $max) {
  266.             $result[$position + 1] = $lines[$position];
  267.             ++$position;
  268.         }
  270.         return $result;
  271.     }
  273.     public function complete(CompletionInput $input, CompletionSuggestions $suggestions): void
  274.     {
  275.         if ($input->mustSuggestOptionValuesFor('format')) {
  276.             $suggestions->suggestValues(['txt', 'json', 'github']);
  277.         }
  278.     }
  279. }