Fix CR issues

alamirault · alamirault · commit df13bd94813a · 2022-12-06T20:44:45.000+01:00
diff --git a/src/Symfony/Bundle/FrameworkBundle/Command/ConfigDebugCommand.php b/src/Symfony/Bundle/FrameworkBundle/Command/ConfigDebugCommand.php
@@ -46,7 +46,7 @@ protected function configure()
                 new InputArgument('name', InputArgument::OPTIONAL, 'The bundle name or the extension alias'),
                 new InputArgument('path', InputArgument::OPTIONAL, 'The configuration option path'),
                 new InputOption('resolve-env', null, InputOption::VALUE_NONE, 'Display resolved environment variable values instead of placeholders'),
-                new InputOption('format', null, InputOption::VALUE_REQUIRED, 'The output format (yaml or json)', 'yaml'),
+                new InputOption('format', null, InputOption::VALUE_REQUIRED, sprintf('The output format ("%s")', implode('", "', $this->getAvailableFormatOptions())), class_exists(Yaml::class) ? 'yaml' : 'json'),
             ])
             ->setHelp(<<<'EOF'
 The <info>%command.name%</info> command dumps the current configuration for an
@@ -57,9 +57,8 @@ protected function configure()
   <info>php %command.full_name% framework</info>
   <info>php %command.full_name% FrameworkBundle</info>
 
-With the <info>--format</info> option specifies the format of the configuration,
+The <info>--format</info> option specifies the format of the configuration,
 this is either <comment>yaml</comment> or <comment>json</comment>.
-When the option is not provided, <comment>yaml</comment> is used.
 
   <info>php %command.full_name% FrameworkBundle --format=json</info>
 
@@ -102,7 +101,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         $format = $input->getOption('format');
 
         if ('yaml' === $format && !class_exists(Yaml::class)) {
-            $errorIo->error('Setting the "format" option to "yaml" requires the Symfony Yaml component. Try running "composer install symfony/yaml" or use "--format=json" instead.');
+            $errorIo->error('The "yaml" format requires the installation of the Yaml component. Install it with "composer require symfony/yaml", or choose another format by specifying "--format=json".');
 
             return 1;
         }
@@ -142,8 +141,8 @@ private function convertToFormat(mixed $config, string $format): string
     {
         return match ($format) {
             'yaml' => Yaml::dump($config, 10),
-            'json' => json_encode($config, \JSON_PRETTY_PRINT),
-            default => throw new InvalidArgumentException('Only the yaml and json formats are supported.'),
+            'json' => json_encode($config, \JSON_PRETTY_PRINT|\JSON_UNESCAPED_SLASHES|\JSON_UNESCAPED_UNICODE),
+            default => throw new InvalidArgumentException(sprintf('Supported formats are "%s".', implode('", "', $this->getAvailableFormatOptions()))),
         };
     }
 
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/ConfigDebugCommandTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/ConfigDebugCommandTest.php
@@ -13,6 +13,7 @@
 
 use Symfony\Bundle\FrameworkBundle\Command\ConfigDebugCommand;
 use Symfony\Bundle\FrameworkBundle\Console\Application;
+use Symfony\Component\Console\Exception\InvalidArgumentException;
 use Symfony\Component\Console\Input\ArrayInput;
 use Symfony\Component\Console\Output\NullOutput;
 use Symfony\Component\Console\Tester\CommandCompletionTester;
@@ -55,14 +56,27 @@ public function testDumpAtPathWithFormat()
         $tester = $this->createCommandTester();
         $ret = $tester->execute([
             'name' => 'test',
-            'path' => 'array',
+            'path' => 'custom',
             '--format' => 'json',
         ]);
 
         $this->assertSame(1, $ret);
         $this->assertStringContainsString('[ERROR] The "path" option is only available for the "yaml" format.', $tester->getDisplay());
     }
 
+    public function testDumpWithUnsupportedFormat()
+    {
+        $tester = $this->createCommandTester();
+
+        $this->expectException(InvalidArgumentException::class);
+        $this->expectExceptionMessage('Supported formats are "yaml", "json"');
+
+        $tester->execute([
+            'name' => 'test',
+            '--format' => 'xml',
+        ]);
+    }
+
     public function testParametersValuesAreResolved()
     {
         $tester = $this->createCommandTester();
