63a626e4c8
* 2.8: CS fixes Remove trailing space CS: apply rules [Yaml] Clean some messages + add test case [Console] simplified code [Form] Fix UrlType transforms valid protocols [SecurityBundle] Changed encoder configuration example to bcrypt
165 lines
5.2 KiB
PHP
165 lines
5.2 KiB
PHP
<?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')
|
|
->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);
|
|
$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 ($errors === 0) {
|
|
$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, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES));
|
|
|
|
return min($errors, 1);
|
|
}
|
|
}
|