minor #5585 DX: make doc examples prettier (kubawerlos)

This PR was squashed before being merged into the 2.18 branch. Discussion ---------- DX: make doc examples prettier - Makes all diff for doc examples having whote file content. - Removes the line numbers e.g. `@@ -1,2 +1,2 @@` from diffs. All interesting changes are in `src/Documentation/DocumentationGenerator.php` file. Ping @julienfalque for review. Commits ------- 23e5515 DX: make doc examples prettier
PHP-CS-Fixer · Apr 6, 2021 · 02675fc · 02675fc
2 parents f01521b + 23e5515
commit 02675fc
Show file tree

Hide file tree

Showing 243 changed files with 242 additions and 467 deletions.
diff --git a/doc/rules/alias/array_push.rst b/doc/rules/alias/array_push.rst
@@ -18,7 +18,6 @@ Example #1
 
    --- Original
    +++ New
-   @@ -1,2 +1,2 @@
     <?php
    -array_push($x, $y);
    +$x[] = $y;

diff --git a/doc/rules/alias/backtick_to_shell_exec.rst b/doc/rules/alias/backtick_to_shell_exec.rst
@@ -20,7 +20,6 @@ Example #1
 
    --- Original
    +++ New
-   @@ -1,3 +1,3 @@
     <?php
    -$plain = `ls -lah`;
    -$withVar = `ls -lah $var1 ${var2} {$var3} {$var4[0]} {$var5->call()}`;

diff --git a/doc/rules/alias/ereg_to_preg.rst b/doc/rules/alias/ereg_to_preg.rst
@@ -18,7 +18,6 @@ Example #1
 
    --- Original
    +++ New
-   @@ -1 +1 @@
    -<?php $x = ereg('[A-Z]');
    +<?php $x = preg_match('/[A-Z]/D');
 

diff --git a/doc/rules/alias/mb_str_functions.rst b/doc/rules/alias/mb_str_functions.rst
@@ -18,7 +18,6 @@ Example #1
 
    --- Original
    +++ New
-   @@ -1,13 +1,13 @@
     <?php
    -$a = strlen($a);
    -$a = strpos($a, $b);

diff --git a/doc/rules/alias/no_alias_functions.rst b/doc/rules/alias/no_alias_functions.rst
@@ -34,7 +34,6 @@ Example #1
 
    --- Original
    +++ New
-   @@ -1,22 +1,22 @@
     <?php
    -$a = chop($b);
    -close($b);
@@ -87,7 +86,6 @@ With configuration: ``['sets' => ['@mbreg']]``.
 
    --- Original
    +++ New
-   @@ -1,3 +1,3 @@
     <?php
     $a = is_double($b);
    -mbereg_search_getregs();

diff --git a/doc/rules/alias/no_alias_language_construct_call.rst b/doc/rules/alias/no_alias_language_construct_call.rst
@@ -14,7 +14,6 @@ Example #1
 
    --- Original
    +++ New
-   @@ -1,2 +1,2 @@
     <?php
    -die;
    +exit;

diff --git a/doc/rules/alias/no_mixed_echo_print.rst b/doc/rules/alias/no_mixed_echo_print.rst
@@ -28,7 +28,6 @@ Example #1
 
    --- Original
    +++ New
-   @@ -1 +1 @@
    -<?php print 'example';
    +<?php echo 'example';
 
@@ -41,7 +40,6 @@ With configuration: ``['use' => 'print']``.
 
    --- Original
    +++ New
-   @@ -1 +1 @@
    -<?php echo('example');
    +<?php print('example');
 

diff --git a/doc/rules/alias/pow_to_exponentiation.rst b/doc/rules/alias/pow_to_exponentiation.rst
@@ -18,7 +18,6 @@ Example #1
 
    --- Original
    +++ New
-   @@ -1,2 +1,2 @@
     <?php
    - pow($a, 1);
    + $a** 1;

diff --git a/doc/rules/alias/random_api_migration.rst b/doc/rules/alias/random_api_migration.rst
@@ -33,7 +33,6 @@ Example #1
 
    --- Original
    +++ New
-   @@ -1,4 +1,4 @@
     <?php
    -$a = getrandmax();
    -$a = rand($b, $c);
@@ -51,7 +50,6 @@ With configuration: ``['replacements' => ['getrandmax' => 'mt_getrandmax']]``.
 
    --- Original
    +++ New
-   @@ -1,4 +1,4 @@
     <?php
    -$a = getrandmax();
    +$a = mt_getrandmax();
@@ -67,7 +65,6 @@ With configuration: ``['replacements' => ['rand' => 'random_int']]``.
 
    --- Original
    +++ New
-   @@ -1 +1 @@
    -<?php $a = rand($b, $c);
    +<?php $a = random_int($b, $c);
 

diff --git a/doc/rules/alias/set_type_to_cast.rst b/doc/rules/alias/set_type_to_cast.rst
@@ -19,7 +19,6 @@ Example #1
 
    --- Original
    +++ New
