[Console][VarDumper] Ignore href for PhpStorm terminal emulator

Author: ogizanagi

Formatter/OutputFormatterStyle.php

@@ -54,6 +54,7 @@ class OutputFormatterStyle implements OutputFormatterStyleInterface
     private $background;
     private $href;
     private $options = array();
+    private $handlesHrefGracefully;
 
     /**
      * Initializes output formatter style.
@@ -185,6 +186,10 @@ public function apply($text)
         $setCodes = array();
         $unsetCodes = array();
 
+        if (null === $this->handlesHrefGracefully) {
+            $this->handlesHrefGracefully = 'JetBrains-JediTerm' !== getenv('TERMINAL_EMULATOR');
+        }
+
         if (null !== $this->foreground) {
             $setCodes[] = $this->foreground['set'];
             $unsetCodes[] = $this->foreground['unset'];
@@ -199,7 +204,7 @@ public function apply($text)
             $unsetCodes[] = $option['unset'];
         }
 
-        if (null !== $this->href) {
+        if (null !== $this->href && $this->handlesHrefGracefully) {
             $text = "\033]8;;$this->href\033\\$text\033]8;;\033\\";
         }
 

Tests/Formatter/OutputFormatterStyleTest.php

@@ -97,4 +97,19 @@ public function testOptions()
             $this->assertContains('Invalid option specified: "foo"', $e->getMessage(), '->unsetOption() throws an \InvalidArgumentException when the option does not exist in the available options');
         }
     }
+
+    public function testHref()
+    {
+        $prevTerminalEmulator = getenv('TERMINAL_EMULATOR');
+        putenv('TERMINAL_EMULATOR');
+
+        $style = new OutputFormatterStyle();
+
+        try {
+            $style->setHref('idea://open/?file=/path/SomeFile.php&line=12');
+            $this->assertSame("\e]8;;idea://open/?file=/path/SomeFile.php&line=12\e\\some URL\e]8;;\e\\", $style->apply('some URL'));
+        } finally {
+            putenv('TERMINAL_EMULATOR'.($prevTerminalEmulator ? "=$prevTerminalEmulator" : ''));
+        }
+    }
 }

Tests/Formatter/OutputFormatterTest.php

@@ -241,10 +241,17 @@ public function testFormatterHasStyles()
     /**
      * @dataProvider provideDecoratedAndNonDecoratedOutput
      */
-    public function testNotDecoratedFormatter(string $input, string $expectedNonDecoratedOutput, string $expectedDecoratedOutput)
+    public function testNotDecoratedFormatter(string $input, string $expectedNonDecoratedOutput, string $expectedDecoratedOutput, string $terminalEmulator = 'foo')
     {
-        $this->assertEquals($expectedDecoratedOutput, (new OutputFormatter(true))->format($input));
-        $this->assertEquals($expectedNonDecoratedOutput, (new OutputFormatter(false))->format($input));
+        $prevTerminalEmulator = getenv('TERMINAL_EMULATOR');
+        putenv('TERMINAL_EMULATOR='.$terminalEmulator);
+
+        try {
+            $this->assertEquals($expectedDecoratedOutput, (new OutputFormatter(true))->format($input));
+            $this->assertEquals($expectedNonDecoratedOutput, (new OutputFormatter(false))->format($input));
+        } finally {
+            putenv('TERMINAL_EMULATOR'.($prevTerminalEmulator ? "=$prevTerminalEmulator" : ''));
+        }
     }
 
     public function provideDecoratedAndNonDecoratedOutput()
@@ -256,6 +263,7 @@ public function provideDecoratedAndNonDecoratedOutput()
             array('<question>some question</question>', 'some question', "\033[30;46msome question\033[39;49m"),
             array('<fg=red>some text with inline style</>', 'some text with inline style', "\033[31msome text with inline style\033[39m"),
             array('<href=idea://open/?file=/path/SomeFile.php&line=12>some URL</>', 'some URL', "\033]8;;idea://open/?file=/path/SomeFile.php&line=12\033\\some URL\033]8;;\033\\"),
+            array('<href=idea://open/?file=/path/SomeFile.php&line=12>some URL</>', 'some URL', 'some URL', 'JetBrains-JediTerm'),
         );
     }