annotate vendor/symfony/yaml/Command/LintCommand.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 129ea1e6d783
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 /*
Chris@0 4 * This file is part of the Symfony package.
Chris@0 5 *
Chris@0 6 * (c) Fabien Potencier <fabien@symfony.com>
Chris@0 7 *
Chris@0 8 * For the full copyright and license information, please view the LICENSE
Chris@0 9 * file that was distributed with this source code.
Chris@0 10 */
Chris@0 11
Chris@0 12 namespace Symfony\Component\Yaml\Command;
Chris@0 13
Chris@0 14 use Symfony\Component\Console\Command\Command;
Chris@16 15 use Symfony\Component\Console\Exception\InvalidArgumentException;
Chris@16 16 use Symfony\Component\Console\Exception\RuntimeException;
Chris@0 17 use Symfony\Component\Console\Input\InputInterface;
Chris@0 18 use Symfony\Component\Console\Input\InputOption;
Chris@0 19 use Symfony\Component\Console\Output\OutputInterface;
Chris@0 20 use Symfony\Component\Console\Style\SymfonyStyle;
Chris@0 21 use Symfony\Component\Yaml\Exception\ParseException;
Chris@0 22 use Symfony\Component\Yaml\Parser;
Chris@14 23 use Symfony\Component\Yaml\Yaml;
Chris@0 24
Chris@0 25 /**
Chris@0 26 * Validates YAML files syntax and outputs encountered errors.
Chris@0 27 *
Chris@0 28 * @author Grégoire Pineau <lyrixx@lyrixx.info>
Chris@0 29 * @author Robin Chalas <robin.chalas@gmail.com>
Chris@0 30 */
Chris@0 31 class LintCommand extends Command
Chris@0 32 {
Chris@14 33 protected static $defaultName = 'lint:yaml';
Chris@14 34
Chris@0 35 private $parser;
Chris@0 36 private $format;
Chris@0 37 private $displayCorrectFiles;
Chris@0 38 private $directoryIteratorProvider;
Chris@0 39 private $isReadableProvider;
Chris@0 40
Chris@0 41 public function __construct($name = null, $directoryIteratorProvider = null, $isReadableProvider = null)
Chris@0 42 {
Chris@0 43 parent::__construct($name);
Chris@0 44
Chris@0 45 $this->directoryIteratorProvider = $directoryIteratorProvider;
Chris@0 46 $this->isReadableProvider = $isReadableProvider;
Chris@0 47 }
Chris@0 48
Chris@0 49 /**
Chris@0 50 * {@inheritdoc}
Chris@0 51 */
Chris@0 52 protected function configure()
Chris@0 53 {
Chris@0 54 $this
Chris@0 55 ->setDescription('Lints a file and outputs encountered errors')
Chris@0 56 ->addArgument('filename', null, 'A file or a directory or STDIN')
Chris@0 57 ->addOption('format', null, InputOption::VALUE_REQUIRED, 'The output format', 'txt')
Chris@14 58 ->addOption('parse-tags', null, InputOption::VALUE_NONE, 'Parse custom tags')
Chris@0 59 ->setHelp(<<<EOF
Chris@0 60 The <info>%command.name%</info> command lints a YAML file and outputs to STDOUT
Chris@0 61 the first encountered syntax error.
Chris@0 62
Chris@0 63 You can validates YAML contents passed from STDIN:
Chris@0 64
Chris@0 65 <info>cat filename | php %command.full_name%</info>
Chris@0 66
Chris@0 67 You can also validate the syntax of a file:
Chris@0 68
Chris@0 69 <info>php %command.full_name% filename</info>
Chris@0 70
Chris@0 71 Or of a whole directory:
Chris@0 72
Chris@0 73 <info>php %command.full_name% dirname</info>
Chris@0 74 <info>php %command.full_name% dirname --format=json</info>
Chris@0 75
Chris@0 76 EOF
Chris@0 77 )
Chris@0 78 ;
Chris@0 79 }
Chris@0 80
Chris@0 81 protected function execute(InputInterface $input, OutputInterface $output)
Chris@0 82 {
Chris@0 83 $io = new SymfonyStyle($input, $output);
Chris@0 84 $filename = $input->getArgument('filename');
Chris@0 85 $this->format = $input->getOption('format');
Chris@0 86 $this->displayCorrectFiles = $output->isVerbose();
Chris@14 87 $flags = $input->getOption('parse-tags') ? Yaml::PARSE_CUSTOM_TAGS : 0;
Chris@0 88
Chris@0 89 if (!$filename) {
Chris@0 90 if (!$stdin = $this->getStdin()) {
Chris@16 91 throw new RuntimeException('Please provide a filename or pipe file content to STDIN.');
Chris@0 92 }
Chris@0 93
Chris@17 94 return $this->display($io, [$this->validate($stdin, $flags)]);
Chris@0 95 }
Chris@0 96
Chris@0 97 if (!$this->isReadable($filename)) {
Chris@16 98 throw new RuntimeException(sprintf('File or directory "%s" is not readable.', $filename));
Chris@0 99 }
Chris@0 100
Chris@17 101 $filesInfo = [];
Chris@0 102 foreach ($this->getFiles($filename) as $file) {
Chris@14 103 $filesInfo[] = $this->validate(file_get_contents($file), $flags, $file);
Chris@0 104 }
Chris@0 105
Chris@0 106 return $this->display($io, $filesInfo);
Chris@0 107 }
Chris@0 108
Chris@14 109 private function validate($content, $flags, $file = null)
Chris@0 110 {
Chris@14 111 $prevErrorHandler = set_error_handler(function ($level, $message, $file, $line) use (&$prevErrorHandler) {
Chris@14 112 if (E_USER_DEPRECATED === $level) {
Chris@14 113 throw new ParseException($message, $this->getParser()->getRealCurrentLineNb() + 1);
Chris@14 114 }
Chris@14 115
Chris@14 116 return $prevErrorHandler ? $prevErrorHandler($level, $message, $file, $line) : false;
Chris@14 117 });
Chris@14 118
Chris@0 119 try {
Chris@14 120 $this->getParser()->parse($content, Yaml::PARSE_CONSTANT | $flags);
Chris@0 121 } catch (ParseException $e) {
Chris@17 122 return ['file' => $file, 'line' => $e->getParsedLine(), 'valid' => false, 'message' => $e->getMessage()];
Chris@14 123 } finally {
Chris@14 124 restore_error_handler();
Chris@0 125 }
Chris@0 126
Chris@17 127 return ['file' => $file, 'valid' => true];
Chris@0 128 }
Chris@0 129
Chris@0 130 private function display(SymfonyStyle $io, array $files)
Chris@0 131 {
Chris@0 132 switch ($this->format) {
Chris@0 133 case 'txt':
Chris@0 134 return $this->displayTxt($io, $files);
Chris@0 135 case 'json':
Chris@0 136 return $this->displayJson($io, $files);
Chris@0 137 default:
Chris@16 138 throw new InvalidArgumentException(sprintf('The format "%s" is not supported.', $this->format));
Chris@0 139 }
Chris@0 140 }
Chris@0 141
Chris@0 142 private function displayTxt(SymfonyStyle $io, array $filesInfo)
Chris@0 143 {
Chris@17 144 $countFiles = \count($filesInfo);
Chris@0 145 $erroredFiles = 0;
Chris@0 146
Chris@0 147 foreach ($filesInfo as $info) {
Chris@0 148 if ($info['valid'] && $this->displayCorrectFiles) {
Chris@0 149 $io->comment('<info>OK</info>'.($info['file'] ? sprintf(' in %s', $info['file']) : ''));
Chris@0 150 } elseif (!$info['valid']) {
Chris@0 151 ++$erroredFiles;
Chris@0 152 $io->text('<error> ERROR </error>'.($info['file'] ? sprintf(' in %s', $info['file']) : ''));
Chris@0 153 $io->text(sprintf('<error> >> %s</error>', $info['message']));
Chris@0 154 }
Chris@0 155 }
Chris@0 156
Chris@14 157 if (0 === $erroredFiles) {
Chris@0 158 $io->success(sprintf('All %d YAML files contain valid syntax.', $countFiles));
Chris@0 159 } else {
Chris@0 160 $io->warning(sprintf('%d YAML files have valid syntax and %d contain errors.', $countFiles - $erroredFiles, $erroredFiles));
Chris@0 161 }
Chris@0 162
Chris@0 163 return min($erroredFiles, 1);
Chris@0 164 }
Chris@0 165
Chris@0 166 private function displayJson(SymfonyStyle $io, array $filesInfo)
Chris@0 167 {
Chris@0 168 $errors = 0;
Chris@0 169
Chris@0 170 array_walk($filesInfo, function (&$v) use (&$errors) {
Chris@0 171 $v['file'] = (string) $v['file'];
Chris@0 172 if (!$v['valid']) {
Chris@0 173 ++$errors;
Chris@0 174 }
Chris@0 175 });
Chris@0 176
Chris@0 177 $io->writeln(json_encode($filesInfo, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES));
Chris@0 178
Chris@0 179 return min($errors, 1);
Chris@0 180 }
Chris@0 181
Chris@0 182 private function getFiles($fileOrDirectory)
Chris@0 183 {
Chris@0 184 if (is_file($fileOrDirectory)) {
Chris@0 185 yield new \SplFileInfo($fileOrDirectory);
Chris@0 186
Chris@0 187 return;
Chris@0 188 }
Chris@0 189
Chris@0 190 foreach ($this->getDirectoryIterator($fileOrDirectory) as $file) {
Chris@17 191 if (!\in_array($file->getExtension(), ['yml', 'yaml'])) {
Chris@0 192 continue;
Chris@0 193 }
Chris@0 194
Chris@0 195 yield $file;
Chris@0 196 }
Chris@0 197 }
Chris@0 198
Chris@0 199 private function getStdin()
Chris@0 200 {
Chris@0 201 if (0 !== ftell(STDIN)) {
Chris@0 202 return;
Chris@0 203 }
Chris@0 204
Chris@0 205 $inputs = '';
Chris@0 206 while (!feof(STDIN)) {
Chris@0 207 $inputs .= fread(STDIN, 1024);
Chris@0 208 }
Chris@0 209
Chris@0 210 return $inputs;
Chris@0 211 }
Chris@0 212
Chris@0 213 private function getParser()
Chris@0 214 {
Chris@0 215 if (!$this->parser) {
Chris@0 216 $this->parser = new Parser();
Chris@0 217 }
Chris@0 218
Chris@0 219 return $this->parser;
Chris@0 220 }
Chris@0 221
Chris@0 222 private function getDirectoryIterator($directory)
Chris@0 223 {
Chris@0 224 $default = function ($directory) {
Chris@0 225 return new \RecursiveIteratorIterator(
Chris@0 226 new \RecursiveDirectoryIterator($directory, \FilesystemIterator::SKIP_DOTS | \FilesystemIterator::FOLLOW_SYMLINKS),
Chris@0 227 \RecursiveIteratorIterator::LEAVES_ONLY
Chris@0 228 );
Chris@0 229 };
Chris@0 230
Chris@0 231 if (null !== $this->directoryIteratorProvider) {
Chris@17 232 return \call_user_func($this->directoryIteratorProvider, $directory, $default);
Chris@0 233 }
Chris@0 234
Chris@0 235 return $default($directory);
Chris@0 236 }
Chris@0 237
Chris@0 238 private function isReadable($fileOrDirectory)
Chris@0 239 {
Chris@0 240 $default = function ($fileOrDirectory) {
Chris@0 241 return is_readable($fileOrDirectory);
Chris@0 242 };
Chris@0 243
Chris@0 244 if (null !== $this->isReadableProvider) {
Chris@17 245 return \call_user_func($this->isReadableProvider, $fileOrDirectory, $default);
Chris@0 246 }
Chris@0 247
Chris@0 248 return $default($fileOrDirectory);
Chris@0 249 }
Chris@0 250 }