feature #30827 [TwigBridge] Add template file link to debug:twig command (yceruto)

fabpot · fabpot · commit aa5b6f95b9b6 · 2019-04-02T09:00:23.000+02:00
This PR was merged into the 4.3-dev branch. Discussion ---------- [TwigBridge] Add template file link to debug:twig command | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | - | License | MIT ![debug_twig_file_link](https://user-images.githubusercontent.com/2028198/55365428-8c85c680-54b2-11e9-9d4e-e4845fc7d411.png) Commits ------- 05e2e1e Add template file link
diff --git a/src/Symfony/Bridge/Twig/Command/DebugCommand.php b/src/Symfony/Bridge/Twig/Command/DebugCommand.php
@@ -19,6 +19,7 @@
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Style\SymfonyStyle;
 use Symfony\Component\Finder\Finder;
+use Symfony\Component\HttpKernel\Debug\FileLinkFormatter;
 use Twig\Environment;
 use Twig\Loader\ChainLoader;
 use Twig\Loader\FilesystemLoader;
@@ -38,8 +39,9 @@ class DebugCommand extends Command
     private $twigDefaultPath;
     private $rootDir;
     private $filesystemLoaders;
+    private $fileLinkFormatter;
 
-    public function __construct(Environment $twig, string $projectDir = null, array $bundlesMetadata = [], string $twigDefaultPath = null, string $rootDir = null)
+    public function __construct(Environment $twig, string $projectDir = null, array $bundlesMetadata = [], string $twigDefaultPath = null, string $rootDir = null, FileLinkFormatter $fileLinkFormatter = null)
     {
         parent::__construct();
 
@@ -48,6 +50,7 @@ public function __construct(Environment $twig, string $projectDir = null, array
         $this->bundlesMetadata = $bundlesMetadata;
         $this->twigDefaultPath = $twigDefaultPath;
         $this->rootDir = $rootDir;
+        $this->fileLinkFormatter = $fileLinkFormatter;
     }
 
     protected function configure()
@@ -105,16 +108,28 @@ protected function execute(InputInterface $input, OutputInterface $output)
 
     private function displayPathsText(SymfonyStyle $io, string $name)
     {
-        $files = $this->findTemplateFiles($name);
+        $file = new \ArrayIterator($this->findTemplateFiles($name));
         $paths = $this->getLoaderPaths($name);
 
         $io->section('Matched File');
-        if ($files) {
-            $io->success(array_shift($files));
+        if ($file->valid()) {
+            if ($fileLink = $this->getFileLink($file->key())) {
+                $io->block($file->current(), 'OK', sprintf('fg=black;bg=green;href=%s', $fileLink), ' ', true);
+            } else {
+                $io->success($file->current());
+            }
+            $file->next();
 
-            if ($files) {
+            if ($file->valid()) {
                 $io->section('Overridden Files');
-                $io->listing($files);
+                do {
+                    if ($fileLink = $this->getFileLink($file->key())) {
+                        $io->text(sprintf('* <href=%s>%s</>', $fileLink, $file->current()));
+                    } else {
+                        $io->text(sprintf('* %s', $file->current()));
+                    }
+                    $file->next();
+                } while ($file->valid());
             }
         } else {
             $alternatives = [];
@@ -453,9 +468,9 @@ private function findTemplateFiles(string $name): array
 
                 if (is_file($filename)) {
                     if (false !== $realpath = realpath($filename)) {
-                        $files[] = $this->getRelativePath($realpath);
+                        $files[$realpath] = $this->getRelativePath($realpath);
                     } else {
-                        $files[] = $this->getRelativePath($filename);
+                        $files[$filename] = $this->getRelativePath($filename);
                     }
                 }
             }
@@ -563,4 +578,13 @@ private function getFilesystemLoaders(): array
 
         return $this->filesystemLoaders;
     }
+
+    private function getFileLink(string $absolutePath): string
+    {
+        if (null === $this->fileLinkFormatter) {
+            return '';
+        }
+
+        return (string) $this->fileLinkFormatter->format($absolutePath, 1);
+    }
 }
diff --git a/src/Symfony/Bundle/TwigBundle/Resources/config/console.xml b/src/Symfony/Bundle/TwigBundle/Resources/config/console.xml
@@ -13,6 +13,7 @@
             <argument>%kernel.bundles_metadata%</argument>
             <argument>%twig.default_path%</argument>
             <argument>%kernel.root_dir%</argument>
+            <argument type="service" id="debug.file_link_formatter" on-invalid="null" />
             <tag name="console.command" command="debug:twig" />
         </service>
 
