minor #4662 DX: generate headers in README.rst (kubawerlos)

This PR was merged into the 2.15 branch.

Discussion
----------

DX: generate headers in README.rst

Motivated by https://github.com/FriendsOfPHP/PHP-CS-Fixer/pull/4560/files#diff-88b99bb28683bd5b7e3a204826ead112R98

Commits
-------

db78f9c DX: generate headers in README.rst

Author: keradus

README.rst

@@ -134,7 +134,7 @@ You can update ``php-cs-fixer`` through this command:
     $ brew upgrade php-cs-fixer
 
 Locally (PHIVE)
-~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~
 
 .. code-block:: bash
 

src/Console/Command/ReadmeCommand.php

@@ -40,9 +40,8 @@ protected function configure()
      */
     protected function execute(InputInterface $input, OutputInterface $output)
     {
-        $header = <<<'EOF'
-PHP Coding Standards Fixer
-==========================
+        $header = <<<EOF
+{$this->header('PHP Coding Standards Fixer', '=')}
 
 The PHP Coding Standards Fixer (PHP CS Fixer) tool fixes your code to follow standards;
 whether you want to follow PHP coding standards as defined in the PSR-1, PSR-2, etc.,
@@ -62,21 +61,17 @@ protected function execute(InputInterface $input, OutputInterface $output)
 You can talk to us at https://gitter.im/PHP-CS-Fixer/Lobby about the project,
 configuration, possible improvements, ideas and questions, please visit us!
 
-Requirements
-------------
+{$this->header('Requirements', '-')}
 
 PHP needs to be a minimum version of PHP 5.6.0.
 
-Installation
-------------
+{$this->header('Installation', '-')}
 
-Locally
-~~~~~~~
+{$this->header('Locally', '~')}
 
 Download the `php-cs-fixer.phar`_ file and store it somewhere on your computer.
 
-Globally (manual)
-~~~~~~~~~~~~~~~~~
+{$this->header('Globally (manual)', '~')}
 
 You can run these commands to easily access latest ``php-cs-fixer`` from anywhere on
 your system:
@@ -106,8 +101,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
 
 Then, just run ``php-cs-fixer``.
 
-Globally (Composer)
-~~~~~~~~~~~~~~~~~~~
+{$this->header('Globally (Composer)', '~')}
 
 To install PHP CS Fixer, `install Composer <https://getcomposer.org/download/>`_ and issue the following command:
 
@@ -119,79 +113,69 @@ protected function execute(InputInterface $input, OutputInterface $output)
 
 .. code-block:: bash
 
-    $ export PATH="$PATH:$HOME/.composer/vendor/bin"
+    $ export PATH="\$PATH:\$HOME/.composer/vendor/bin"
 
-Globally (homebrew)
-~~~~~~~~~~~~~~~~~~~
+{$this->header('Globally (homebrew)', '~')}
 
 .. code-block:: bash
 
     $ brew install php-cs-fixer
 
-Locally (PHIVE)
-~~~~~~~~~~~~~~~
+{$this->header('Locally (PHIVE)', '~')}
 
 Install `PHIVE <https://phar.io>`_ and issue the following command:
 
 .. code-block:: bash
 
     $ phive install php-cs-fixer # use `--global` for global install
 
-Update
-------
+{$this->header('Update', '-')}
 
-Locally
-~~~~~~~
+{$this->header('Locally', '~')}
 
 The ``self-update`` command tries to update ``php-cs-fixer`` itself:
 
 .. code-block:: bash
 
     $ php php-cs-fixer.phar self-update
 
-Globally (manual)
-~~~~~~~~~~~~~~~~~
+{$this->header('Globally (manual)', '~')}
 
 You can update ``php-cs-fixer`` through this command:
 
 .. code-block:: bash
 
     $ sudo php-cs-fixer self-update
 
-Globally (Composer)
-~~~~~~~~~~~~~~~~~~~
+{$this->header('Globally (Composer)', '~')}
 
 You can update ``php-cs-fixer`` through this command:
 
 .. code-block:: bash
 
     $ ./composer.phar global update friendsofphp/php-cs-fixer
 
-Globally (homebrew)
-~~~~~~~~~~~~~~~~~~~
+{$this->header('Globally (homebrew)', '~')}
 
 You can update ``php-cs-fixer`` through this command:
 
 .. code-block:: bash
 
     $ brew upgrade php-cs-fixer
 
-Locally (PHIVE)
-~~~~~~~~~~~~~~~~~~~
+{$this->header('Locally (PHIVE)', '~')}
 
 .. code-block:: bash
 
     $ phive update php-cs-fixer
 
-Usage
------
+{$this->header('Usage', '-')}
 
 EOF;
 
-        $footer = <<<'EOF'
+        $footer = <<<EOF
 
-Helpers
--------
+{$this->header('Helpers', '-')}
 
 Dedicated plugins exist for:
 
@@ -202,20 +186,17 @@ protected function execute(InputInterface $input, OutputInterface $output)
 * `Vim`_
 * `VS Code`_
 
-Contribute
-----------
+{$this->header('Contribute', '-')}
 
 The tool comes with quite a few built-in fixers, but everyone is more than
 welcome to `contribute`_ more of them.
 
-Fixers
-~~~~~~
+{$this->header('Fixers', '~')}
 
 A *fixer* is a class that tries to fix one CS issue (a ``Fixer`` class must
 implement ``FixerInterface``).
 
-Configs
-~~~~~~~
+{$this->header('Configs', '~')}
 
 A *config* knows about the CS rules and the files and directories that must be
 scanned by the tool when run in the directory of your project. It is useful for
@@ -290,4 +271,9 @@ static function (array $matches) {
 
         return 0;
     }
+
+    private function header($name, $underline)
+    {
+        return $name."\n".str_repeat($underline, \strlen($name));
+    }
 }

tests/Console/Command/ReadmeCommandTest.php

@@ -13,6 +13,7 @@
 namespace PhpCsFixer\Tests\Console\Command;
 
 use PhpCsFixer\Console\Application;
+use PhpCsFixer\Console\Command\ReadmeCommand;
 use PhpCsFixer\Tests\TestCase;
 use Symfony\Component\Console\Tester\CommandTester;
 
@@ -55,4 +56,13 @@ public function testIfReadmeFileIsCorrect()
             'README.rst file is not up to date! Do not modify it manually! Regenerate readme with command: `php php-cs-fixer readme > README.rst`.'
         );
     }
+
+    public function testCodeNotHaveUnderlinishStyleOfHeaders()
+    {
+        static::assertNotRegExp(
+            '/([^\s])\1{4,}/',
+            file_get_contents((new \ReflectionClass(ReadmeCommand::class))->getFileName()),
+            'Five same characters in row found'
+        );
+    }
 }