Fix #36973: Command description consistency

This commit is contained in:
Dane Powell 2021-03-05 09:58:50 -08:00
parent 2536e178b1
commit 01e18b039a
No known key found for this signature in database
GPG Key ID: DC893801D122A571
45 changed files with 67 additions and 67 deletions

View File

@ -60,7 +60,7 @@ class ServerLogCommand extends Command
->addOption('format', null, InputOption::VALUE_REQUIRED, 'The line format', ConsoleFormatter::SIMPLE_FORMAT) ->addOption('format', null, InputOption::VALUE_REQUIRED, 'The line format', ConsoleFormatter::SIMPLE_FORMAT)
->addOption('date-format', null, InputOption::VALUE_REQUIRED, 'The date format', ConsoleFormatter::SIMPLE_DATE) ->addOption('date-format', null, InputOption::VALUE_REQUIRED, 'The date format', ConsoleFormatter::SIMPLE_DATE)
->addOption('filter', null, InputOption::VALUE_REQUIRED, 'An expression to filter log. Example: "level > 200 or channel in [\'app\', \'doctrine\']"') ->addOption('filter', null, InputOption::VALUE_REQUIRED, 'An expression to filter log. Example: "level > 200 or channel in [\'app\', \'doctrine\']"')
->setDescription('Starts a log server that displays logs in real time') ->setDescription('Start a log server that displays logs in real time')
->setHelp(<<<'EOF' ->setHelp(<<<'EOF'
<info>%command.name%</info> starts a log server to display in real time the log <info>%command.name%</info> starts a log server to display in real time the log
messages generated by your application: messages generated by your application:

View File

@ -74,7 +74,7 @@ class DebugCommand extends Command
new InputOption('filter', null, InputOption::VALUE_REQUIRED, 'Show details for all entries matching this filter'), new InputOption('filter', null, InputOption::VALUE_REQUIRED, 'Show details for all entries matching this filter'),
new InputOption('format', null, InputOption::VALUE_REQUIRED, 'The output format (text or json)', 'text'), new InputOption('format', null, InputOption::VALUE_REQUIRED, 'The output format (text or json)', 'text'),
]) ])
->setDescription('Shows a list of twig functions, filters, globals and tests') ->setDescription('Show a list of twig functions, filters, globals and tests')
->setHelp(<<<'EOF' ->setHelp(<<<'EOF'
The <info>%command.name%</info> command outputs a list of twig functions, The <info>%command.name%</info> command outputs a list of twig functions,
filters, globals and tests. filters, globals and tests.

View File

@ -48,7 +48,7 @@ class LintCommand extends Command
protected function configure() protected function configure()
{ {
$this $this
->setDescription('Lints a template and outputs encountered errors') ->setDescription('Lint a template and outputs encountered errors')
->addOption('format', null, InputOption::VALUE_REQUIRED, 'The output format', 'txt') ->addOption('format', null, InputOption::VALUE_REQUIRED, 'The output format', 'txt')
->addOption('show-deprecations', null, InputOption::VALUE_NONE, 'Show deprecations as errors') ->addOption('show-deprecations', null, InputOption::VALUE_NONE, 'Show deprecations as errors')
->addArgument('filename', InputArgument::IS_ARRAY, 'A file, a directory or "-" for reading from STDIN') ->addArgument('filename', InputArgument::IS_ARRAY, 'A file, a directory or "-" for reading from STDIN')

View File

@ -37,7 +37,7 @@ class AboutCommand extends Command
protected function configure() protected function configure()
{ {
$this $this
->setDescription('Displays information about the current project') ->setDescription('Display information about the current project')
->setHelp(<<<'EOT' ->setHelp(<<<'EOT'
The <info>%command.name%</info> command displays information about the current Symfony project. The <info>%command.name%</info> command displays information about the current Symfony project.

View File

@ -65,10 +65,10 @@ class AssetsInstallCommand extends Command
->setDefinition([ ->setDefinition([
new InputArgument('target', InputArgument::OPTIONAL, 'The target directory', null), 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('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') ->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' ->setHelp(<<<'EOT'
The <info>%command.name%</info> command installs bundle assets into a given The <info>%command.name%</info> command installs bundle assets into a given
directory (e.g. the <comment>public</comment> directory). directory (e.g. the <comment>public</comment> directory).

View File

@ -57,7 +57,7 @@ class CacheClearCommand extends Command
new InputOption('no-warmup', '', InputOption::VALUE_NONE, 'Do not warm up the cache'), 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)'), new InputOption('no-optional-warmers', '', InputOption::VALUE_NONE, 'Skip optional cache warmers (faster)'),
]) ])
->setDescription('Clears the cache') ->setDescription('Clear the cache')
->setHelp(<<<'EOF' ->setHelp(<<<'EOF'
The <info>%command.name%</info> command clears the application cache for a given environment The <info>%command.name%</info> command clears the application cache for a given environment
and debug mode: and debug mode:

View File

@ -47,7 +47,7 @@ final class CachePoolClearCommand extends Command
->setDefinition([ ->setDefinition([
new InputArgument('pools', InputArgument::IS_ARRAY | InputArgument::REQUIRED, 'A list of cache pools or cache pool clearers'), 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' ->setHelp(<<<'EOF'
The <info>%command.name%</info> command clears the given cache pools or cache pool clearers. The <info>%command.name%</info> command clears the given cache pools or cache pool clearers.

View File

@ -46,7 +46,7 @@ final class CachePoolDeleteCommand extends Command
new InputArgument('pool', InputArgument::REQUIRED, 'The cache pool from which to delete an item'), 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'), 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' ->setHelp(<<<'EOF'
The <info>%command.name%</info> deletes an item from a given cache pool. The <info>%command.name%</info> deletes an item from a given cache pool.

View File

@ -44,7 +44,7 @@ final class CachePoolPruneCommand extends Command
protected function configure() protected function configure()
{ {
$this $this
->setDescription('Prunes cache pools') ->setDescription('Prune cache pools')
->setHelp(<<<'EOF' ->setHelp(<<<'EOF'
The <info>%command.name%</info> command deletes all expired items from all pruneable pools. The <info>%command.name%</info> command deletes all expired items from all pruneable pools.

View File

@ -47,7 +47,7 @@ class CacheWarmupCommand extends Command
->setDefinition([ ->setDefinition([
new InputOption('no-optional-warmers', '', InputOption::VALUE_NONE, 'Skip optional cache warmers (faster)'), 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' ->setHelp(<<<'EOF'
The <info>%command.name%</info> command warms up the cache. The <info>%command.name%</info> command warms up the cache.

View File

@ -41,7 +41,7 @@ class ConfigDebugCommand extends AbstractConfigCommand
new InputArgument('name', InputArgument::OPTIONAL, 'The bundle name or the extension alias'), new InputArgument('name', InputArgument::OPTIONAL, 'The bundle name or the extension alias'),
new InputArgument('path', InputArgument::OPTIONAL, 'The configuration option path'), 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' ->setHelp(<<<'EOF'
The <info>%command.name%</info> command dumps the current configuration for an The <info>%command.name%</info> command dumps the current configuration for an
extension/bundle. extension/bundle.

View File

@ -44,7 +44,7 @@ class ConfigDumpReferenceCommand extends AbstractConfigCommand
new InputArgument('path', InputArgument::OPTIONAL, 'The configuration option path'), new InputArgument('path', InputArgument::OPTIONAL, 'The configuration option path'),
new InputOption('format', null, InputOption::VALUE_REQUIRED, 'The output format (yaml or xml)', 'yaml'), 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' ->setHelp(<<<'EOF'
The <info>%command.name%</info> command dumps the default configuration for an The <info>%command.name%</info> command dumps the default configuration for an
extension/bundle. extension/bundle.

View File

@ -51,20 +51,20 @@ class ContainerDebugCommand extends Command
$this $this
->setDefinition([ ->setDefinition([
new InputArgument('name', InputArgument::OPTIONAL, 'A service name (foo)'), 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-private', null, InputOption::VALUE_NONE, 'Show public *and* private services (deprecated)'),
new InputOption('show-arguments', null, InputOption::VALUE_NONE, 'Used to show arguments in services'), new InputOption('show-arguments', null, InputOption::VALUE_NONE, 'Show arguments in services'),
new InputOption('show-hidden', null, InputOption::VALUE_NONE, 'Used to show hidden (internal) services'), new InputOption('show-hidden', null, InputOption::VALUE_NONE, 'Show hidden (internal) services'),
new InputOption('tag', null, InputOption::VALUE_REQUIRED, 'Shows all services with a specific tag'), new InputOption('tag', null, InputOption::VALUE_REQUIRED, 'Show all services with a specific tag'),
new InputOption('tags', null, InputOption::VALUE_NONE, 'Displays tagged services for an application'), new InputOption('tags', null, InputOption::VALUE_NONE, 'Display tagged services for an application'),
new InputOption('parameter', null, InputOption::VALUE_REQUIRED, 'Displays a specific parameter for an application'), new InputOption('parameter', null, InputOption::VALUE_REQUIRED, 'Display a specific parameter for an application'),
new InputOption('parameters', null, InputOption::VALUE_NONE, 'Displays parameters for an application'), new InputOption('parameters', null, InputOption::VALUE_NONE, 'Display parameters for an application'),
new InputOption('types', null, InputOption::VALUE_NONE, 'Displays types (classes/interfaces) available in the container'), new InputOption('types', null, InputOption::VALUE_NONE, 'Display 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-var', null, InputOption::VALUE_REQUIRED, 'Display 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('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('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'), 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' ->setHelp(<<<'EOF'
The <info>%command.name%</info> command displays all configured <comment>public</comment> services: The <info>%command.name%</info> command displays all configured <comment>public</comment> services:

View File

@ -41,7 +41,7 @@ final class ContainerLintCommand extends Command
protected function configure() protected function configure()
{ {
$this $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.') ->setHelp('This command parses service definitions and ensures that injected values match the type declarations of each services\' class.')
; ;
} }

View File

@ -50,7 +50,7 @@ class DebugAutowiringCommand extends ContainerDebugCommand
new InputArgument('search', InputArgument::OPTIONAL, 'A search filter'), new InputArgument('search', InputArgument::OPTIONAL, 'A search filter'),
new InputOption('all', null, InputOption::VALUE_NONE, 'Show also services that are not aliased'), 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' ->setHelp(<<<'EOF'
The <info>%command.name%</info> command displays the classes and interfaces that The <info>%command.name%</info> command displays the classes and interfaces that
you can use as type-hints for autowiring: you can use as type-hints for autowiring:

View File

@ -50,7 +50,7 @@ class EventDispatcherDebugCommand extends Command
new InputOption('format', null, InputOption::VALUE_REQUIRED, 'The output format (txt, xml, json, or md)', 'txt'), 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'), 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' ->setHelp(<<<'EOF'
The <info>%command.name%</info> command displays all configured listeners: The <info>%command.name%</info> command displays all configured listeners:

View File

@ -57,7 +57,7 @@ class RouterDebugCommand extends Command
new InputOption('format', null, InputOption::VALUE_REQUIRED, 'The output format (txt, xml, json, or md)', 'txt'), 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)'), 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' ->setHelp(<<<'EOF'
The <info>%command.name%</info> displays the configured routes: The <info>%command.name%</info> displays the configured routes:

View File

@ -49,11 +49,11 @@ class RouterMatchCommand extends Command
$this $this
->setDefinition([ ->setDefinition([
new InputArgument('path_info', InputArgument::REQUIRED, 'A path info'), new InputArgument('path_info', InputArgument::REQUIRED, 'A path info'),
new InputOption('method', null, InputOption::VALUE_REQUIRED, 'Sets the HTTP method'), new InputOption('method', null, InputOption::VALUE_REQUIRED, 'Set the HTTP method'),
new InputOption('scheme', null, InputOption::VALUE_REQUIRED, 'Sets the URI scheme (usually http or https)'), new InputOption('scheme', null, InputOption::VALUE_REQUIRED, 'Set the URI scheme (usually http or https)'),
new InputOption('host', null, InputOption::VALUE_REQUIRED, 'Sets the URI host'), 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' ->setHelp(<<<'EOF'
The <info>%command.name%</info> shows which routes match a given request and which don't and for what reason: The <info>%command.name%</info> shows which routes match a given request and which don't and for what reason:

View File

@ -42,8 +42,8 @@ final class SecretsDecryptToLocalCommand extends Command
protected function configure() protected function configure()
{ {
$this $this
->setDescription('Decrypts all secrets and stores them in the local vault.') ->setDescription('Decrypt 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') ->addOption('force', 'f', InputOption::VALUE_NONE, 'Force overriding of secrets that already exist in the local vault')
->setHelp(<<<'EOF' ->setHelp(<<<'EOF'
The <info>%command.name%</info> command decrypts all secrets and copies them in the local vault. The <info>%command.name%</info> command decrypts all secrets and copies them in the local vault.

View File

@ -41,7 +41,7 @@ final class SecretsEncryptFromLocalCommand extends Command
protected function configure() protected function configure()
{ {
$this $this
->setDescription('Encrypts all local secrets to the vault.') ->setDescription('Encrypt all local secrets to the vault.')
->setHelp(<<<'EOF' ->setHelp(<<<'EOF'
The <info>%command.name%</info> command encrypts all locally overridden secrets to the vault. The <info>%command.name%</info> command encrypts all locally overridden secrets to the vault.

View File

@ -44,9 +44,9 @@ final class SecretsGenerateKeysCommand extends Command
protected function configure() protected function configure()
{ {
$this $this
->setDescription('Generates new encryption keys.') ->setDescription('Generate new encryption keys.')
->addOption('local', 'l', InputOption::VALUE_NONE, 'Updates the local vault.') ->addOption('local', 'l', InputOption::VALUE_NONE, 'Update the local vault.')
->addOption('rotate', 'r', InputOption::VALUE_NONE, 'Re-encrypts existing secrets with the newly generated keys.') ->addOption('rotate', 'r', InputOption::VALUE_NONE, 'Re-encrypt existing secrets with the newly generated keys.')
->setHelp(<<<'EOF' ->setHelp(<<<'EOF'
The <info>%command.name%</info> command generates a new encryption key. The <info>%command.name%</info> command generates a new encryption key.

View File

@ -45,7 +45,7 @@ final class SecretsListCommand extends Command
protected function configure() protected function configure()
{ {
$this $this
->setDescription('Lists all secrets.') ->setDescription('List all secrets.')
->addOption('reveal', 'r', InputOption::VALUE_NONE, 'Display decrypted values alongside names') ->addOption('reveal', 'r', InputOption::VALUE_NONE, 'Display decrypted values alongside names')
->setHelp(<<<'EOF' ->setHelp(<<<'EOF'
The <info>%command.name%</info> command list all stored secrets. The <info>%command.name%</info> command list all stored secrets.

View File

@ -44,9 +44,9 @@ final class SecretsRemoveCommand extends Command
protected function configure() protected function configure()
{ {
$this $this
->setDescription('Removes a secret from the vault.') ->setDescription('Remove a secret from the vault.')
->addArgument('name', InputArgument::REQUIRED, 'The name of the secret') ->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' ->setHelp(<<<'EOF'
The <info>%command.name%</info> command removes a secret from the vault. The <info>%command.name%</info> command removes a secret from the vault.

View File

@ -45,11 +45,11 @@ final class SecretsSetCommand extends Command
protected function configure() protected function configure()
{ {
$this $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('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') ->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('local', 'l', InputOption::VALUE_NONE, 'Update the local vault.')
->addOption('random', 'r', InputOption::VALUE_OPTIONAL, 'Generates a random value.', false) ->addOption('random', 'r', InputOption::VALUE_OPTIONAL, 'Generate a random value.', false)
->setHelp(<<<'EOF' ->setHelp(<<<'EOF'
The <info>%command.name%</info> command stores a secret in the vault. The <info>%command.name%</info> command stores a secret in the vault.

View File

@ -82,11 +82,11 @@ class TranslationDebugCommand extends Command
new InputArgument('locale', InputArgument::REQUIRED, 'The locale'), new InputArgument('locale', InputArgument::REQUIRED, 'The locale'),
new InputArgument('bundle', InputArgument::OPTIONAL, 'The bundle name or directory where to load the messages'), 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('domain', null, InputOption::VALUE_OPTIONAL, 'The messages domain'),
new InputOption('only-missing', null, InputOption::VALUE_NONE, 'Displays only missing messages'), new InputOption('only-missing', null, InputOption::VALUE_NONE, 'Display only missing messages'),
new InputOption('only-unused', null, InputOption::VALUE_NONE, 'Displays only unused 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'), 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' ->setHelp(<<<'EOF'
The <info>%command.name%</info> command helps finding unused or missing translation The <info>%command.name%</info> command helps finding unused or missing translation
messages and comparing them with the fallback ones by inspecting the messages and comparing them with the fallback ones by inspecting the

View File

@ -85,7 +85,7 @@ class TranslationUpdateCommand extends Command
new InputOption('xliff-version', null, InputOption::VALUE_OPTIONAL, 'Override the default xliff version', '1.2'), 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'), 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' ->setHelp(<<<'EOF'
The <info>%command.name%</info> command extracts translation strings from templates 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 of a given bundle or the default translations directory. It can display them or merge

View File

@ -40,7 +40,7 @@ class WorkflowDumpCommand extends Command
->setDefinition([ ->setDefinition([
new InputArgument('name', InputArgument::REQUIRED, 'A workflow name'), new InputArgument('name', InputArgument::REQUIRED, 'A workflow name'),
new InputArgument('marking', InputArgument::IS_ARRAY, 'A marking (a list of places)'), 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'), new InputOption('dump-format', null, InputOption::VALUE_REQUIRED, 'The dump format [dot|puml]', 'dot'),
]) ])
->setDescription('Dump a workflow') ->setDescription('Dump a workflow')

View File

@ -52,7 +52,7 @@ class UserPasswordEncoderCommand extends Command
protected function configure() protected function configure()
{ {
$this $this
->setDescription('Encodes a password.') ->setDescription('Encode a password.')
->addArgument('password', InputArgument::OPTIONAL, 'The plain password to encode.') ->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.') ->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.') ->addOption('empty-salt', null, InputOption::VALUE_NONE, 'Do not generate a salt or let the encoder generate one.')

View File

@ -62,7 +62,7 @@ class ServerLogCommand extends Command
->addOption('format', null, InputOption::VALUE_REQUIRED, 'The line format', ConsoleFormatter::SIMPLE_FORMAT) ->addOption('format', null, InputOption::VALUE_REQUIRED, 'The line format', ConsoleFormatter::SIMPLE_FORMAT)
->addOption('date-format', null, InputOption::VALUE_REQUIRED, 'The date format', ConsoleFormatter::SIMPLE_DATE) ->addOption('date-format', null, InputOption::VALUE_REQUIRED, 'The date format', ConsoleFormatter::SIMPLE_DATE)
->addOption('filter', null, InputOption::VALUE_REQUIRED, 'An expression to filter log. Example: "level > 200 or channel in [\'app\', \'doctrine\']"') ->addOption('filter', null, InputOption::VALUE_REQUIRED, 'An expression to filter log. Example: "level > 200 or channel in [\'app\', \'doctrine\']"')
->setDescription('Starts a log server that displays logs in real time') ->setDescription('Start a log server that displays logs in real time')
->setHelp(<<<'EOF' ->setHelp(<<<'EOF'
<info>%command.name%</info> starts a log server to display in real time the log <info>%command.name%</info> starts a log server to display in real time the log
messages generated by your application: messages generated by your application:

View File

@ -57,7 +57,7 @@ class ServerRunCommand extends Command
new InputOption('docroot', 'd', InputOption::VALUE_REQUIRED, 'Document root, usually where your front controllers are stored'), new InputOption('docroot', 'd', InputOption::VALUE_REQUIRED, 'Document root, usually where your front controllers are stored'),
new InputOption('router', 'r', InputOption::VALUE_REQUIRED, 'Path to custom router script'), new InputOption('router', 'r', InputOption::VALUE_REQUIRED, 'Path to custom router script'),
]) ])
->setDescription('Runs a local web server') ->setDescription('Run a local web server')
->setHelp(<<<'EOF' ->setHelp(<<<'EOF'
<info>%command.name%</info> runs a local web server: By default, the server <info>%command.name%</info> runs a local web server: By default, the server
listens on <comment>127.0.0.1</> address and the port number is automatically selected listens on <comment>127.0.0.1</> address and the port number is automatically selected

View File

@ -58,7 +58,7 @@ class ServerStartCommand extends Command
new InputOption('router', 'r', InputOption::VALUE_REQUIRED, 'Path to custom router script'), new InputOption('router', 'r', InputOption::VALUE_REQUIRED, 'Path to custom router script'),
new InputOption('pidfile', null, InputOption::VALUE_REQUIRED, 'PID file'), new InputOption('pidfile', null, InputOption::VALUE_REQUIRED, 'PID file'),
]) ])
->setDescription('Starts a local web server in the background') ->setDescription('Start a local web server in the background')
->setHelp(<<<'EOF' ->setHelp(<<<'EOF'
<info>%command.name%</info> runs a local web server: By default, the server <info>%command.name%</info> runs a local web server: By default, the server
listens on <comment>127.0.0.1</> address and the port number is automatically selected listens on <comment>127.0.0.1</> address and the port number is automatically selected

View File

@ -51,7 +51,7 @@ class ServerStatusCommand extends Command
new InputOption('pidfile', null, InputOption::VALUE_REQUIRED, 'PID file'), new InputOption('pidfile', null, InputOption::VALUE_REQUIRED, 'PID file'),
new InputOption('filter', null, InputOption::VALUE_REQUIRED, 'The value to display (one of port, host, or address)'), new InputOption('filter', null, InputOption::VALUE_REQUIRED, 'The value to display (one of port, host, or address)'),
]) ])
->setDescription('Outputs the status of the local web server') ->setDescription('Output the status of the local web server')
->setHelp(<<<'EOF' ->setHelp(<<<'EOF'
<info>%command.name%</info> shows the details of the given local web <info>%command.name%</info> shows the details of the given local web
server, such as the address and port where it is listening to: server, such as the address and port where it is listening to:

View File

@ -48,7 +48,7 @@ class ServerStopCommand extends Command
->setDefinition([ ->setDefinition([
new InputOption('pidfile', null, InputOption::VALUE_REQUIRED, 'PID file'), new InputOption('pidfile', null, InputOption::VALUE_REQUIRED, 'PID file'),
]) ])
->setDescription('Stops the local web server that was started with the server:start command') ->setDescription('Stop the local web server that was started with the server:start command')
->setHelp(<<<'EOF' ->setHelp(<<<'EOF'
<info>%command.name%</info> stops the local web server: <info>%command.name%</info> stops the local web server:

View File

@ -40,7 +40,7 @@ class HelpCommand extends Command
new InputOption('format', null, InputOption::VALUE_REQUIRED, 'The output format (txt, xml, json, or md)', 'txt'), 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 command help'), new InputOption('raw', null, InputOption::VALUE_NONE, 'To output raw command help'),
]) ])
->setDescription('Displays help for a command') ->setDescription('Display help for a command')
->setHelp(<<<'EOF' ->setHelp(<<<'EOF'
The <info>%command.name%</info> command displays help for a given command: The <info>%command.name%</info> command displays help for a given command:

View File

@ -33,7 +33,7 @@ class ListCommand extends Command
$this $this
->setName('list') ->setName('list')
->setDefinition($this->createDefinition()) ->setDefinition($this->createDefinition())
->setDescription('Lists commands') ->setDescription('List commands')
->setHelp(<<<'EOF' ->setHelp(<<<'EOF'
The <info>%command.name%</info> command lists all commands: The <info>%command.name%</info> command lists all commands:

View File

@ -64,7 +64,7 @@ class DebugCommand extends Command
new InputOption('show-deprecated', null, InputOption::VALUE_NONE, 'Display deprecated options in form types'), new InputOption('show-deprecated', null, InputOption::VALUE_NONE, 'Display deprecated options in form types'),
new InputOption('format', null, InputOption::VALUE_REQUIRED, 'The output format (txt or json)', 'txt'), new InputOption('format', null, InputOption::VALUE_REQUIRED, 'The output format (txt or json)', 'txt'),
]) ])
->setDescription('Displays form type information') ->setDescription('Display form type information')
->setHelp(<<<'EOF' ->setHelp(<<<'EOF'
The <info>%command.name%</info> command displays information about form types. The <info>%command.name%</info> command displays information about form types.

View File

@ -79,7 +79,7 @@ class ConsumeMessagesCommand extends Command
new InputOption('sleep', null, InputOption::VALUE_REQUIRED, 'Seconds to sleep before asking for new messages after no messages were found', 1), new InputOption('sleep', null, InputOption::VALUE_REQUIRED, 'Seconds to sleep before asking for new messages after no messages were found', 1),
new InputOption('bus', 'b', InputOption::VALUE_REQUIRED, 'Name of the bus to which received messages should be dispatched (if not passed, bus is determined automatically)'), new InputOption('bus', 'b', InputOption::VALUE_REQUIRED, 'Name of the bus to which received messages should be dispatched (if not passed, bus is determined automatically)'),
]) ])
->setDescription('Consumes messages') ->setDescription('Consume messages')
->setHelp(<<<'EOF' ->setHelp(<<<'EOF'
The <info>%command.name%</info> command consumes messages and dispatches them to the message bus. The <info>%command.name%</info> command consumes messages and dispatches them to the message bus.

View File

@ -43,7 +43,7 @@ class DebugCommand extends Command
{ {
$this $this
->addArgument('bus', InputArgument::OPTIONAL, sprintf('The bus id (one of "%s")', implode('", "', array_keys($this->mapping)))) ->addArgument('bus', InputArgument::OPTIONAL, sprintf('The bus id (one of "%s")', implode('", "', array_keys($this->mapping))))
->setDescription('Lists messages you can dispatch using the message buses') ->setDescription('List messages you can dispatch using the message buses')
->setHelp(<<<'EOF' ->setHelp(<<<'EOF'
The <info>%command.name%</info> command displays all messages that can be The <info>%command.name%</info> command displays all messages that can be
dispatched using the message buses: dispatched using the message buses:

View File

@ -59,7 +59,7 @@ class FailedMessagesRetryCommand extends AbstractFailedMessagesCommand
new InputArgument('id', InputArgument::IS_ARRAY, 'Specific message id(s) to retry'), new InputArgument('id', InputArgument::IS_ARRAY, 'Specific message id(s) to retry'),
new InputOption('force', null, InputOption::VALUE_NONE, 'Force action without confirmation'), new InputOption('force', null, InputOption::VALUE_NONE, 'Force action without confirmation'),
]) ])
->setDescription('Retries one or more messages from the failure transport.') ->setDescription('Retry one or more messages from the failure transport.')
->setHelp(<<<'EOF' ->setHelp(<<<'EOF'
The <info>%command.name%</info> retries message in the failure transport. The <info>%command.name%</info> retries message in the failure transport.

View File

@ -37,7 +37,7 @@ class FailedMessagesShowCommand extends AbstractFailedMessagesCommand
new InputArgument('id', InputArgument::OPTIONAL, 'Specific message id to show'), new InputArgument('id', InputArgument::OPTIONAL, 'Specific message id to show'),
new InputOption('max', null, InputOption::VALUE_REQUIRED, 'Maximum number of messages to list', 50), 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('Show one or more messages from the failure transport.')
->setHelp(<<<'EOF' ->setHelp(<<<'EOF'
The <info>%command.name%</info> shows message that are pending in the failure transport. The <info>%command.name%</info> shows message that are pending in the failure transport.

View File

@ -41,7 +41,7 @@ class SetupTransportsCommand extends Command
{ {
$this $this
->addArgument('transport', InputArgument::OPTIONAL, 'Name of the transport to setup', null) ->addArgument('transport', InputArgument::OPTIONAL, 'Name of the transport to setup', null)
->setDescription('Prepares the required infrastructure for the transport') ->setDescription('Prepare the required infrastructure for the transport')
->setHelp(<<<EOF ->setHelp(<<<EOF
The <info>%command.name%</info> command setups the transports: The <info>%command.name%</info> command setups the transports:

View File

@ -42,7 +42,7 @@ class StopWorkersCommand extends Command
{ {
$this $this
->setDefinition([]) ->setDefinition([])
->setDescription('Stops workers after their current message') ->setDescription('Stop workers after their current message')
->setHelp(<<<'EOF' ->setHelp(<<<'EOF'
The <info>%command.name%</info> command sends a signal to stop any <info>messenger:consume</info> processes that are running. The <info>%command.name%</info> command sends a signal to stop any <info>messenger:consume</info> processes that are running.

View File

@ -53,7 +53,7 @@ class XliffLintCommand extends Command
protected function configure() protected function configure()
{ {
$this $this
->setDescription('Lints an XLIFF file and outputs encountered errors') ->setDescription('Lint an XLIFF file and outputs encountered errors')
->addArgument('filename', InputArgument::IS_ARRAY, 'A file, a directory or "-" for reading from STDIN') ->addArgument('filename', InputArgument::IS_ARRAY, 'A file, a directory or "-" for reading from STDIN')
->addOption('format', null, InputOption::VALUE_REQUIRED, 'The output format', 'txt') ->addOption('format', null, InputOption::VALUE_REQUIRED, 'The output format', 'txt')
->setHelp(<<<EOF ->setHelp(<<<EOF

View File

@ -58,7 +58,7 @@ class ServerDumpCommand extends Command
$this $this
->addOption('format', null, InputOption::VALUE_REQUIRED, sprintf('The output format (%s)', $availableFormats), 'cli') ->addOption('format', null, InputOption::VALUE_REQUIRED, sprintf('The output format (%s)', $availableFormats), 'cli')
->setDescription('Starts a dump server that collects and displays dumps in a single place') ->setDescription('Start a dump server that collects and displays dumps in a single place')
->setHelp(<<<'EOF' ->setHelp(<<<'EOF'
<info>%command.name%</info> starts a dump server that collects and displays <info>%command.name%</info> starts a dump server that collects and displays
dumps in a single place for debugging you application: dumps in a single place for debugging you application:

View File

@ -53,7 +53,7 @@ class LintCommand extends Command
protected function configure() protected function configure()
{ {
$this $this
->setDescription('Lints a file and outputs encountered errors') ->setDescription('Lint a file and outputs encountered errors')
->addArgument('filename', InputArgument::IS_ARRAY, 'A file, a directory or "-" for reading from STDIN') ->addArgument('filename', InputArgument::IS_ARRAY, 'A file, a directory or "-" for reading from STDIN')
->addOption('format', null, InputOption::VALUE_REQUIRED, 'The output format', 'txt') ->addOption('format', null, InputOption::VALUE_REQUIRED, 'The output format', 'txt')
->addOption('parse-tags', null, InputOption::VALUE_NONE, 'Parse custom tags') ->addOption('parse-tags', null, InputOption::VALUE_NONE, 'Parse custom tags')