Refactor command help text definitions for Symfony Console compatibility (#645)

Spomky · web-flow · commit e0bb9a583d48 · 2025-11-17T21:53:22.000+01:00
diff --git a/Console/AddKeyIntoKeysetCommand.php b/Console/AddKeyIntoKeysetCommand.php
@@ -16,16 +16,15 @@
 use function is_array;
 use function is_string;
 
-#[AsCommand(name: 'keyset:add:key', description: 'Add a key into a key set.', help: <<<'TXT'
-This command adds a key at the end of a key set.
-TXT)]
+#[AsCommand(name: 'keyset:add:key', description: 'Add a key into a key set.')]
 final class AddKeyIntoKeysetCommand extends ObjectOutputCommand
 {
     #[Override]
     protected function configure(): void
     {
         parent::configure();
         $this
+            ->setHelp('This command adds a key at the end of a key set.')
             ->addArgument('jwkset', InputArgument::REQUIRED, 'The JWKSet object')
             ->addArgument('jwk', InputArgument::REQUIRED, 'The new JWK object');
     }
diff --git a/Console/JKULoaderCommand.php b/Console/JKULoaderCommand.php
@@ -13,9 +13,7 @@
 use Symfony\Component\Console\Output\OutputInterface;
 use function is_string;
 
-#[AsCommand(name: 'keyset:load:jku', description: 'Loads a key set from an url.', help: <<<'TXT'
-This command will try to get a key set from an URL. The distant key set is a JWKSet.
-TXT)]
+#[AsCommand(name: 'keyset:load:jku', description: 'Loads a key set from an url.')]
 final class JKULoaderCommand extends ObjectOutputCommand
 {
     public function __construct(
@@ -30,6 +28,7 @@ protected function configure(): void
     {
         parent::configure();
         $this
+            ->setHelp('This command will try to get a key set from an URL. The distant key set is a JWKSet.')
             ->addArgument('url', InputArgument::REQUIRED, 'The URL');
     }
 
diff --git a/Console/KeyAnalyzerCommand.php b/Console/KeyAnalyzerCommand.php
@@ -18,9 +18,7 @@
 use function is_array;
 use function is_string;
 
-#[AsCommand(name: 'key:analyze', description: 'JWK quality analyzer.', help: <<<'TXT'
-This command will analyze a JWK object and find security issues.
-TXT)]
+#[AsCommand(name: 'key:analyze', description: 'JWK quality analyzer.')]
 final class KeyAnalyzerCommand extends Command
 {
     public function __construct(
@@ -35,6 +33,7 @@ protected function configure(): void
     {
         parent::configure();
         $this
+            ->setHelp('This command will analyze a JWK object and find security issues.')
             ->addArgument('jwk', InputArgument::REQUIRED, 'The JWK object');
     }
 
diff --git a/Console/KeysetAnalyzerCommand.php b/Console/KeysetAnalyzerCommand.php
@@ -21,9 +21,7 @@
 use function is_string;
 use function sprintf;
 
-#[AsCommand(name: 'keyset:analyze', description: 'JWKSet quality analyzer.', help: <<<'TXT'
-This command will analyze a JWKSet object and find security issues.
-TXT)]
+#[AsCommand(name: 'keyset:analyze', description: 'JWKSet quality analyzer.')]
 final class KeysetAnalyzerCommand extends Command
 {
     public function __construct(
@@ -39,6 +37,7 @@ protected function configure(): void
     {
         parent::configure();
         $this
+            ->setHelp('This command will analyze a JWKSet object and find security issues.')
             ->addArgument('jwkset', InputArgument::REQUIRED, 'The JWKSet object');
     }
 
diff --git a/Console/MergeKeysetCommand.php b/Console/MergeKeysetCommand.php
@@ -14,16 +14,17 @@
 use Symfony\Component\Console\Output\OutputInterface;
 use function is_array;
 
-#[AsCommand(name: 'keyset:merge', description: 'Merge several key sets into one.', help: <<<'TXT'
-This command merges several key sets into one. It is very useful when you generate e.g. RSA, EC and OKP keys and you want only one key set to rule them all.
-TXT)]
+#[AsCommand(name: 'keyset:merge', description: 'Merge several key sets into one.')]
 final class MergeKeysetCommand extends ObjectOutputCommand
 {
     #[Override]
     protected function configure(): void
     {
         parent::configure();
         $this
+            ->setHelp(
+                'This command merges several key sets into one. It is very useful when you generate e.g. RSA, EC and OKP keys and you want only one key set to rule them all.'
+            )
             ->addArgument('jwksets', InputArgument::REQUIRED | InputArgument::IS_ARRAY, 'The JWKSet objects');
     }
 
diff --git a/Console/PublicKeyCommand.php b/Console/PublicKeyCommand.php
@@ -18,9 +18,6 @@
 #[AsCommand(
     name: 'key:convert:public',
     description: 'Convert a private key into public key. Symmetric keys (shared keys) are not changed.',
-    help: <<<'TXT'
-This command converts a private key into a public key.
-TXT
 )]
 final class PublicKeyCommand extends ObjectOutputCommand
 {
@@ -29,6 +26,7 @@ protected function configure(): void
     {
         parent::configure();
         $this
+            ->setHelp('This command converts a private key into a public key.')
             ->addArgument('jwk', InputArgument::REQUIRED, 'The JWK object');
     }
 
diff --git a/Console/PublicKeysetCommand.php b/Console/PublicKeysetCommand.php
@@ -18,9 +18,6 @@
 #[AsCommand(
     name: 'keyset:convert:public',
     description: 'Convert private keys in a key set into public keys. Symmetric keys (shared keys) are not changed.',
-    help: <<<'TXT'
-This command converts private keys in a key set into public keys.
-TXT
 )]
 final class PublicKeysetCommand extends ObjectOutputCommand
 {
@@ -29,6 +26,7 @@ protected function configure(): void
     {
         parent::configure();
         $this
+            ->setHelp('This command converts private keys in a key set into public keys.')
             ->addArgument('jwkset', InputArgument::REQUIRED, 'The JWKSet object');
     }
 
diff --git a/Console/RotateKeysetCommand.php b/Console/RotateKeysetCommand.php
@@ -17,16 +17,15 @@
 use function is_array;
 use function is_string;
 
-#[AsCommand(name: 'keyset:rotate', description: 'Rotate a key set.', help: <<<'TXT'
-This command removes the last key in a key set a place a new one at the beginning.
-TXT)]
+#[AsCommand(name: 'keyset:rotate', description: 'Rotate a key set.')]
 final class RotateKeysetCommand extends ObjectOutputCommand
 {
     #[Override]
     protected function configure(): void
     {
         parent::configure();
         $this
+            ->setHelp('This command removes the last key in a key set a place a new one at the beginning.')
             ->addArgument('jwkset', InputArgument::REQUIRED, 'The JWKSet object')
             ->addArgument('jwk', InputArgument::REQUIRED, 'The new JWK object');
     }
diff --git a/Console/X5ULoaderCommand.php b/Console/X5ULoaderCommand.php
@@ -13,9 +13,7 @@
 use Symfony\Component\Console\Output\OutputInterface;
 use function is_string;
 
-#[AsCommand(name: 'keyset:load:x5u', description: 'Loads a key set from an url.', help: <<<'TXT'
-This command will try to get a key set from an URL. The distant key set is list of X.509 certificates.
-TXT)]
+#[AsCommand(name: 'keyset:load:x5u', description: 'Loads a key set from an url.')]
 final class X5ULoaderCommand extends ObjectOutputCommand
 {
     public function __construct(
@@ -30,6 +28,9 @@ protected function configure(): void
     {
         parent::configure();
         $this
+            ->setHelp(
+                'This command will try to get a key set from an URL. The distant key set is list of X.509 certificates.'
+            )
             ->addArgument('url', InputArgument::REQUIRED, 'The URL');
     }
 

Original file line number	Diff line number	Diff line change
`@@ -16,16 +16,15 @@`
`16`	`16`	`use function is_array;`
`17`	`17`	`use function is_string;`
`18`	`18`
`19`		`-#[AsCommand(name: 'keyset:add:key', description: 'Add a key into a key set.', help: <<<'TXT'`
`20`		`-This command adds a key at the end of a key set.`
`21`		`-TXT)]`
	`19`	`+#[AsCommand(name: 'keyset:add:key', description: 'Add a key into a key set.')]`
`22`	`20`	`final class AddKeyIntoKeysetCommand extends ObjectOutputCommand`
`23`	`21`	`{`
`24`	`22`	`#[Override]`
`25`	`23`	`protected function configure(): void`
`26`	`24`	`{`
`27`	`25`	`parent::configure();`
`28`	`26`	`$this`
	`27`	`+ ->setHelp('This command adds a key at the end of a key set.')`
`29`	`28`	`->addArgument('jwkset', InputArgument::REQUIRED, 'The JWKSet object')`
`30`	`29`	`->addArgument('jwk', InputArgument::REQUIRED, 'The new JWK object');`
`31`	`30`	`}`
Original file line number	Diff line number	Diff line change
`@@ -13,9 +13,7 @@`
`13`	`13`	`use Symfony\Component\Console\Output\OutputInterface;`
`14`	`14`	`use function is_string;`
`15`	`15`
`16`		`-#[AsCommand(name: 'keyset:load:jku', description: 'Loads a key set from an url.', help: <<<'TXT'`
`17`		`-This command will try to get a key set from an URL. The distant key set is a JWKSet.`
`18`		`-TXT)]`
	`16`	`+#[AsCommand(name: 'keyset:load:jku', description: 'Loads a key set from an url.')]`
`19`	`17`	`final class JKULoaderCommand extends ObjectOutputCommand`
`20`	`18`	`{`
`21`	`19`	`public function __construct(`
`@@ -30,6 +28,7 @@ protected function configure(): void`
`30`	`28`	`{`
`31`	`29`	`parent::configure();`
`32`	`30`	`$this`
	`31`	`+ ->setHelp('This command will try to get a key set from an URL. The distant key set is a JWKSet.')`
`33`	`32`	`->addArgument('url', InputArgument::REQUIRED, 'The URL');`
`34`	`33`	`}`
`35`	`34`
Original file line number	Diff line number	Diff line change
`@@ -18,9 +18,7 @@`
`18`	`18`	`use function is_array;`
`19`	`19`	`use function is_string;`
`20`	`20`
`21`		`-#[AsCommand(name: 'key:analyze', description: 'JWK quality analyzer.', help: <<<'TXT'`
`22`		`-This command will analyze a JWK object and find security issues.`
`23`		`-TXT)]`
	`21`	`+#[AsCommand(name: 'key:analyze', description: 'JWK quality analyzer.')]`
`24`	`22`	`final class KeyAnalyzerCommand extends Command`
`25`	`23`	`{`
`26`	`24`	`public function __construct(`
`@@ -35,6 +33,7 @@ protected function configure(): void`
`35`	`33`	`{`
`36`	`34`	`parent::configure();`
`37`	`35`	`$this`
	`36`	`+ ->setHelp('This command will analyze a JWK object and find security issues.')`
`38`	`37`	`->addArgument('jwk', InputArgument::REQUIRED, 'The JWK object');`
`39`	`38`	`}`
`40`	`39`
Original file line number	Diff line number	Diff line change
`@@ -21,9 +21,7 @@`
`21`	`21`	`use function is_string;`
`22`	`22`	`use function sprintf;`
`23`	`23`
`24`		`-#[AsCommand(name: 'keyset:analyze', description: 'JWKSet quality analyzer.', help: <<<'TXT'`
`25`		`-This command will analyze a JWKSet object and find security issues.`
`26`		`-TXT)]`
	`24`	`+#[AsCommand(name: 'keyset:analyze', description: 'JWKSet quality analyzer.')]`
`27`	`25`	`final class KeysetAnalyzerCommand extends Command`
`28`	`26`	`{`
`29`	`27`	`public function __construct(`
`@@ -39,6 +37,7 @@ protected function configure(): void`
`39`	`37`	`{`
`40`	`38`	`parent::configure();`
`41`	`39`	`$this`
	`40`	`+ ->setHelp('This command will analyze a JWKSet object and find security issues.')`
`42`	`41`	`->addArgument('jwkset', InputArgument::REQUIRED, 'The JWKSet object');`
`43`	`42`	`}`
`44`	`43`
Original file line number	Diff line number	Diff line change
`@@ -14,16 +14,17 @@`
`14`	`14`	`use Symfony\Component\Console\Output\OutputInterface;`
`15`	`15`	`use function is_array;`
`16`	`16`
`17`		`-#[AsCommand(name: 'keyset:merge', description: 'Merge several key sets into one.', help: <<<'TXT'`
`18`		`-This command merges several key sets into one. It is very useful when you generate e.g. RSA, EC and OKP keys and you want only one key set to rule them all.`
`19`		`-TXT)]`
	`17`	`+#[AsCommand(name: 'keyset:merge', description: 'Merge several key sets into one.')]`
`20`	`18`	`final class MergeKeysetCommand extends ObjectOutputCommand`
`21`	`19`	`{`
`22`	`20`	`#[Override]`
`23`	`21`	`protected function configure(): void`
`24`	`22`	`{`
`25`	`23`	`parent::configure();`
`26`	`24`	`$this`
	`25`	`+ ->setHelp(`
	`26`	`+ 'This command merges several key sets into one. It is very useful when you generate e.g. RSA, EC and OKP keys and you want only one key set to rule them all.'`
	`27`	`+ )`
`27`	`28`	`->addArgument('jwksets', InputArgument::REQUIRED \| InputArgument::IS_ARRAY, 'The JWKSet objects');`
`28`	`29`	`}`
`29`	`30`
Original file line number	Diff line number	Diff line change
`@@ -18,9 +18,6 @@`
`18`	`18`	`#[AsCommand(`
`19`	`19`	`name: 'key:convert:public',`
`20`	`20`	`description: 'Convert a private key into public key. Symmetric keys (shared keys) are not changed.',`
`21`		`- help: <<<'TXT'`
`22`		`-This command converts a private key into a public key.`
`23`		`-TXT`
`24`	`21`	`)]`
`25`	`22`	`final class PublicKeyCommand extends ObjectOutputCommand`
`26`	`23`	`{`
`@@ -29,6 +26,7 @@ protected function configure(): void`
`29`	`26`	`{`
`30`	`27`	`parent::configure();`
`31`	`28`	`$this`
	`29`	`+ ->setHelp('This command converts a private key into a public key.')`
`32`	`30`	`->addArgument('jwk', InputArgument::REQUIRED, 'The JWK object');`
`33`	`31`	`}`
`34`	`32`
Original file line number	Diff line number	Diff line change
`@@ -17,16 +17,15 @@`
`17`	`17`	`use function is_array;`
`18`	`18`	`use function is_string;`
`19`	`19`
`20`		`-#[AsCommand(name: 'keyset:rotate', description: 'Rotate a key set.', help: <<<'TXT'`
`21`		`-This command removes the last key in a key set a place a new one at the beginning.`
`22`		`-TXT)]`
	`20`	`+#[AsCommand(name: 'keyset:rotate', description: 'Rotate a key set.')]`
`23`	`21`	`final class RotateKeysetCommand extends ObjectOutputCommand`
`24`	`22`	`{`
`25`	`23`	`#[Override]`
`26`	`24`	`protected function configure(): void`
`27`	`25`	`{`
`28`	`26`	`parent::configure();`
`29`	`27`	`$this`
	`28`	`+ ->setHelp('This command removes the last key in a key set a place a new one at the beginning.')`
`30`	`29`	`->addArgument('jwkset', InputArgument::REQUIRED, 'The JWKSet object')`
`31`	`30`	`->addArgument('jwk', InputArgument::REQUIRED, 'The new JWK object');`
`32`	`31`	`}`