Skip to content

[Console] fix description of INF default values #23345

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 3, 2017
Merged

[Console] fix description of INF default values #23345

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/Symfony/Component/Console/Descriptor/JsonDescriptor.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ private function getInputArgumentData(InputArgument $argument)
'is_required' => $argument->isRequired(),
'is_array' => $argument->isArray(),
'description' => preg_replace('/\s*[\r\n]\s*/', ' ', $argument->getDescription()),
'default' => $argument->getDefault(),
'default' => INF === $argument->getDefault() ? 'INF' : $argument->getDefault(),
);
}

Expand All @@ -121,7 +121,7 @@ private function getInputOptionData(InputOption $option)
'is_value_required' => $option->isValueRequired(),
'is_multiple' => $option->isArray(),
'description' => preg_replace('/\s*[\r\n]\s*/', ' ', $option->getDescription()),
'default' => $option->getDefault(),
'default' => INF === $option->getDefault() ? 'INF' : $option->getDefault(),
);
}

Expand Down
4 changes: 4 additions & 0 deletions src/Symfony/Component/Console/Descriptor/TextDescriptor.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -237,6 +237,10 @@ private function writeText($content, array $options = array())
*/
private function formatDefaultValue($default)
{
if (INF === $default) {
return 'INF';
}

if (is_string($default)) {
$default = OutputFormatter::escape($default);
} elseif (is_array($default)) {
Expand Down
2 changes: 2 additions & 0 deletions src/Symfony/Component/Console/Tests/Descriptor/ObjectsProvider.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ public static function getInputArguments()
'input_argument_3' => new InputArgument('argument_name', InputArgument::OPTIONAL, 'argument description', 'default_value'),
'input_argument_4' => new InputArgument('argument_name', InputArgument::REQUIRED, "multiline\nargument description"),
'input_argument_with_style' => new InputArgument('argument_name', InputArgument::OPTIONAL, 'argument description', '<comment>style</>'),
'input_argument_with_default_inf_value' => new InputArgument('argument_name', InputArgument::OPTIONAL, 'argument description', INF),
);
}

Expand All @@ -46,6 +47,7 @@ public static function getInputOptions()
'input_option_6' => new InputOption('option_name', array('o', 'O'), InputOption::VALUE_REQUIRED, 'option with multiple shortcuts'),
'input_option_with_style' => new InputOption('option_name', 'o', InputOption::VALUE_REQUIRED, 'option description', '<comment>style</>'),
'input_option_with_style_array' => new InputOption('option_name', 'o', InputOption::VALUE_IS_ARRAY | InputOption::VALUE_REQUIRED, 'option description', array('<comment>Hello</comment>', '<info>world</info>')),
'input_option_with_default_inf_value' => new InputOption('option_name', 'o', InputOption::VALUE_OPTIONAL, 'option description', INF),
);
}

Expand Down
7 changes: 7 additions & 0 deletions src/Symfony/Component/Console/Tests/Fixtures/input_argument_with_default_inf_value.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"name": "argument_name",
"is_required": false,
"is_array": false,
"description": "argument description",
"default": "INF"
}
7 changes: 7 additions & 0 deletions ...mfony/Component/Console/Tests/Fixtures/input_argument_with_default_inf_value.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
**argument_name:**

* Name: argument_name
* Is required: no
* Is array: no
* Description: argument description
* Default: `INF`
1 change: 1 addition & 0 deletions src/Symfony/Component/Console/Tests/Fixtures/input_argument_with_default_inf_value.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<info>argument_name</info> argument description<comment> [default: INF]</comment>
7 changes: 7 additions & 0 deletions src/Symfony/Component/Console/Tests/Fixtures/input_argument_with_default_inf_value.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<argument name="argument_name" is_required="0" is_array="0">
<description>argument description</description>
<defaults>
<default>INF</default>
</defaults>
</argument>
9 changes: 9 additions & 0 deletions src/Symfony/Component/Console/Tests/Fixtures/input_option_with_default_inf_value.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"name": "--option_name",
"shortcut": "-o",
"accept_value": true,
"is_value_required": false,
"is_multiple": false,
"description": "option description",
"default": "INF"
}
9 changes: 9 additions & 0 deletions ...Symfony/Component/Console/Tests/Fixtures/input_option_with_default_inf_value.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
**option_name:**

* Name: `--option_name`
* Shortcut: `-o`
* Accept value: yes
* Is value required: no
* Is multiple: no
* Description: option description
* Default: `INF`
1 change: 1 addition & 0 deletions src/Symfony/Component/Console/Tests/Fixtures/input_option_with_default_inf_value.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<info>-o, --option_name[=OPTION_NAME]</info> option description<comment> [default: INF]</comment>
7 changes: 7 additions & 0 deletions src/Symfony/Component/Console/Tests/Fixtures/input_option_with_default_inf_value.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<option name="--option_name" shortcut="-o" accept_value="1" is_value_required="0" is_multiple="0">
<description>option description</description>
<defaults>
<default>INF</default>
</defaults>
</option>