Fix #36973: Command description consistency

danepowell · danepowell · commit 1d7c9a559074 · 2021-03-05T09:58:50.000-08:00
diff --git a/Command/AboutCommand.php b/Command/AboutCommand.php
@@ -37,7 +37,7 @@ class AboutCommand extends Command
     protected function configure()
     {
         $this
-            ->setDescription('Displays information about the current project')
+            ->setDescription('Display information about the current project')
             ->setHelp(<<<'EOT'
 The <info>%command.name%</info> command displays information about the current Symfony project.
 
diff --git a/Command/AssetsInstallCommand.php b/Command/AssetsInstallCommand.php
@@ -65,10 +65,10 @@ protected function configure()
             ->setDefinition([
                 new InputArgument('target', InputArgument::OPTIONAL, 'The target directory', null),
             ])
-            ->addOption('symlink', null, InputOption::VALUE_NONE, 'Symlinks the assets instead of copying it')
+            ->addOption('symlink', null, InputOption::VALUE_NONE, 'Symlink the assets instead of copying them')
             ->addOption('relative', null, InputOption::VALUE_NONE, 'Make relative symlinks')
             ->addOption('no-cleanup', null, InputOption::VALUE_NONE, 'Do not remove the assets of the bundles that no longer exist')
-            ->setDescription('Installs bundles web assets under a public directory')
+            ->setDescription('Install bundle\'s web assets under a public directory')
             ->setHelp(<<<'EOT'
 The <info>%command.name%</info> command installs bundle assets into a given
 directory (e.g. the <comment>public</comment> directory).
diff --git a/Command/CacheClearCommand.php b/Command/CacheClearCommand.php
@@ -57,7 +57,7 @@ protected function configure()
                 new InputOption('no-warmup', '', InputOption::VALUE_NONE, 'Do not warm up the cache'),
                 new InputOption('no-optional-warmers', '', InputOption::VALUE_NONE, 'Skip optional cache warmers (faster)'),
             ])
-            ->setDescription('Clears the cache')
+            ->setDescription('Clear the cache')
             ->setHelp(<<<'EOF'
 The <info>%command.name%</info> command clears the application cache for a given environment
 and debug mode:
diff --git a/Command/CachePoolClearCommand.php b/Command/CachePoolClearCommand.php
@@ -47,7 +47,7 @@ protected function configure()
             ->setDefinition([
                 new InputArgument('pools', InputArgument::IS_ARRAY | InputArgument::REQUIRED, 'A list of cache pools or cache pool clearers'),
             ])
-            ->setDescription('Clears cache pools')
+            ->setDescription('Clear cache pools')
             ->setHelp(<<<'EOF'
 The <info>%command.name%</info> command clears the given cache pools or cache pool clearers.
 
diff --git a/Command/CachePoolDeleteCommand.php b/Command/CachePoolDeleteCommand.php
@@ -46,7 +46,7 @@ protected function configure()
                 new InputArgument('pool', InputArgument::REQUIRED, 'The cache pool from which to delete an item'),
                 new InputArgument('key', InputArgument::REQUIRED, 'The cache key to delete from the pool'),
             ])
-            ->setDescription('Deletes an item from a cache pool')
+            ->setDescription('Delete an item from a cache pool')
             ->setHelp(<<<'EOF'
 The <info>%command.name%</info> deletes an item from a given cache pool.
 
diff --git a/Command/CachePoolPruneCommand.php b/Command/CachePoolPruneCommand.php
@@ -44,7 +44,7 @@ public function __construct(iterable $pools)
     protected function configure()
     {
         $this
-            ->setDescription('Prunes cache pools')
+            ->setDescription('Prune cache pools')
             ->setHelp(<<<'EOF'
 The <info>%command.name%</info> command deletes all expired items from all pruneable pools.
 
diff --git a/Command/CacheWarmupCommand.php b/Command/CacheWarmupCommand.php
@@ -47,7 +47,7 @@ protected function configure()
             ->setDefinition([
                 new InputOption('no-optional-warmers', '', InputOption::VALUE_NONE, 'Skip optional cache warmers (faster)'),
             ])
-            ->setDescription('Warms up an empty cache')
+            ->setDescription('Warm up an empty cache')
             ->setHelp(<<<'EOF'
 The <info>%command.name%</info> command warms up the cache.
 
diff --git a/Command/ConfigDebugCommand.php b/Command/ConfigDebugCommand.php
@@ -41,7 +41,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'),
             ])
-            ->setDescription('Dumps the current configuration for an extension')
+            ->setDescription('Dump the current configuration for an extension')
             ->setHelp(<<<'EOF'
 The <info>%command.name%</info> command dumps the current configuration for an
 extension/bundle.
diff --git a/Command/ConfigDumpReferenceCommand.php b/Command/ConfigDumpReferenceCommand.php
@@ -44,7 +44,7 @@ protected function configure()
                 new InputArgument('path', InputArgument::OPTIONAL, 'The configuration option path'),
                 new InputOption('format', null, InputOption::VALUE_REQUIRED, 'The output format (yaml or xml)', 'yaml'),
             ])
-            ->setDescription('Dumps the default configuration for an extension')
+            ->setDescription('Dump the default configuration for an extension')
             ->setHelp(<<<'EOF'
 The <info>%command.name%</info> command dumps the default configuration for an
 extension/bundle.
diff --git a/Command/ContainerDebugCommand.php b/Command/ContainerDebugCommand.php
@@ -51,20 +51,20 @@ protected function configure()
         $this
             ->setDefinition([
                 new InputArgument('name', InputArgument::OPTIONAL, 'A service name (foo)'),
-                new InputOption('show-private', null, InputOption::VALUE_NONE, 'Used to show public *and* private services (deprecated)'),
-                new InputOption('show-arguments', null, InputOption::VALUE_NONE, 'Used to show arguments in services'),
-                new InputOption('show-hidden', null, InputOption::VALUE_NONE, 'Used to show hidden (internal) services'),
-                new InputOption('tag', null, InputOption::VALUE_REQUIRED, 'Shows all services with a specific tag'),
-                new InputOption('tags', null, InputOption::VALUE_NONE, 'Displays tagged services for an application'),
-                new InputOption('parameter', null, InputOption::VALUE_REQUIRED, 'Displays a specific parameter for an application'),
-                new InputOption('parameters', null, InputOption::VALUE_NONE, 'Displays parameters for an application'),
-                new InputOption('types', null, InputOption::VALUE_NONE, 'Displays types (classes/interfaces) available in the container'),
-                new InputOption('env-var', null, InputOption::VALUE_REQUIRED, 'Displays a specific environment variable used in the container'),
-                new InputOption('env-vars', null, InputOption::VALUE_NONE, 'Displays environment variables used in the container'),
+                new InputOption('show-private', null, InputOption::VALUE_NONE, 'Show public *and* private services (deprecated)'),
+                new InputOption('show-arguments', null, InputOption::VALUE_NONE, 'Show arguments in services'),
+                new InputOption('show-hidden', null, InputOption::VALUE_NONE, 'Show hidden (internal) services'),
+                new InputOption('tag', null, InputOption::VALUE_REQUIRED, 'Show all services with a specific tag'),
+                new InputOption('tags', null, InputOption::VALUE_NONE, 'Display tagged services for an application'),
+                new InputOption('parameter', null, InputOption::VALUE_REQUIRED, 'Display a specific parameter for an application'),
+                new InputOption('parameters', null, InputOption::VALUE_NONE, 'Display parameters for an application'),
+                new InputOption('types', null, InputOption::VALUE_NONE, 'Display types (classes/interfaces) available in the container'),
+                new InputOption('env-var', null, InputOption::VALUE_REQUIRED, 'Display a specific environment variable used in the container'),
+                new InputOption('env-vars', null, InputOption::VALUE_NONE, 'Display environment variables used in the container'),
                 new InputOption('format', null, InputOption::VALUE_REQUIRED, 'The output format (txt, xml, json, or md)', 'txt'),
                 new InputOption('raw', null, InputOption::VALUE_NONE, 'To output raw description'),
             ])
-            ->setDescription('Displays current services for an application')
+            ->setDescription('Display current services for an application')
             ->setHelp(<<<'EOF'
 The <info>%command.name%</info> command displays all configured <comment>public</comment> services:
 
diff --git a/Command/ContainerLintCommand.php b/Command/ContainerLintCommand.php
@@ -41,7 +41,7 @@ final class ContainerLintCommand extends Command
     protected function configure()
     {
         $this
-            ->setDescription('Ensures that arguments injected into services match type declarations')
+            ->setDescription('Ensure that arguments injected into services match type declarations')
             ->setHelp('This command parses service definitions and ensures that injected values match the type declarations of each services\' class.')
         ;
     }
diff --git a/Command/DebugAutowiringCommand.php b/Command/DebugAutowiringCommand.php
@@ -50,7 +50,7 @@ protected function configure()
                 new InputArgument('search', InputArgument::OPTIONAL, 'A search filter'),
                 new InputOption('all', null, InputOption::VALUE_NONE, 'Show also services that are not aliased'),
             ])
-            ->setDescription('Lists classes/interfaces you can use for autowiring')
+            ->setDescription('List classes/interfaces you can use for autowiring')
             ->setHelp(<<<'EOF'
 The <info>%command.name%</info> command displays the classes and interfaces that
 you can use as type-hints for autowiring:
diff --git a/Command/EventDispatcherDebugCommand.php b/Command/EventDispatcherDebugCommand.php
@@ -50,7 +50,7 @@ protected function configure()
                 new InputOption('format', null, InputOption::VALUE_REQUIRED, 'The output format  (txt, xml, json, or md)', 'txt'),
                 new InputOption('raw', null, InputOption::VALUE_NONE, 'To output raw description'),
             ])
-            ->setDescription('Displays configured listeners for an application')
+            ->setDescription('Display configured listeners for an application')
             ->setHelp(<<<'EOF'
 The <info>%command.name%</info> command displays all configured listeners:
 
diff --git a/Command/RouterDebugCommand.php b/Command/RouterDebugCommand.php
@@ -57,7 +57,7 @@ protected function configure()
                 new InputOption('format', null, InputOption::VALUE_REQUIRED, 'The output format (txt, xml, json, or md)', 'txt'),
                 new InputOption('raw', null, InputOption::VALUE_NONE, 'To output raw route(s)'),
             ])
