Merge branch '2.2'

keradus · keradus · commit e0021ef23a39 · 2017-05-05T21:14:46.000+02:00
# Conflicts:
#	tests/Console/Command/DescribeCommandTest.php
diff --git a/README.rst b/README.rst
@@ -513,8 +513,8 @@ Choose from the list of available rules:
 
   Configuration options:
 
-  - ``syntax`` (``'long'``, ``'short'``): whether to use the ``long`` or ``short``
-    ``list`` syntax; defaults to ``'long'``
+  - ``syntax`` (``'long'``, ``'short'``): whether to use the ``long`` or ``short`` ``list``
+    syntax; defaults to ``'long'``
 
 * **lowercase_cast** [@Symfony]
 
diff --git a/src/Console/Command/CommandHelp.php b/src/Console/Command/CommandHelp.php
@@ -354,8 +354,10 @@ function (FixerInterface $a, FixerInterface $b) {
                 $description = '[n/a]';
             }
 
-            $description = wordwrap($description, 72, "\n   | ");
-            $description = str_replace('`', '``', $description);
+            $description = implode("\n   | ", self::wordwrap(
+                preg_replace('/(`.+?`)/', '<info>$1</info>', $description),
+                72
+            ));
 
             if (!empty($sets)) {
                 $help .= sprintf(" * <comment>%s</comment> [%s]\n   | %s\n", $fixer->getName(), implode(', ', $sets), $description);
@@ -366,7 +368,11 @@ function (FixerInterface $a, FixerInterface $b) {
             if ($fixer->isRisky()) {
                 $help .= sprintf(
                     "   | *Risky rule: %s.*\n",
-                    str_replace('`', '``', lcfirst(preg_replace('/\.$/', '', $fixer->getDefinition()->getRiskyDescription())))
+                    preg_replace(
+                        '/(`.+?`)/',
+                        '<info>$1</info>',
+                        lcfirst(preg_replace('/\.$/', '', $fixer->getDefinition()->getRiskyDescription()))
+                    )
                 );
             }
 
@@ -399,7 +405,11 @@ function (FixerOptionInterface $optionA, FixerOptionInterface $optionB) {
                             $line .= ' (<comment>'.implode('</comment>, <comment>', $allowed).'</comment>)';
                         }
 
-                        $line .= ': '.str_replace('`', '``', lcfirst(preg_replace('/\.$/', '', $option->getDescription()))).'; ';
+                        $line .= ': '.preg_replace(
+                            '/(`.+?`)/',
+                            '<info>$1</info>',
+                            lcfirst(preg_replace('/\.$/', '', $option->getDescription()))
+                        ).'; ';
                         if ($option->hasDefault()) {
                             $line .= 'defaults to <comment>'.self::toString($option->getDefault()).'</comment>';
                         } else {
@@ -420,7 +430,8 @@ function (FixerOptionInterface $optionA, FixerOptionInterface $optionB) {
             }
         }
 
-        return $help;
+        // prevent "\</foo>" from being rendered as an escaped literal style tag
+        return preg_replace('#\\\\(</.*?>)#', '<<$1', $help);
     }
 
     /**
diff --git a/src/Console/Command/DescribeCommand.php b/src/Console/Command/DescribeCommand.php
@@ -169,7 +169,8 @@ private function describeRule(OutputInterface $output, $name)
                     $line .= ' (<comment>'.implode('</comment>, <comment>', $allowed).'</comment>)';
                 }
 
-                $line .= ': '.lcfirst(preg_replace('/\.$/', '', $option->getDescription())).'; ';
+                $description = preg_replace('/(`.+?`)/', '<info>$1</info>', $option->getDescription());
+                $line .= ': '.lcfirst(preg_replace('/\.$/', '', $description)).'; ';
                 if ($option->hasDefault()) {
                     $line .= sprintf(
                         'defaults to <comment>%s</comment>',
diff --git a/src/Console/Command/ReadmeCommand.php b/src/Console/Command/ReadmeCommand.php
@@ -214,6 +214,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
         $help = str_replace('%command.full_name%', 'php-cs-fixer.phar '.$command->getName(), $help);
         $help = str_replace('%command.name%', $command->getName(), $help);
         $help = preg_replace('#</?(comment|info)>#', '``', $help);
+        $help = preg_replace('#`(``.+?``)`#', '$1', $help);
         $help = preg_replace('#^(\s+)``(.+)``$#m', '$1$2', $help);
         $help = preg_replace('#^ \* ``(.+)``(.*?\n)#m', "* **$1**$2\n", $help);
         $help = preg_replace('#^   \\| #m', '  ', $help);
diff --git a/tests/Console/Command/DescribeCommandTest.php b/tests/Console/Command/DescribeCommandTest.php
@@ -38,7 +38,7 @@ public function testExecuteOutput()
 Replaces bad stuff with good stuff.
 
 Fixer is configurable using following options:
-* things (bool): enables fixing things as well; defaults to false
+* things (bool): enables fixing `things` as well; defaults to false
 
 Fixing examples:
  * Example #1.
@@ -119,7 +119,7 @@ private function execute()
         $fixer->getPriority()->willReturn(0);
         $fixer->isRisky()->willReturn(false);
         $fixer->getConfigurationDefinition()->willReturn(new FixerConfigurationResolver([
-            new FixerOption('things', 'Enables fixing things as well.', false, false, ['bool']),
+            new FixerOption('things', 'Enables fixing `things` as well.', false, false, ['bool']),
         ]));
         $fixer->getDefinition()->willReturn(new FixerDefinition(
             'Fixes stuff.',

Original file line number	Diff line number	Diff line change
`@@ -169,7 +169,8 @@ private function describeRule(OutputInterface $output, $name)`
`169`	`169`	`$line .= ' (<comment>'.implode('</comment>, <comment>', $allowed).'</comment>)';`
`170`	`170`	`}`
`171`	`171`
`172`		`- $line .= ': '.lcfirst(preg_replace('/\.$/', '', $option->getDescription())).'; ';`
	`172`	+ $description = preg_replace('/(`.+?`)/', '<info>$1</info>', $option->getDescription());
	`173`	`+ $line .= ': '.lcfirst(preg_replace('/\.$/', '', $description)).'; ';`
`173`	`174`	`if ($option->hasDefault()) {`
`174`	`175`	`$line .= sprintf(`
`175`	`176`	`'defaults to <comment>%s</comment>',`