Add Symfony Console command to inspect templates

[drjayvee]

TwigQI's full power is unleashed by analyzing all project templates in a git pre-commit hook, or as part of a CI build.

Let's add a ready-to-use console command for Symfony users, or at the very least, document how this can easily be achieved.

[axel37]

This would be very useful indeed.
In our project, we use several CLI tools (locally and in a Gitlab pipeline) to analyse php code. TwigQI looks interesting and I'd love to try it out in a similar fashion.

I've seen you mention a script that might help me get started while this feature is in the works ?

[drjayvee]

The idea is to initialize a Twig\Environment, compile all templates and collect any errors.

Here's a rough sketch of what we use.

require_once 'vendor/autoload.php';

use AlisQI\TwigQI\Extension as TwigQI;
use AlisQI\TwigQI\Logger\TriggerErrorLogger;

$twig = new Twig\Environment(/* use your app configuration */);
$twig->addExtension(new TwigQI(new TriggerErrorLogger()));

$errors = $deprecations = [];
set_error_handler(static function(int $code, string $error) use ($errors) {
  if (in_array($code, [E_DEPRECATED, E_USER_DEPRECATED])) {
    $deprecations[] = $error;
  } else {
    $errors[] = [];
  }
}

$twigTemplateIterator = new RegexIterator(
  new RecursiveIteratorIterator(new RecursiveDirectoryIterator('.', FilesystemIterator::SKIP_DOTS)),
  '/.*\.twig/'
);
$fileCount = $errorCount = 0;
foreach ($twigTemplateIterator as $file) {
  echo ".";
  try {
    $twig->load($file);
  } catch (Exception $e) {
    error_log("$file failed!\n{$e->getMessage()}");
    $errorCount += 1;
    continue;
  }
  $fileCount += 1;
}

$errorCount += count($errors);
$deprecationsCount = count($deprecations);

echo "\n\e[0;32m>>\e[0m compiled $fileCount templates.\n";
echo "Found $errorCount errors:\n" . implode("\n", $errors) . "\n";
echo "Found $deprecationsCount deprecations:\n" . implode("\n", $deprecations) . "\n";

if ($errorCount > 0) {
  exit(1);
}

[drjayvee]

Axel, you brought up an interesting point in #6, namely custom logging for CI platforms like Gitlab, GitHub, TeamCity, etc.

Thanks to #2, that shouldn't be too hard to achieve.