[VarDumper] Fix configuring CliDumper with SYMFONY_IDE env var

nicolas-grekas · nicolas-grekas · commit 2248a8c94f7c · 2024-02-08T15:35:45.000+01:00
diff --git a/src/Symfony/Component/ErrorHandler/ErrorRenderer/FileLinkFormatter.php b/src/Symfony/Component/ErrorHandler/ErrorRenderer/FileLinkFormatter.php
@@ -30,7 +30,7 @@ class FileLinkFormatter
     private \Closure|string|null $urlFormat;
 
     /**
-     * @param string|\Closure $urlFormat the URL format, or a closure that returns it on-demand
+     * @param string|\Closure $urlFormat The URL format, or a closure that returns it on-demand
      */
     public function __construct(string|array|null $fileLinkFormat = null, ?RequestStack $requestStack = null, ?string $baseDir = null, string|\Closure|null $urlFormat = null)
     {
diff --git a/src/Symfony/Component/VarDumper/Dumper/CliDumper.php b/src/Symfony/Component/VarDumper/Dumper/CliDumper.php
@@ -11,6 +11,7 @@
 
 namespace Symfony\Component\VarDumper\Dumper;
 
+use Symfony\Component\ErrorHandler\ErrorRenderer\FileLinkFormatter;
 use Symfony\Component\VarDumper\Cloner\Cursor;
 use Symfony\Component\VarDumper\Cloner\Stub;
 
@@ -82,7 +83,7 @@ public function __construct($output = null, ?string $charset = null, int $flags
             ]);
         }
 
-        $this->displayOptions['fileLinkFormat'] = \ini_get('xdebug.file_link_format') ?: get_cfg_var('xdebug.file_link_format') ?: 'file://%f#L%l';
+        $this->displayOptions['fileLinkFormat'] = class_exists(FileLinkFormatter::class) ? new FileLinkFormatter() : (\ini_get('xdebug.file_link_format') ?: get_cfg_var('xdebug.file_link_format') ?: 'file://%f#L%l');
     }
 
     /**
diff --git a/src/Symfony/Component/VarDumper/Tests/Dumper/CliDumperTest.php b/src/Symfony/Component/VarDumper/Tests/Dumper/CliDumperTest.php
@@ -12,6 +12,7 @@
 namespace Symfony\Component\VarDumper\Tests\Dumper;
 
 use PHPUnit\Framework\TestCase;
+use Symfony\Component\VarDumper\Caster\ClassStub;
 use Symfony\Component\VarDumper\Caster\CutStub;
 use Symfony\Component\VarDumper\Cloner\Data;
 use Symfony\Component\VarDumper\Cloner\Stub;
@@ -499,4 +500,26 @@ public function testCollapse()
             $dump
         );
     }
+
+    public function testFileLinkFormat()
+    {
+        $data = new Data([
+            [
+                new ClassStub(self::class),
+            ],
+        ]);
+
+        $ide = getenv('SYMFONY_IDE');
+        putenv('SYMFONY_IDE=vscode');
+
+        try {
+            $dumper = new CliDumper();
+            $dumper->setColors(true);
+            $dump = $dumper->dump($data, true);
+
+            $this->assertStringMatchesFormat('%svscode://file/%s/CliDumperTest.php:%sCliDumperTest%s', $dump);
+        } finally {
+            putenv('SYMFONY_IDE'.($ide ? '='.$ide : ''));
+        }
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ class FileLinkFormatter`
`30`	`30`	`private \Closure\|string\|null $urlFormat;`
`31`	`31`
`32`	`32`	`/**`
`33`		`- * @param string\|\Closure $urlFormat the URL format, or a closure that returns it on-demand`
	`33`	`+ * @param string\|\Closure $urlFormat The URL format, or a closure that returns it on-demand`
`34`	`34`	`*/`
`35`	`35`	`public function __construct(string\|array\|null $fileLinkFormat = null, ?RequestStack $requestStack = null, ?string $baseDir = null, string\|\Closure\|null $urlFormat = null)`
`36`	`36`	`{`
Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,7 @@`
`11`	`11`
`12`	`12`	`namespace Symfony\Component\VarDumper\Dumper;`
`13`	`13`
	`14`	`+use Symfony\Component\ErrorHandler\ErrorRenderer\FileLinkFormatter;`
`14`	`15`	`use Symfony\Component\VarDumper\Cloner\Cursor;`
`15`	`16`	`use Symfony\Component\VarDumper\Cloner\Stub;`
`16`	`17`
`@@ -82,7 +83,7 @@ public function __construct($output = null, ?string $charset = null, int $flags`
`82`	`83`	`]);`
`83`	`84`	`}`
`84`	`85`
`85`		`- $this->displayOptions['fileLinkFormat'] = \ini_get('xdebug.file_link_format') ?: get_cfg_var('xdebug.file_link_format') ?: 'file://%f#L%l';`
	`86`	`+ $this->displayOptions['fileLinkFormat'] = class_exists(FileLinkFormatter::class) ? new FileLinkFormatter() : (\ini_get('xdebug.file_link_format') ?: get_cfg_var('xdebug.file_link_format') ?: 'file://%f#L%l');`
`86`	`87`	`}`
`87`	`88`
`88`	`89`	`/**`