bug #62764 [Console] Escape % in description of console commands (SiebeVE)

nicolas-grekas · nicolas-grekas · commit 0dd7d937a96a · 2025-12-13T13:24:45.000+01:00
This PR was merged into the 7.3 branch. Discussion ---------- [Console] Escape `%` in description of console commands | Q | A | ------------- | --- | Branch? | 7.3 | Bug fix? | yes | New feature? | no  | Deprecations? | no  | Issues | Fix #62763 | License | MIT Commits ------- 91d0e4c bug #62763 [Console] Escape the description passed to the lazy command so the container can be build without wanting to replace the %not-a-param% to parameters
diff --git a/src/Symfony/Component/Console/DependencyInjection/AddConsoleCommandPass.php b/src/Symfony/Component/Console/DependencyInjection/AddConsoleCommandPass.php
@@ -135,10 +135,11 @@ public function process(ContainerBuilder $container): void
             }
 
             if ($description) {
-                $definition->addMethodCall('setDescription', [str_replace('%', '%%', $description)]);
+                $escapedDescription = str_replace('%', '%%', $description);
+                $definition->addMethodCall('setDescription', [$escapedDescription]);
 
                 $container->register('.'.$id.'.lazy', LazyCommand::class)
-                    ->setArguments([$commandName, $aliases, $description, $isHidden, new ServiceClosureArgument($lazyCommandRefs[$id])]);
+                    ->setArguments([$commandName, $aliases, $escapedDescription, $isHidden, new ServiceClosureArgument($lazyCommandRefs[$id])]);
 
                 $lazyCommandRefs[$id] = new Reference('.'.$id.'.lazy');
             }
diff --git a/src/Symfony/Component/Console/Tests/DependencyInjection/AddConsoleCommandPassTest.php b/src/Symfony/Component/Console/Tests/DependencyInjection/AddConsoleCommandPassTest.php
@@ -327,6 +327,25 @@ public function testProcessInvokableCommand()
         self::assertSame('The %command.name% command help content.', $command->getHelp());
     }
 
+    public function testProcessCommandWithDescriptionWithpercentageSigns()
+    {
+        $container = new ContainerBuilder();
+        $container
+            ->register(
+                'description_with_percentage_signs_command',
+                DescriptionWithPercentageSignsCommand::class,
+            )
+            ->addTag('console.command')
+        ;
+        $pass = new AddConsoleCommandPass();
+        $pass->process($container);
+
+        $command = $container->get('console.command_loader')->get('description-percentage-signs');
+
+        self::assertTrue($container->has('description_with_percentage_signs_command.command'));
+        self::assertSame('Just testing %percentage-signs%', $command->getDescription());
+    }
+
     public function testProcessInvokableSignalableCommand()
     {
         $container = new ContainerBuilder();
@@ -384,6 +403,14 @@ public function __invoke(): void
     }
 }
 
+#[AsCommand(name: 'description-percentage-signs', description: 'Just testing %percentage-signs%')]
+class DescriptionWithPercentageSignsCommand
+{
+    public function __invoke(): void
+    {
+    }
+}
+
 #[AsCommand(name: 'invokable-signalable', description: 'Just testing', help: 'The %command.name% help content.')]
 class InvokableSignalableCommand implements SignalableCommandInterface
 {

Original file line number	Diff line number	Diff line change
`@@ -135,10 +135,11 @@ public function process(ContainerBuilder $container): void`
`135`	`135`	`}`
`136`	`136`
`137`	`137`	`if ($description) {`
`138`		`- $definition->addMethodCall('setDescription', [str_replace('%', '%%', $description)]);`
	`138`	`+ $escapedDescription = str_replace('%', '%%', $description);`
	`139`	`+ $definition->addMethodCall('setDescription', [$escapedDescription]);`
`139`	`140`
`140`	`141`	`$container->register('.'.$id.'.lazy', LazyCommand::class)`
`141`		`- ->setArguments([$commandName, $aliases, $description, $isHidden, new ServiceClosureArgument($lazyCommandRefs[$id])]);`
	`142`	`+ ->setArguments([$commandName, $aliases, $escapedDescription, $isHidden, new ServiceClosureArgument($lazyCommandRefs[$id])]);`
`142`	`143`
`143`	`144`	`$lazyCommandRefs[$id] = new Reference('.'.$id.'.lazy');`
`144`	`145`	`}`