From 1c94fea42f6c3d74471597c8b81cbee4959b0934 Mon Sep 17 00:00:00 2001 From: Robin Chalas Date: Thu, 26 May 2016 10:39:15 +0200 Subject: [PATCH] [Console] SymfonyStyle: Fix alignment/prefixing of multi-line comments CS Fixes Add tests Add docblock Fix side effect on FrameworkBundle tests Remove useless '\n' from TextDescriptor since comments are block --- .../Console/Descriptor/TextDescriptor.php | 2 +- .../Tests/Fixtures/Descriptor/alias_1.txt | 4 +++- .../Tests/Fixtures/Descriptor/alias_2.txt | 4 +++- .../Component/Console/Style/SymfonyStyle.php | 12 +++++++----- .../Style/SymfonyStyle/command/command_11.php | 13 +++++++++++++ .../Style/SymfonyStyle/output/output_11.txt | 6 ++++++ .../Fixtures/Style/SymfonyStyle/output/output_5.txt | 7 +++++-- 7 files changed, 38 insertions(+), 10 deletions(-) create mode 100644 src/Symfony/Component/Console/Tests/Fixtures/Style/SymfonyStyle/command/command_11.php create mode 100644 src/Symfony/Component/Console/Tests/Fixtures/Style/SymfonyStyle/output/output_11.txt diff --git a/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/TextDescriptor.php b/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/TextDescriptor.php index dca8ffc483..4aa00a85db 100644 --- a/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/TextDescriptor.php +++ b/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/TextDescriptor.php @@ -339,7 +339,7 @@ class TextDescriptor extends Descriptor */ protected function describeContainerAlias(Alias $alias, array $options = array()) { - $options['output']->comment(sprintf("This service is an alias for the service %s\n", (string) $alias)); + $options['output']->comment(sprintf('This service is an alias for the service %s', (string) $alias)); } /** diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/alias_1.txt b/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/alias_1.txt index c3b9987ec2..91ed6790f0 100644 --- a/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/alias_1.txt +++ b/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/alias_1.txt @@ -1 +1,3 @@ -// This service is an alias for the service service_1 \ No newline at end of file + + // This service is an alias for the service service_1 + diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/alias_2.txt b/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/alias_2.txt index b53b090b5f..1ebffe38ac 100644 --- a/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/alias_2.txt +++ b/src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/alias_2.txt @@ -1 +1,3 @@ -// This service is an alias for the service service_2 \ No newline at end of file + + // This service is an alias for the service service_2 + diff --git a/src/Symfony/Component/Console/Style/SymfonyStyle.php b/src/Symfony/Component/Console/Style/SymfonyStyle.php index ebaa18dd53..53a7951e01 100644 --- a/src/Symfony/Component/Console/Style/SymfonyStyle.php +++ b/src/Symfony/Component/Console/Style/SymfonyStyle.php @@ -170,16 +170,18 @@ class SymfonyStyle extends OutputStyle } /** - * {@inheritdoc} + * Formats a command comment. + * + * @param string|array $message */ public function comment($message) { - $this->autoPrependText(); - $messages = is_array($message) ? array_values($message) : array($message); - foreach ($messages as $message) { - $this->writeln(sprintf(' // %s', $message)); + foreach ($messages as &$message) { + $message = $this->getFormatter()->format($message); } + + $this->block($messages, null, null, ' // '); } /** diff --git a/src/Symfony/Component/Console/Tests/Fixtures/Style/SymfonyStyle/command/command_11.php b/src/Symfony/Component/Console/Tests/Fixtures/Style/SymfonyStyle/command/command_11.php new file mode 100644 index 0000000000..a2781ddbea --- /dev/null +++ b/src/Symfony/Component/Console/Tests/Fixtures/Style/SymfonyStyle/command/command_11.php @@ -0,0 +1,13 @@ +comment( + 'Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum' + ); +}; diff --git a/src/Symfony/Component/Console/Tests/Fixtures/Style/SymfonyStyle/output/output_11.txt b/src/Symfony/Component/Console/Tests/Fixtures/Style/SymfonyStyle/output/output_11.txt new file mode 100644 index 0000000000..9983af832a --- /dev/null +++ b/src/Symfony/Component/Console/Tests/Fixtures/Style/SymfonyStyle/output/output_11.txt @@ -0,0 +1,6 @@ + + // Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna + // aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. + // Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur + // sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum + diff --git a/src/Symfony/Component/Console/Tests/Fixtures/Style/SymfonyStyle/output/output_5.txt b/src/Symfony/Component/Console/Tests/Fixtures/Style/SymfonyStyle/output/output_5.txt index 738eb9e606..be4a2db605 100644 --- a/src/Symfony/Component/Console/Tests/Fixtures/Style/SymfonyStyle/output/output_5.txt +++ b/src/Symfony/Component/Console/Tests/Fixtures/Style/SymfonyStyle/output/output_5.txt @@ -11,5 +11,8 @@ Lorem ipsum dolor sit amet consectetur adipiscing elit Lorem ipsum dolor sit amet - // Lorem ipsum dolor sit amet - // consectetur adipiscing elit + + // Lorem ipsum dolor sit amet + // + // consectetur adipiscing elit +