123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248 |
- <?php
- /*
- * This file is part of the Symfony package.
- *
- * (c) Fabien Potencier <fabien@symfony.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
- namespace Symfony\Component\Yaml\Command;
- use Symfony\Component\Console\Command\Command;
- use Symfony\Component\Console\Exception\InvalidArgumentException;
- use Symfony\Component\Console\Exception\RuntimeException;
- use Symfony\Component\Console\Input\InputArgument;
- use Symfony\Component\Console\Input\InputInterface;
- use Symfony\Component\Console\Input\InputOption;
- use Symfony\Component\Console\Output\OutputInterface;
- use Symfony\Component\Console\Style\SymfonyStyle;
- use Symfony\Component\Yaml\Exception\ParseException;
- use Symfony\Component\Yaml\Parser;
- use Symfony\Component\Yaml\Yaml;
- /**
- * Validates YAML files syntax and outputs encountered errors.
- *
- * @author Grégoire Pineau <lyrixx@lyrixx.info>
- * @author Robin Chalas <robin.chalas@gmail.com>
- */
- class LintCommand extends Command
- {
- protected static $defaultName = 'lint:yaml';
- private $parser;
- private $format;
- private $displayCorrectFiles;
- private $directoryIteratorProvider;
- private $isReadableProvider;
- public function __construct(string $name = null, callable $directoryIteratorProvider = null, callable $isReadableProvider = null)
- {
- parent::__construct($name);
- $this->directoryIteratorProvider = $directoryIteratorProvider;
- $this->isReadableProvider = $isReadableProvider;
- }
- /**
- * {@inheritdoc}
- */
- protected function configure()
- {
- $this
- ->setDescription('Lint a file and outputs encountered errors')
- ->addArgument('filename', InputArgument::IS_ARRAY, 'A file, a directory or "-" for reading from STDIN')
- ->addOption('format', null, InputOption::VALUE_REQUIRED, 'The output format', 'txt')
- ->addOption('parse-tags', null, InputOption::VALUE_NONE, 'Parse custom tags')
- ->setHelp(<<<EOF
- The <info>%command.name%</info> command lints a YAML file and outputs to STDOUT
- the first encountered syntax error.
- You can validates YAML contents passed from STDIN:
- <info>cat filename | php %command.full_name% -</info>
- You can also validate the syntax of a file:
- <info>php %command.full_name% filename</info>
- Or of a whole directory:
- <info>php %command.full_name% dirname</info>
- <info>php %command.full_name% dirname --format=json</info>
- EOF
- )
- ;
- }
- protected function execute(InputInterface $input, OutputInterface $output)
- {
- $io = new SymfonyStyle($input, $output);
- $filenames = (array) $input->getArgument('filename');
- $this->format = $input->getOption('format');
- $this->displayCorrectFiles = $output->isVerbose();
- $flags = $input->getOption('parse-tags') ? Yaml::PARSE_CUSTOM_TAGS : 0;
- if (['-'] === $filenames) {
- return $this->display($io, [$this->validate(file_get_contents('php://stdin'), $flags)]);
- }
- if (!$filenames) {
- throw new RuntimeException('Please provide a filename or pipe file content to STDIN.');
- }
- $filesInfo = [];
- foreach ($filenames as $filename) {
- if (!$this->isReadable($filename)) {
- throw new RuntimeException(sprintf('File or directory "%s" is not readable.', $filename));
- }
- foreach ($this->getFiles($filename) as $file) {
- $filesInfo[] = $this->validate(file_get_contents($file), $flags, $file);
- }
- }
- return $this->display($io, $filesInfo);
- }
- private function validate(string $content, int $flags, string $file = null)
- {
- $prevErrorHandler = set_error_handler(function ($level, $message, $file, $line) use (&$prevErrorHandler) {
- if (\E_USER_DEPRECATED === $level) {
- throw new ParseException($message, $this->getParser()->getRealCurrentLineNb() + 1);
- }
- return $prevErrorHandler ? $prevErrorHandler($level, $message, $file, $line) : false;
- });
- try {
- $this->getParser()->parse($content, Yaml::PARSE_CONSTANT | $flags);
- } catch (ParseException $e) {
- return ['file' => $file, 'line' => $e->getParsedLine(), 'valid' => false, 'message' => $e->getMessage()];
- } finally {
- restore_error_handler();
- }
- return ['file' => $file, 'valid' => true];
- }
- private function display(SymfonyStyle $io, array $files): int
- {
- switch ($this->format) {
- case 'txt':
- return $this->displayTxt($io, $files);
- case 'json':
- return $this->displayJson($io, $files);
- default:
- throw new InvalidArgumentException(sprintf('The format "%s" is not supported.', $this->format));
- }
- }
- private function displayTxt(SymfonyStyle $io, array $filesInfo): int
- {
- $countFiles = \count($filesInfo);
- $erroredFiles = 0;
- $suggestTagOption = false;
- foreach ($filesInfo as $info) {
- if ($info['valid'] && $this->displayCorrectFiles) {
- $io->comment('<info>OK</info>'.($info['file'] ? sprintf(' in %s', $info['file']) : ''));
- } elseif (!$info['valid']) {
- ++$erroredFiles;
- $io->text('<error> ERROR </error>'.($info['file'] ? sprintf(' in %s', $info['file']) : ''));
- $io->text(sprintf('<error> >> %s</error>', $info['message']));
- if (false !== strpos($info['message'], 'PARSE_CUSTOM_TAGS')) {
- $suggestTagOption = true;
- }
- }
- }
- if (0 === $erroredFiles) {
- $io->success(sprintf('All %d YAML files contain valid syntax.', $countFiles));
- } else {
- $io->warning(sprintf('%d YAML files have valid syntax and %d contain errors.%s', $countFiles - $erroredFiles, $erroredFiles, $suggestTagOption ? ' Use the --parse-tags option if you want parse custom tags.' : ''));
- }
- return min($erroredFiles, 1);
- }
- private function displayJson(SymfonyStyle $io, array $filesInfo): int
- {
- $errors = 0;
- array_walk($filesInfo, function (&$v) use (&$errors) {
- $v['file'] = (string) $v['file'];
- if (!$v['valid']) {
- ++$errors;
- }
- if (isset($v['message']) && false !== strpos($v['message'], 'PARSE_CUSTOM_TAGS')) {
- $v['message'] .= ' Use the --parse-tags option if you want parse custom tags.';
- }
- });
- $io->writeln(json_encode($filesInfo, \JSON_PRETTY_PRINT | \JSON_UNESCAPED_SLASHES));
- return min($errors, 1);
- }
- private function getFiles(string $fileOrDirectory): iterable
- {
- if (is_file($fileOrDirectory)) {
- yield new \SplFileInfo($fileOrDirectory);
- return;
- }
- foreach ($this->getDirectoryIterator($fileOrDirectory) as $file) {
- if (!\in_array($file->getExtension(), ['yml', 'yaml'])) {
- continue;
- }
- yield $file;
- }
- }
- private function getParser(): Parser
- {
- if (!$this->parser) {
- $this->parser = new Parser();
- }
- return $this->parser;
- }
- private function getDirectoryIterator(string $directory): iterable
- {
- $default = function ($directory) {
- return new \RecursiveIteratorIterator(
- new \RecursiveDirectoryIterator($directory, \FilesystemIterator::SKIP_DOTS | \FilesystemIterator::FOLLOW_SYMLINKS),
- \RecursiveIteratorIterator::LEAVES_ONLY
- );
- };
- if (null !== $this->directoryIteratorProvider) {
- return ($this->directoryIteratorProvider)($directory, $default);
- }
- return $default($directory);
- }
- private function isReadable(string $fileOrDirectory): bool
- {
- $default = function ($fileOrDirectory) {
- return is_readable($fileOrDirectory);
- };
- if (null !== $this->isReadableProvider) {
- return ($this->isReadableProvider)($fileOrDirectory, $default);
- }
- return $default($fileOrDirectory);
- }
- }
|