Merge pull request #12 from worksome/feature/php-cs-fixer

feat: add standardised docblock alignment

README.md

@@ -3,7 +3,7 @@
 # Worksomes Coding Style
 This repository contains the coding style followed by Worksome.
 
-It includes configuration for `phpcs`, `phpstan` and `rector`.
+It includes configuration for `php-cs-fixer`, `phpcs`, `phpstan` and `rector`.
 
 ## Setup
 Install this composer package
@@ -21,6 +21,8 @@ Add the following section to your `composer.json` file
 ```json
 "scripts": {
     "phpcs": "vendor/bin/phpcs",
+    "php-cs-fixer": "vendor/bin/php-cs-fixer fix --ansi",
+    "php-cs-fixer-ci": "vendor/bin/php-cs-fixer fix --dry-run --ansi",
     "phpcbf": "vendor/bin/phpcbf",
     "phpstan": "vendor/bin/phpstan analyse",
     "rector-ci": "vendor/bin/rector process --dry-run --ansi",
@@ -33,6 +35,7 @@ Add the following section to your `composer.json` file
 For using it simply run one of the scripts added to composer.
 ```
 $ composer phpcs
+$ composer php-cs-fixer
 $ composer phpstan
 $ composer rector-ci
 ```

composer.json

@@ -9,7 +9,8 @@
         "nunomaduro/larastan": "^1.0 || ^2.0",
         "rector/rector": "^0.12.0",
         "jetbrains/phpstorm-attributes": "^1.0",
-        "phpstan/phpstan-mockery": "^1.0"
+        "phpstan/phpstan-mockery": "^1.0",
+        "friendsofphp/php-cs-fixer": "^3.8"
     },
     "require-dev": {
         "composer/composer": "^2.0",

src/GenerateCommand.php

@@ -18,6 +18,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
         $output->writeln("Worksome's Coding style has 3 stub files (phpcs, phpstan and rector)");
 
         $files = [
+            '.php-cs-fixer.dist.php' => __DIR__ . '/../stubs/php-cs-fixer.dist.php.stub',
             'phpcs.xml' => __DIR__ . '/../stubs/phpcs.xml.stub',
             'phpstan.neon' => __DIR__ . '/../stubs/phpstan.neon.stub',
             'rector.php' => __DIR__ . '/../stubs/rector.php.stub',
@@ -37,11 +38,15 @@ protected function execute(InputInterface $input, OutputInterface $output)
         $this->getComposer()->getConfig()->merge([
             'scripts' => [
                 "phpcs" => "vendor/bin/phpcs",
+                "php-cs-fixer" => "vendor/bin/php-cs-fixer fix --ansi",
+                "php-cs-fixer-ci" => "vendor/bin/php-cs-fixer fix --dry-run --ansi",
                 "phpcbf" => "vendor/bin/phpcbf",
                 "phpstan" => "vendor/bin/phpstan analyse",
                 "rector-ci" => "vendor/bin/rector process --dry-run --ansi",
                 "rector" => "vendor/bin/rector process --ansi",
             ]
         ]);
+
+        return 0;
     }
 }

src/PhpCsFixerConfig.php

@@ -0,0 +1,43 @@
+<?php
+
+namespace Worksome\CodingStyle;
+
+use PhpCsFixer\Config;
+use PhpCsFixer\ConfigInterface;
+
+class PhpCsFixerConfig extends Config
+{
+    const RULE_DEFINITIONS = [
+        '@worksome' => [
+            'phpdoc_align' => [
+                'align' => 'vertical',
+            ],
+            'phpdoc_separation' => true,
+        ],
+        '@worksome:risky' => [
+            // ...
+        ],
+    ];
+
+    public function __construct()
+    {
+        parent::__construct('Worksome');
+    }
+
+    public static function make(): self
+    {
+        return new self();
+    }
+
+    public function setRules(array $rules): ConfigInterface
+    {
+        foreach (array_keys(self::RULE_DEFINITIONS) as $key) {
+            if (($rules[$key] ?? false)) {
+                unset($rules[$key]);
+                $rules = array_merge(self::RULE_DEFINITIONS[$key], $rules);
+            }
+        }
+
+        return parent::setRules($rules);
+    }
+}

stubs/php-cs-fixer.dist.php.stub

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+use PhpCsFixer\Finder;
+use Worksome\CodingStyle\PhpCsFixerConfig;
+
+require __DIR__.'/vendor/autoload.php';
+
+$finder = Finder::create()
+    ->in(__DIR__.'/app')
+    ->in(__DIR__.'/tests')
+    ->in(__DIR__.'/config');
+
+return PhpCsFixerConfig::make()
+    ->setFinder($finder)
+    ->setRules([
+        '@worksome' => true,
+        '@worksome:risky' => true,
+    ])
+    ->setRiskyAllowed(true);