-   @@ -1,4 +1,4 @@
     <?php
    -settype($foo, "integer");
    -settype($bar, "string");

diff --git a/doc/rules/array_notation/array_syntax.rst b/doc/rules/array_notation/array_syntax.rst
@@ -28,7 +28,6 @@ Example #1
 
    --- Original
    +++ New
-   @@ -1,2 +1,2 @@
     <?php
    -[1,2];
    +array(1,2);
@@ -42,7 +41,6 @@ With configuration: ``['syntax' => 'short']``.
 
    --- Original
    +++ New
-   @@ -1,2 +1,2 @@
     <?php
    -array(1,2);
    +[1,2];

diff --git a/doc/rules/array_notation/no_multiline_whitespace_around_double_arrow.rst b/doc/rules/array_notation/no_multiline_whitespace_around_double_arrow.rst
@@ -14,7 +14,6 @@ Example #1
 
    --- Original
    +++ New
-   @@ -1,4 +1,2 @@
     <?php
    -$a = array(1
    -

diff --git a/doc/rules/array_notation/no_trailing_comma_in_singleline_array.rst b/doc/rules/array_notation/no_trailing_comma_in_singleline_array.rst
@@ -14,7 +14,6 @@ Example #1
 
    --- Original
    +++ New
-   @@ -1,2 +1,2 @@
     <?php
    -$a = array('sample',  );
    +$a = array('sample');

diff --git a/doc/rules/array_notation/no_whitespace_before_comma_in_array.rst b/doc/rules/array_notation/no_whitespace_before_comma_in_array.rst
@@ -28,7 +28,6 @@ Example #1
 
    --- Original
    +++ New
-   @@ -1 +1 @@
    -<?php $x = array(1 , "2");
    +<?php $x = array(1, "2");
 
@@ -41,7 +40,6 @@ With configuration: ``['after_heredoc' => true]``.
 
    --- Original
    +++ New
-   @@ -1,6 +1,5 @@
     <?php
         $x = [<<<EOD
     foo

diff --git a/doc/rules/array_notation/normalize_index_brace.rst b/doc/rules/array_notation/normalize_index_brace.rst
@@ -14,7 +14,6 @@ Example #1
 
    --- Original
    +++ New
-   @@ -1,2 +1,2 @@
     <?php
    -echo $sample{$index};
    +echo $sample[$index];

diff --git a/doc/rules/array_notation/trailing_comma_in_multiline_array.rst b/doc/rules/array_notation/trailing_comma_in_multiline_array.rst
@@ -28,7 +28,6 @@ Example #1
 
    --- Original
    +++ New
-   @@ -1,5 +1,5 @@
     <?php
     array(
         1,
@@ -45,7 +44,8 @@ With configuration: ``['after_heredoc' => true]``.
 
    --- Original
    +++ New
-   @@ -3,5 +3,5 @@
+    <?php
+        $x = [
             'foo',
             <<<EOD
                 bar

diff --git a/doc/rules/array_notation/trim_array_spaces.rst b/doc/rules/array_notation/trim_array_spaces.rst
@@ -15,7 +15,6 @@ Example #1
 
    --- Original
    +++ New
-   @@ -1,3 +1,3 @@
     <?php
    -$sample = array( );
    -$sample = array( 'a', 'b' );

diff --git a/doc/rules/array_notation/whitespace_after_comma_in_array.rst b/doc/rules/array_notation/whitespace_after_comma_in_array.rst
@@ -14,7 +14,6 @@ Example #1
 
    --- Original
    +++ New
-   @@ -1,2 +1,2 @@
     <?php
    -$sample = array(1,'a',$b,);
    +$sample = array(1, 'a', $b, );

diff --git a/doc/rules/basic/braces.rst b/doc/rules/basic/braces.rst
@@ -69,7 +69,6 @@ Example #1
 
    --- Original
    +++ New
-   @@ -1,25 +1,27 @@
     <?php
 
    -class Foo {
@@ -119,7 +118,6 @@ With configuration: ``['allow_single_line_closure' => true]``.
 
    --- Original
    +++ New
-   @@ -1,4 +1,5 @@
     <?php
     $positive = function ($item) { return $item >= 0; };
     $negative = function ($item) {
@@ -136,7 +134,6 @@ With configuration: ``['position_after_functions_and_oop_constructs' => 'same']`
 
    --- Original
    +++ New
-   @@ -1,27 +1,25 @@
     <?php
 
    -class Foo

diff --git a/doc/rules/basic/encoding.rst b/doc/rules/basic/encoding.rst
@@ -14,7 +14,6 @@ Example #1
 
    --- Original
    +++ New
-   @@ -1,3 +1,3 @@
    -<?php
    +<?php
 

diff --git a/doc/rules/basic/non_printable_character.rst b/doc/rules/basic/non_printable_character.rst
@@ -33,7 +33,6 @@ Example #1
 
    --- Original
    +++ New
-   @@ -1 +1 @@
    -<?php echo "Hello World !";
    +<?php echo "Hello World !";
 
@@ -46,7 +45,6 @@ With configuration: ``['use_escape_sequences_in_strings' => true]``.
 
    --- Original
    +++ New
-   @@ -1 +1 @@
    -<?php echo "Hello World !";
    +<?php echo "\u{200b}Hello\u{2007}World\u{a0}!";
 

diff --git a/doc/rules/basic/psr0.rst b/doc/rules/basic/psr0.rst
@@ -38,7 +38,6 @@ Example #1
 
    --- Original
    +++ New
-   @@ -1,3 +1,3 @@
     <?php
     namespace PhpCsFixer\FIXER\Basic;
    -class InvalidName {}
@@ -53,7 +52,6 @@ With configuration: ``['dir' => './src']``.
 
    --- Original
    +++ New
-   @@ -1,3 +1,3 @@
     <?php
    -namespace PhpCsFixer\FIXER\Basic;
    -class InvalidName {}

diff --git a/doc/rules/basic/psr4.rst b/doc/rules/basic/psr4.rst
@@ -23,7 +23,6 @@ Example #1
 
    --- Original
    +++ New
-   @@ -1,3 +1,3 @@
     <?php
     namespace PhpCsFixer\FIXER\Basic;
    -class InvalidName {}

diff --git a/doc/rules/basic/psr_autoloading.rst b/doc/rules/basic/psr_autoloading.rst
@@ -34,7 +34,6 @@ Example #1
 
    --- Original
    +++ New
-   @@ -1,3 +1,3 @@
     <?php
     namespace PhpCsFixer\FIXER\Basic;
    -class InvalidName {}
@@ -49,7 +48,6 @@ With configuration: ``['dir' => './src']``.
 
    --- Original
    +++ New
-   @@ -1,3 +1,3 @@
     <?php
    -namespace PhpCsFixer\FIXER\Basic;
    -class InvalidName {}

diff --git a/doc/rules/casing/constant_case.rst b/doc/rules/casing/constant_case.rst
@@ -29,7 +29,6 @@ Example #1
 
    --- Original
    +++ New
-   @@ -1,4 +1,4 @@
     <?php
    -$a = FALSE;
    -$b = True;
@@ -47,7 +46,6 @@ With configuration: ``['case' => 'upper']``.
 
    --- Original
    +++ New
-   @@ -1,4 +1,4 @@
     <?php
     $a = FALSE;
    -$b = True;

diff --git a/doc/rules/casing/lowercase_constants.rst b/doc/rules/casing/lowercase_constants.rst
@@ -18,7 +18,6 @@ Example #1
 
    --- Original
    +++ New
-   @@ -1,4 +1,4 @@
     <?php
    -$a = FALSE;
    -$b = True;

diff --git a/doc/rules/casing/lowercase_keywords.rst b/doc/rules/casing/lowercase_keywords.rst
@@ -14,7 +14,6 @@ Example #1
 
    --- Original
    +++ New
-   @@ -1,11 +1,11 @@
     <?php
    -    FOREACH($a AS $B) {
    -        TRY {

diff --git a/doc/rules/casing/lowercase_static_reference.rst b/doc/rules/casing/lowercase_static_reference.rst
@@ -15,7 +15,8 @@ Example #1
 
    --- Original
    +++ New
-   @@ -3,16 +3,16 @@
+    <?php
+    class Foo extends Bar
     {
         public function baz1()
         {
@@ -43,7 +44,6 @@ Example #2
 
    --- Original
    +++ New
-   @@ -1,8 +1,8 @@
     <?php
     class Foo extends Bar
     {

diff --git a/doc/rules/casing/magic_constant_casing.rst b/doc/rules/casing/magic_constant_casing.rst
@@ -14,7 +14,6 @@ Example #1
 
    --- Original
    +++ New
-   @@ -1,2 +1,2 @@
     <?php
    -echo __dir__;
    +echo __DIR__;

diff --git a/doc/rules/casing/magic_method_casing.rst b/doc/rules/casing/magic_method_casing.rst
@@ -14,7 +14,6 @@ Example #1
 
    --- Original
    +++ New
-   @@ -1,7 +1,7 @@
     <?php
     class Foo
     {
@@ -31,7 +30,6 @@ Example #2
 
    --- Original
    +++ New
-   @@ -1,2 +1,2 @@
     <?php
    -$foo->__INVOKE(1);
    +$foo->__invoke(1);

diff --git a/doc/rules/casing/native_function_casing.rst b/doc/rules/casing/native_function_casing.rst
@@ -14,7 +14,6 @@ Example #1
 
    --- Original
    +++ New
-   @@ -1,2 +1,2 @@
     <?php
    -STRLEN($str);
    +strlen($str);