Skip to content

Adds a linter command for templates #3804

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 8, 2012
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG-2.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,7 @@ To get the diff between two versions, go to https://github.com/symfony/symfony/c
### TwigBundle

* added the real template name when an error occurs in a Twig template
* added the twig:lint command that will validate a Twig template syntax.

### WebProfilerBundle

Expand Down
107 changes: 107 additions & 0 deletions src/Symfony/Bundle/TwigBundle/Command/LintCommand.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
<?php

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

missing license header

/*
* 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\TwigBundle\Command;

use Symfony\Bundle\FrameworkBundle\Command\ContainerAwareCommand;
use Symfony\Component\Console\Input\InputInterface;
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 <marc.weistroff@sensiolabs.com>
*/
class LintCommand extends ContainerAwareCommand
{
protected function configure()
{
$this
->setName('twig:lint')
->setDescription('Lints a template and outputs eventual errors.')
->addArgument('filename')
->setHelp(<<<EOF
the <info>%command.name%</info> command lints a template and outputs to stdout
the first encountered syntax error.

<info>php %command.full_name% filename</info>

The command will get the contents of "filename" and will validates its syntax.

<info>php %command.full_name% dirname</info>

The command will find all twig templates in dirname and will validate the syntax
of each Twig template.

<info>php %command.full_name% @AcmeMyBundle</info>

The command will find all twig templates in bundle AcmeMyBundle and will validate
the syntax of each one.

<info>cat filename | php %command.full_name%</info>

The command will get the template contents from stdin and will validates its syntax.

This command will return these error codes:
- 1 if template is invalid
- 2 if file doesn't exists or stdin is empty.
EOF
)
;
}

protected function execute(InputInterface $input, OutputInterface $output)
{
$twig = $this->getContainer()->get('twig');
$template = null;
$filename = $input->getArgument('filename');

if (!$filename) {
if (0 !== ftell(STDIN)) {
throw new \RuntimeException("Please provide a filename or pipe template content to stdin.");
}

while (!feof(STDIN)) {
$template .= fread(STDIN, 1024);
}

return $twig->parse($twig->tokenize($template));
}

if (0 !== strpos($filename, '@') && !is_readable($filename)) {
throw new \RuntimeException("File or directory '%s' is not readable");
}

$files = array();
if (is_file($filename)) {
$files = array($filename);
} elseif (is_dir($filename)) {
$files = Finder::create()->files()->in($filename)->name('*.twig');
} else {
$dir = $this->getApplication()->getKernel()->locateResource($filename);
$files = Finder::create()->files()->in($dir)->name('*.twig');
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

} else {
    if (!is_dir($filename)) {
        $filename = $this->getApplication()->getKernel()->locateResource($filename);
    }

    $files = Finder::create()->files()->in($filename)->name('*.twig');
}


foreach ($files as $file) {
try {
$twig->parse($twig->tokenize(file_get_contents($file)));
} catch (\Exception $e) {
$output->writeln(sprintf('<error>Syntax error in %s</error>', $file));

throw $e;
}
}

$output->writeln('<info>No syntax error detected.</info>');
}
}