minor #36798 Secrets, Security, and Messenger commands descriptions should not end with a "." (dot) (carlosbuenosvinos)

fabpot · fabpot · commit a73523b06522 · 2020-05-12T22:48:08.000+02:00
This PR was squashed before being merged into the 5.1-dev branch. Discussion ---------- Secrets, Security, and Messenger commands descriptions should not end with a "." (dot) | Q | A | ------------- | --- | Branch? | 4.4 (to be switched while merging) | Bug fix? | no | New feature? | no | Deprecations? | no | Tickets | N/A | License | MIT | Doc PR | N/A When running `bin/console` almost all the command descriptions do not end with a ".". So in order to be consistent, we should remove it from the Secrets Commands. **Current Output for Secrets Commands (with dots)** ![image](https://user-images.githubusercontent.com/351553/81734096-4a8bca00-9493-11ea-8d5c-bb1dda20bcb0.png) **Other Command Descriptions (without dots)** ![image](https://user-images.githubusercontent.com/351553/81734428-c84fd580-9493-11ea-8312-05557c7e6f0b.png) ![image](https://user-images.githubusercontent.com/351553/81734489-def62c80-9493-11ea-8d2b-1eb3668291cc.png) **Symfony CLI output (without dots)** ![image](https://user-images.githubusercontent.com/351553/81734720-3eecd300-9494-11ea-805e-2a3ae3178e8c.png) Commits ------- 4f76339 Secrets, Security, and Messenger commands descriptions should not end with a "." (dot)
diff --git a/src/Symfony/Bundle/FrameworkBundle/Command/SecretsDecryptToLocalCommand.php b/src/Symfony/Bundle/FrameworkBundle/Command/SecretsDecryptToLocalCommand.php
@@ -42,7 +42,7 @@ public function __construct(AbstractVault $vault, AbstractVault $localVault = nu
     protected function configure()
     {
         $this
-            ->setDescription('Decrypts all secrets and stores them in the local vault.')
+            ->setDescription('Decrypts all secrets and stores them in the local vault')
             ->addOption('force', 'f', InputOption::VALUE_NONE, 'Forces overriding of secrets that already exist in the local vault')
             ->setHelp(<<<'EOF'
 The <info>%command.name%</info> command decrypts all secrets and copies them in the local vault.
diff --git a/src/Symfony/Bundle/FrameworkBundle/Command/SecretsEncryptFromLocalCommand.php b/src/Symfony/Bundle/FrameworkBundle/Command/SecretsEncryptFromLocalCommand.php
@@ -41,7 +41,7 @@ public function __construct(AbstractVault $vault, AbstractVault $localVault = nu
     protected function configure()
     {
         $this
-            ->setDescription('Encrypts all local secrets to the vault.')
+            ->setDescription('Encrypts all local secrets to the vault')
             ->setHelp(<<<'EOF'
 The <info>%command.name%</info> command encrypts all locally overridden secrets to the vault.
 
diff --git a/src/Symfony/Bundle/FrameworkBundle/Command/SecretsGenerateKeysCommand.php b/src/Symfony/Bundle/FrameworkBundle/Command/SecretsGenerateKeysCommand.php
@@ -44,7 +44,7 @@ public function __construct(AbstractVault $vault, AbstractVault $localVault = nu
     protected function configure()
     {
         $this
-            ->setDescription('Generates new encryption keys.')
+            ->setDescription('Generates new encryption keys')
             ->addOption('local', 'l', InputOption::VALUE_NONE, 'Updates the local vault.')
             ->addOption('rotate', 'r', InputOption::VALUE_NONE, 'Re-encrypts existing secrets with the newly generated keys.')
             ->setHelp(<<<'EOF'
diff --git a/src/Symfony/Bundle/FrameworkBundle/Command/SecretsListCommand.php b/src/Symfony/Bundle/FrameworkBundle/Command/SecretsListCommand.php
@@ -45,7 +45,7 @@ public function __construct(AbstractVault $vault, AbstractVault $localVault = nu
     protected function configure()
     {
         $this
-            ->setDescription('Lists all secrets.')
+            ->setDescription('Lists all secrets')
             ->addOption('reveal', 'r', InputOption::VALUE_NONE, 'Display decrypted values alongside names')
             ->setHelp(<<<'EOF'
 The <info>%command.name%</info> command list all stored secrets.
diff --git a/src/Symfony/Bundle/FrameworkBundle/Command/SecretsRemoveCommand.php b/src/Symfony/Bundle/FrameworkBundle/Command/SecretsRemoveCommand.php
@@ -44,7 +44,7 @@ public function __construct(AbstractVault $vault, AbstractVault $localVault = nu
     protected function configure()
     {
         $this
-            ->setDescription('Removes a secret from the vault.')
+            ->setDescription('Removes a secret from the vault')
             ->addArgument('name', InputArgument::REQUIRED, 'The name of the secret')
             ->addOption('local', 'l', InputOption::VALUE_NONE, 'Updates the local vault.')
             ->setHelp(<<<'EOF'
diff --git a/src/Symfony/Bundle/FrameworkBundle/Command/SecretsSetCommand.php b/src/Symfony/Bundle/FrameworkBundle/Command/SecretsSetCommand.php
@@ -45,7 +45,7 @@ public function __construct(AbstractVault $vault, AbstractVault $localVault = nu
     protected function configure()
     {
         $this
-            ->setDescription('Sets a secret in the vault.')
+            ->setDescription('Sets a secret in the vault')
             ->addArgument('name', InputArgument::REQUIRED, 'The name of the secret')
             ->addArgument('file', InputArgument::OPTIONAL, 'A file where to read the secret from or "-" for reading from STDIN')
             ->addOption('local', 'l', InputOption::VALUE_NONE, 'Updates the local vault.')
diff --git a/src/Symfony/Bundle/SecurityBundle/Command/UserPasswordEncoderCommand.php b/src/Symfony/Bundle/SecurityBundle/Command/UserPasswordEncoderCommand.php
@@ -52,7 +52,7 @@ public function __construct(EncoderFactoryInterface $encoderFactory, array $user
     protected function configure()
     {
         $this
-            ->setDescription('Encodes a password.')
+            ->setDescription('Encodes a password')
             ->addArgument('password', InputArgument::OPTIONAL, 'The plain password to encode.')
             ->addArgument('user-class', InputArgument::OPTIONAL, 'The User entity class path associated with the encoder used to encode the password.')
             ->addOption('empty-salt', null, InputOption::VALUE_NONE, 'Do not generate a salt or let the encoder generate one.')
diff --git a/src/Symfony/Component/Messenger/Command/FailedMessagesRemoveCommand.php b/src/Symfony/Component/Messenger/Command/FailedMessagesRemoveCommand.php
@@ -39,7 +39,7 @@ protected function configure(): void
                 new InputOption('force', null, InputOption::VALUE_NONE, 'Force the operation without confirmation'),
                 new InputOption('show-messages', null, InputOption::VALUE_NONE, 'Display messages before removing it (if multiple ids are given)'),
             ])
-            ->setDescription('Remove given messages from the failure transport.')
+            ->setDescription('Remove given messages from the failure transport')
             ->setHelp(<<<'EOF'
 The <info>%command.name%</info> removes given messages that are pending in the failure transport.
 
diff --git a/src/Symfony/Component/Messenger/Command/FailedMessagesRetryCommand.php b/src/Symfony/Component/Messenger/Command/FailedMessagesRetryCommand.php
@@ -59,7 +59,7 @@ protected function configure(): void
                 new InputArgument('id', InputArgument::IS_ARRAY, 'Specific message id(s) to retry'),
                 new InputOption('force', null, InputOption::VALUE_NONE, 'Force action without confirmation'),
             ])
-            ->setDescription('Retries one or more messages from the failure transport.')
+            ->setDescription('Retries one or more messages from the failure transport')
             ->setHelp(<<<'EOF'
 The <info>%command.name%</info> retries message in the failure transport.
 
diff --git a/src/Symfony/Component/Messenger/Command/FailedMessagesShowCommand.php b/src/Symfony/Component/Messenger/Command/FailedMessagesShowCommand.php
@@ -37,7 +37,7 @@ protected function configure(): void
                 new InputArgument('id', InputArgument::OPTIONAL, 'Specific message id to show'),
                 new InputOption('max', null, InputOption::VALUE_REQUIRED, 'Maximum number of messages to list', 50),
             ])
-            ->setDescription('Shows one or more messages from the failure transport.')
+            ->setDescription('Shows one or more messages from the failure transport')
             ->setHelp(<<<'EOF'
 The <info>%command.name%</info> shows message that are pending in the failure transport.
 

Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,7 @@ public function __construct(AbstractVault $vault, AbstractVault $localVault = nu`
`42`	`42`	`protected function configure()`
`43`	`43`	`{`
`44`	`44`	`$this`
`45`		`- ->setDescription('Decrypts all secrets and stores them in the local vault.')`
	`45`	`+ ->setDescription('Decrypts all secrets and stores them in the local vault')`
`46`	`46`	`->addOption('force', 'f', InputOption::VALUE_NONE, 'Forces overriding of secrets that already exist in the local vault')`
`47`	`47`	`->setHelp(<<<'EOF'`
`48`	`48`	`The <info>%command.name%</info> command decrypts all secrets and copies them in the local vault.`
Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ public function __construct(AbstractVault $vault, AbstractVault $localVault = nu`
`41`	`41`	`protected function configure()`
`42`	`42`	`{`
`43`	`43`	`$this`
`44`		`- ->setDescription('Encrypts all local secrets to the vault.')`
	`44`	`+ ->setDescription('Encrypts all local secrets to the vault')`
`45`	`45`	`->setHelp(<<<'EOF'`
`46`	`46`	`The <info>%command.name%</info> command encrypts all locally overridden secrets to the vault.`
`47`	`47`
Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,7 @@ public function __construct(AbstractVault $vault, AbstractVault $localVault = nu`
`44`	`44`	`protected function configure()`
`45`	`45`	`{`
`46`	`46`	`$this`
`47`		`- ->setDescription('Generates new encryption keys.')`
	`47`	`+ ->setDescription('Generates new encryption keys')`
`48`	`48`	`->addOption('local', 'l', InputOption::VALUE_NONE, 'Updates the local vault.')`
`49`	`49`	`->addOption('rotate', 'r', InputOption::VALUE_NONE, 'Re-encrypts existing secrets with the newly generated keys.')`
`50`	`50`	`->setHelp(<<<'EOF'`
Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@ public function __construct(AbstractVault $vault, AbstractVault $localVault = nu`
`45`	`45`	`protected function configure()`
`46`	`46`	`{`
`47`	`47`	`$this`
`48`		`- ->setDescription('Lists all secrets.')`
	`48`	`+ ->setDescription('Lists all secrets')`
`49`	`49`	`->addOption('reveal', 'r', InputOption::VALUE_NONE, 'Display decrypted values alongside names')`
`50`	`50`	`->setHelp(<<<'EOF'`
`51`	`51`	`The <info>%command.name%</info> command list all stored secrets.`
Original file line number	Diff line number	Diff line change
`@@ -52,7 +52,7 @@ public function __construct(EncoderFactoryInterface $encoderFactory, array $user`
`52`	`52`	`protected function configure()`
`53`	`53`	`{`
`54`	`54`	`$this`
`55`		`- ->setDescription('Encodes a password.')`
	`55`	`+ ->setDescription('Encodes a password')`
`56`	`56`	`->addArgument('password', InputArgument::OPTIONAL, 'The plain password to encode.')`
`57`	`57`	`->addArgument('user-class', InputArgument::OPTIONAL, 'The User entity class path associated with the encoder used to encode the password.')`
`58`	`58`	`->addOption('empty-salt', null, InputOption::VALUE_NONE, 'Do not generate a salt or let the encoder generate one.')`