123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169 |
- <?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\Bundle\FrameworkBundle\Command;
- 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\Console\Style\SymfonyStyle;
- use Symfony\Component\Finder\Finder;
- use Symfony\Component\Yaml\Exception\ParseException;
- use Symfony\Component\Yaml\Parser;
- /**
- * Validates YAML files syntax and outputs encountered errors.
- *
- * @author Grégoire Pineau <lyrixx@lyrixx.info>
- */
- class YamlLintCommand extends Command
- {
- protected function configure()
- {
- $this
- ->setName('lint:yaml')
- ->setAliases(array('yaml:lint'))
- ->setDescription('Lints a file and outputs encountered errors')
- ->addArgument('filename', null, 'A file or a directory or STDIN')
- ->addOption('format', null, InputOption::VALUE_REQUIRED, 'The output format', 'txt')
- ->setHelp(<<<'EOF'
- The <info>%command.name%</info> command lints a YAML file and outputs to STDOUT
- the first encountered syntax error.
- You can 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>
- Or all YAML files in a bundle:
- <info>php %command.full_name% @AcmeDemoBundle</info>
- You can also pass the YAML contents from STDIN:
- <info>cat filename | php %command.full_name%</info>
- EOF
- )
- ;
- }
- protected function execute(InputInterface $input, OutputInterface $output)
- {
- $io = new SymfonyStyle($input, $output);
- if (false !== strpos($input->getFirstArgument(), ':l')) {
- $io->caution('The use of "yaml:lint" command is deprecated since version 2.7 and will be removed in 3.0. Use the "lint:yaml" instead.');
- }
- $filename = $input->getArgument('filename');
- if (!$filename) {
- if (0 !== ftell(STDIN)) {
- throw new \RuntimeException('Please provide a filename or pipe file content to STDIN.');
- }
- $content = '';
- while (!feof(STDIN)) {
- $content .= fread(STDIN, 1024);
- }
- return $this->display($input, $output, $io, array($this->validate($content)));
- }
- if (0 !== strpos($filename, '@') && !is_readable($filename)) {
- throw new \RuntimeException(sprintf('File or directory "%s" is not readable', $filename));
- }
- if (is_file($filename)) {
- $files = array($filename);
- } elseif (is_dir($filename)) {
- $files = Finder::create()->files()->in($filename)->name('*.yml');
- } else {
- $dir = $this->getApplication()->getKernel()->locateResource($filename);
- $files = Finder::create()->files()->in($dir)->name('*.yml');
- }
- $filesInfo = array();
- foreach ($files as $file) {
- $filesInfo[] = $this->validate(file_get_contents($file), $file);
- }
- return $this->display($input, $output, $io, $filesInfo);
- }
- private function validate($content, $file = null)
- {
- $parser = new Parser();
- try {
- $parser->parse($content);
- } catch (ParseException $e) {
- return array('file' => $file, 'valid' => false, 'message' => $e->getMessage());
- }
- return array('file' => $file, 'valid' => true);
- }
- private function display(InputInterface $input, OutputInterface $output, SymfonyStyle $io, $files)
- {
- switch ($input->getOption('format')) {
- case 'txt':
- return $this->displayTxt($output, $io, $files);
- case 'json':
- return $this->displayJson($io, $files);
- default:
- throw new \InvalidArgumentException(sprintf('The format "%s" is not supported.', $input->getOption('format')));
- }
- }
- private function displayTxt(OutputInterface $output, SymfonyStyle $io, $filesInfo)
- {
- $errors = 0;
- foreach ($filesInfo as $info) {
- if ($info['valid'] && $output->isVerbose()) {
- $io->comment('<info>OK</info>'.($info['file'] ? sprintf(' in %s', $info['file']) : ''));
- } elseif (!$info['valid']) {
- ++$errors;
- $io->text(sprintf('<error> ERROR </error> in %s', $info['file']));
- $io->text(sprintf('<error> >> %s</error>', $info['message']));
- }
- }
- if (0 === $errors) {
- $io->success(sprintf('All %d YAML files contain valid syntax.', \count($filesInfo)));
- } else {
- $io->warning(sprintf('%d YAML files have valid syntax and %d contain errors.', \count($filesInfo) - $errors, $errors));
- }
- return min($errors, 1);
- }
- private function displayJson(OutputInterface $output, $filesInfo)
- {
- $errors = 0;
- array_walk($filesInfo, function (&$v) use (&$errors) {
- $v['file'] = (string) $v['file'];
- if (!$v['valid']) {
- ++$errors;
- }
- });
- $output->writeln(json_encode($filesInfo, \defined('JSON_PRETTY_PRINT') ? JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES : 0));
- return min($errors, 1);
- }
- }
|