* * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Symfony\Bridge\Twig\Command; if (!defined('JSON_PRETTY_PRINT')) { define('JSON_PRETTY_PRINT', 128); } use Symfony\Component\Console\Command\Command; use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Input\InputOption; use Symfony\Component\Console\Output\OutputInterface; use Symfony\Component\Finder\Finder; /** * Command that will validate your template syntax and output encountered errors. * * @author Marc Weistroff * @author Jérôme Tamarelle */ class LintCommand extends Command { private $twig; /** * {@inheritdoc} */ public function __construct($name = 'twig:lint') { parent::__construct($name); } /** * Sets the twig environment * * @param \Twig_Environment $twig */ public function setTwigEnvironment(\Twig_Environment $twig) { $this->twig = $twig; } /** * @return \Twig_Environment $twig */ protected function getTwigEnvironment() { return $this->twig; } protected function configure() { $this ->setDescription('Lints a template and outputs encountered errors') ->addOption('format', null, InputOption::VALUE_REQUIRED, 'The output format', 'txt') ->addArgument('filename') ->setHelp(<<%command.name% command lints a template and outputs to STDOUT the first encountered syntax error. You can validate the syntax of a file: php %command.full_name% filename Or of a whole directory: php %command.full_name% dirname php %command.full_name% dirname --format=json You can also pass the template contents from STDIN: cat filename | php %command.full_name% EOF ) ; } protected function execute(InputInterface $input, OutputInterface $output) { $twig = $this->getTwigEnvironment(); $filename = $input->getArgument('filename'); if (!$filename) { if (0 !== ftell(STDIN)) { throw new \RuntimeException("Please provide a filename or pipe template content to STDIN."); } $template = ''; while (!feof(STDIN)) { $template .= fread(STDIN, 1024); } return $this->display($input, $output, array($this->validate($twig, $template))); } $filesInfo = array(); foreach ($this->findFiles($filename) as $file) { $filesInfo[] = $this->validate($twig, file_get_contents($file), $file); } return $this->display($input, $output, $filesInfo); } protected function findFiles($filename) { if (is_file($filename)) { return array($filename); } elseif (is_dir($filename)) { return Finder::create()->files()->in($filename)->name('*.twig'); } throw new \RuntimeException(sprintf('File or directory "%s" is not readable', $filename)); } private function validate(\Twig_Environment $twig, $template, $file = null) { try { $twig->parse($twig->tokenize($template, $file ? (string) $file : null)); } catch (\Twig_Error $e) { return array('template' => $template, 'file' => $file, 'valid' => false, 'exception' => $e); } return array('template' => $template, 'file' => $file, 'valid' => true); } private function display(InputInterface $input, OutputInterface $output, $files) { switch ($input->getOption('format')) { case 'txt': return $this->displayTxt($output, $files); case 'json': return $this->displayJson($output, $files); default: throw new \InvalidArgumentException(sprintf('The format "%s" is not supported.', $input->getOption('format'))); } } private function displayTxt(OutputInterface $output, $filesInfo) { $errors = 0; foreach ($filesInfo as $info) { if ($info['valid'] && $output->isVerbose()) { $output->writeln('OK'.($info['file'] ? sprintf(' in %s', $info['file']) : '')); } elseif (!$info['valid']) { $errors++; $this->renderException($output, $info['template'], $info['exception'], $info['file']); } } $output->writeln(sprintf('%d/%d valid files', count($filesInfo) - $errors, count($filesInfo))); return min($errors, 1); } private function displayJson(OutputInterface $output, $filesInfo) { $errors = 0; array_walk($filesInfo, function (&$v) use (&$errors) { $v['file'] = (string) $v['file']; unset($v['template']); if (!$v['valid']) { $v['message'] = $v['exception']->getMessage(); unset($v['exception']); $errors++; } }); $output->writeln(json_encode($filesInfo, JSON_PRETTY_PRINT)); return min($errors, 1); } private function renderException(OutputInterface $output, $template, \Twig_Error $exception, $file = null) { $line = $exception->getTemplateLine(); if ($file) { $output->writeln(sprintf("KO in %s (line %s)", $file, $line)); } else { $output->writeln(sprintf("KO (line %s)", $line)); } foreach ($this->getContext($template, $line) as $no => $code) { $output->writeln(sprintf( "%s %-6s %s", $no == $line ? '>>' : ' ', $no, $code )); if ($no == $line) { $output->writeln(sprintf('>> %s ', $exception->getRawMessage())); } } } private function getContext($template, $line, $context = 3) { $lines = explode("\n", $template); $position = max(0, $line - $context); $max = min(count($lines), $line - 1 + $context); $result = array(); while ($position < $max) { $result[$position + 1] = $lines[$position]; $position++; } return $result; } }