feature #48457 [FrameworkBundle] Improve UX ConfigDebugCommand has not yaml component (alamirault)

chalasr · chalasr · commit 6bf414cb7901 · 2022-12-18T15:20:41.000+01:00
This PR was squashed before being merged into the 6.3 branch. Discussion ---------- [FrameworkBundle] Improve UX ConfigDebugCommand has not yaml component | Q | A | ------------- | --- | Branch? | 6.3 | Bug fix? | no | New feature? | yes  | Deprecations? | no  | Tickets | Fix #48429 | License | MIT | Doc PR | symfony/symfony-docs#...  Throw exception in order to improve UX when Yaml component is missing Message is inspired by https://github.com/symfony/symfony/blob/043257f6fc1fceb28bc0c37c59f2bea4d9c8d79d/src/Symfony/Component/Serializer/Encoder/YamlEncoder.php#L56 Commits ------- b20fce5 [FrameworkBundle] Improve UX ConfigDebugCommand has not yaml component
diff --git a/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md b/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md
@@ -6,6 +6,7 @@ CHANGELOG
 
  * Add `DomCrawlerAssertionsTrait::assertSelectorCount(int $count, string $selector)`
  * Allow to avoid `limit` definition in a RateLimiter configuration when using the `no_limit` policy
+ * Add `--format` option to the `debug:config` command
 
 6.2
 ---
diff --git a/src/Symfony/Bundle/FrameworkBundle/Command/ConfigDebugCommand.php b/src/Symfony/Bundle/FrameworkBundle/Command/ConfigDebugCommand.php
@@ -16,6 +16,7 @@
 use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Completion\CompletionInput;
 use Symfony\Component\Console\Completion\CompletionSuggestions;
+use Symfony\Component\Console\Exception\InvalidArgumentException;
 use Symfony\Component\Console\Exception\LogicException;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
@@ -40,13 +41,17 @@ class ConfigDebugCommand extends AbstractConfigCommand
 {
     protected function configure()
     {
+        $commentedHelpFormats = array_map(static fn (string $format): string => sprintf('<comment>%s</comment>', $format), $this->getAvailableFormatOptions());
+        $helpFormats = implode('", "', $commentedHelpFormats);
+
         $this
             ->setDefinition([
                 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, sprintf('The output format ("%s")', implode('", "', $this->getAvailableFormatOptions())), class_exists(Yaml::class) ? 'yaml' : 'json'),
             ])
-            ->setHelp(<<<'EOF'
+            ->setHelp(<<<EOF
 The <info>%command.name%</info> command dumps the current configuration for an
 extension/bundle.
 
@@ -55,6 +60,11 @@ protected function configure()
   <info>php %command.full_name% framework</info>
   <info>php %command.full_name% FrameworkBundle</info>
 
+The <info>--format</info> option specifies the format of the configuration,
+this is either "{$helpFormats}".
+
+  <info>php %command.full_name% framework --format=json</info>
+
 For dumping a specific option, add its path as second argument:
 
   <info>php %command.full_name% framework serializer.enabled</info>
@@ -92,12 +102,20 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
         $config = $this->getConfig($extension, $container, $input->getOption('resolve-env'));
 
+        $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.');
+
+            return 1;
+        }
+
         if (null === $path = $input->getArgument('path')) {
             $io->title(
                 sprintf('Current configuration for %s', $name === $extensionAlias ? sprintf('extension with alias "%s"', $extensionAlias) : sprintf('"%s"', $name))
             );
 
-            $io->writeln(Yaml::dump([$extensionAlias => $config], 10));
+            $io->writeln($this->convertToFormat([$extensionAlias => $config], $format));
 
             return 0;
         }
@@ -112,11 +130,20 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
         $io->title(sprintf('Current configuration for "%s.%s"', $extensionAlias, $path));
 
-        $io->writeln(Yaml::dump($config, 10));
+        $io->writeln($this->convertToFormat($config, $format));
 
         return 0;
     }
 
+    private function convertToFormat(mixed $config, string $format): string
+    {
+        return match ($format) {
+            'yaml' => Yaml::dump($config, 10),
+            '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()))),
+        };
+    }
+
     private function compileContainer(): ContainerBuilder
     {
         $kernel = clone $this->getApplication()->getKernel();
@@ -194,6 +221,10 @@ public function complete(CompletionInput $input, CompletionSuggestions $suggesti
             } catch (LogicException) {
             }
         }
+
+        if ($input->mustSuggestOptionValuesFor('format')) {
+            $suggestions->suggestValues($this->getAvailableFormatOptions());
+        }
     }
 
     private function getAvailableBundles(bool $alias): array
@@ -228,4 +259,9 @@ private static function buildPathsCompletion(array $paths, string $prefix = ''):
 
         return $completionPaths;
     }
+
+    private function getAvailableFormatOptions(): array
+    {
+        return ['yaml', 'json'];
+    }
 }
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;
@@ -50,6 +51,19 @@ public function testDumpBundleOption()
         $this->assertStringContainsString('foo', $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();
@@ -157,6 +171,8 @@ public function provideCompletionSuggestions(): \Generator
         yield 'name (started CamelCase)' => [['Fra'], ['DefaultConfigTestBundle', 'ExtensionWithoutConfigTestBundle', 'FrameworkBundle', 'TestBundle']];
 
         yield 'name with existing path' => [['framework', ''], ['secret', 'router.resource', 'router.utf8', 'router.enabled', 'validation.enabled', 'default_locale']];
+
+        yield 'option --format' => [['--format', ''], ['yaml', 'json']];
     }
 
     private function createCommandTester(): CommandTester