-            ->setDescription('Displays current routes for an application')
+            ->setDescription('Display current routes for an application')
             ->setHelp(<<<'EOF'
 The <info>%command.name%</info> displays the configured routes:
 
diff --git a/Command/RouterMatchCommand.php b/Command/RouterMatchCommand.php
@@ -49,11 +49,11 @@ protected function configure()
         $this
             ->setDefinition([
                 new InputArgument('path_info', InputArgument::REQUIRED, 'A path info'),
-                new InputOption('method', null, InputOption::VALUE_REQUIRED, 'Sets the HTTP method'),
-                new InputOption('scheme', null, InputOption::VALUE_REQUIRED, 'Sets the URI scheme (usually http or https)'),
-                new InputOption('host', null, InputOption::VALUE_REQUIRED, 'Sets the URI host'),
+                new InputOption('method', null, InputOption::VALUE_REQUIRED, 'Set the HTTP method'),
+                new InputOption('scheme', null, InputOption::VALUE_REQUIRED, 'Set the URI scheme (usually http or https)'),
+                new InputOption('host', null, InputOption::VALUE_REQUIRED, 'Set the URI host'),
             ])
-            ->setDescription('Helps debug routes by simulating a path info match')
+            ->setDescription('Help debug routes by simulating a path info match')
             ->setHelp(<<<'EOF'
 The <info>%command.name%</info> shows which routes match a given request and which don't and for what reason:
 
diff --git a/Command/SecretsDecryptToLocalCommand.php b/Command/SecretsDecryptToLocalCommand.php
@@ -42,8 +42,8 @@ public function __construct(AbstractVault $vault, AbstractVault $localVault = nu
     protected function configure()
     {
         $this
-            ->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')
+            ->setDescription('Decrypt all secrets and stores them in the local vault.')
+            ->addOption('force', 'f', InputOption::VALUE_NONE, 'Force 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/Command/SecretsEncryptFromLocalCommand.php b/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('Encrypt 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/Command/SecretsGenerateKeysCommand.php b/Command/SecretsGenerateKeysCommand.php
@@ -44,9 +44,9 @@ public function __construct(AbstractVault $vault, AbstractVault $localVault = nu
     protected function configure()
     {
         $this
-            ->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.')
+            ->setDescription('Generate new encryption keys.')
+            ->addOption('local', 'l', InputOption::VALUE_NONE, 'Update the local vault.')
+            ->addOption('rotate', 'r', InputOption::VALUE_NONE, 'Re-encrypt existing secrets with the newly generated keys.')
             ->setHelp(<<<'EOF'
 The <info>%command.name%</info> command generates a new encryption key.
 
diff --git a/Command/SecretsListCommand.php b/Command/SecretsListCommand.php
@@ -45,7 +45,7 @@ public function __construct(AbstractVault $vault, AbstractVault $localVault = nu
     protected function configure()
     {
         $this
-            ->setDescription('Lists all secrets.')
+            ->setDescription('List 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/Command/SecretsRemoveCommand.php b/Command/SecretsRemoveCommand.php
@@ -44,9 +44,9 @@ public function __construct(AbstractVault $vault, AbstractVault $localVault = nu
     protected function configure()
     {
         $this
-            ->setDescription('Removes a secret from the vault.')
+            ->setDescription('Remove a secret from the vault.')
             ->addArgument('name', InputArgument::REQUIRED, 'The name of the secret')
-            ->addOption('local', 'l', InputOption::VALUE_NONE, 'Updates the local vault.')
+            ->addOption('local', 'l', InputOption::VALUE_NONE, 'Update the local vault.')
             ->setHelp(<<<'EOF'
 The <info>%command.name%</info> command removes a secret from the vault.
 
diff --git a/Command/SecretsSetCommand.php b/Command/SecretsSetCommand.php
@@ -45,11 +45,11 @@ public function __construct(AbstractVault $vault, AbstractVault $localVault = nu
     protected function configure()
     {
         $this
-            ->setDescription('Sets a secret in the vault.')
+            ->setDescription('Set 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.')
-            ->addOption('random', 'r', InputOption::VALUE_OPTIONAL, 'Generates a random value.', false)
+            ->addOption('local', 'l', InputOption::VALUE_NONE, 'Update the local vault.')
+            ->addOption('random', 'r', InputOption::VALUE_OPTIONAL, 'Generate a random value.', false)
             ->setHelp(<<<'EOF'
 The <info>%command.name%</info> command stores a secret in the vault.
 
diff --git a/Command/TranslationDebugCommand.php b/Command/TranslationDebugCommand.php
@@ -82,11 +82,11 @@ protected function configure()
                 new InputArgument('locale', InputArgument::REQUIRED, 'The locale'),
                 new InputArgument('bundle', InputArgument::OPTIONAL, 'The bundle name or directory where to load the messages'),
                 new InputOption('domain', null, InputOption::VALUE_OPTIONAL, 'The messages domain'),
-                new InputOption('only-missing', null, InputOption::VALUE_NONE, 'Displays only missing messages'),
-                new InputOption('only-unused', null, InputOption::VALUE_NONE, 'Displays only unused messages'),
+                new InputOption('only-missing', null, InputOption::VALUE_NONE, 'Display only missing messages'),
+                new InputOption('only-unused', null, InputOption::VALUE_NONE, 'Display only unused messages'),
                 new InputOption('all', null, InputOption::VALUE_NONE, 'Load messages from all registered bundles'),
             ])
-            ->setDescription('Displays translation messages information')
+            ->setDescription('Display translation messages information')
             ->setHelp(<<<'EOF'
 The <info>%command.name%</info> command helps finding unused or missing translation
 messages and comparing them with the fallback ones by inspecting the
diff --git a/Command/TranslationUpdateCommand.php b/Command/TranslationUpdateCommand.php
@@ -85,7 +85,7 @@ protected function configure()
                 new InputOption('xliff-version', null, InputOption::VALUE_OPTIONAL, 'Override the default xliff version', '1.2'),
                 new InputOption('sort', null, InputOption::VALUE_OPTIONAL, 'Return list of messages sorted alphabetically', 'asc'),
             ])
-            ->setDescription('Updates the translation file')
+            ->setDescription('Update the translation file')
             ->setHelp(<<<'EOF'
 The <info>%command.name%</info> command extracts translation strings from templates
 of a given bundle or the default translations directory. It can display them or merge
diff --git a/Command/WorkflowDumpCommand.php b/Command/WorkflowDumpCommand.php
@@ -40,7 +40,7 @@ protected function configure()
             ->setDefinition([
                 new InputArgument('name', InputArgument::REQUIRED, 'A workflow name'),
                 new InputArgument('marking', InputArgument::IS_ARRAY, 'A marking (a list of places)'),
-                new InputOption('label', 'l', InputOption::VALUE_REQUIRED, 'Labels a graph'),
+                new InputOption('label', 'l', InputOption::VALUE_REQUIRED, 'Label a graph'),
                 new InputOption('dump-format', null, InputOption::VALUE_REQUIRED, 'The dump format [dot|puml]', 'dot'),
             ])
             ->setDescription('Dump a workflow')

Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ class AboutCommand extends Command`
`37`	`37`	`protected function configure()`
`38`	`38`	`{`
`39`	`39`	`$this`
`40`		`- ->setDescription('Displays information about the current project')`
	`40`	`+ ->setDescription('Display information about the current project')`
`41`	`41`	`->setHelp(<<<'EOT'`
`42`	`42`	`The <info>%command.name%</info> command displays information about the current Symfony project.`
`43`	`43`
Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,7 @@ public function __construct(iterable $pools)`
`44`	`44`	`protected function configure()`
`45`	`45`	`{`
`46`	`46`	`$this`
`47`		`- ->setDescription('Prunes cache pools')`
	`47`	`+ ->setDescription('Prune cache pools')`
`48`	`48`	`->setHelp(<<<'EOF'`
`49`	`49`	`The <info>%command.name%</info> command deletes all expired items from all pruneable pools.`
`50`	`50`