[Feature] autofixer (#337)

* Autofix sniffs

* Exclude Typehint declaration on custom sniff to avoid breaking compatibility

* Autofix issues from php-cs-fixer

* Set concrete configuration class in testCase

* Add fix composer script

* Clear command definition and add definition for fix command

* Add display output for fix

* Add fix command

* Exclude weird rules with phpstan in ConfigResolver

* Display fixed insights with PhpCsFixer

* Update some suppressWarnings

* Use errorOutput to display hint message

* Add docs

* Add tests to assert fix work as expected

* Create a DefinitionBinder

* Enable fix option for laravel

* Always show recap of fixed issues

* Change description for fix option

Co-Authored-By: Oliver Nybroe <[email protected]>

* Fix after merges

* Increase .phpcs memory_limit override

* Add total fixed in Json Formatter

* Update src/Application/Adapters/Laravel/Commands/InsightsCommand.php

Co-Authored-By: Oliver Nybroe <[email protected]>

* Configuration : update function to know if fix is enabled

* Change enableFix function in File

* Create a trait FixPerFileCollector and use it in SniffDecorator and FixerDecorator

* Fix fixture for test SniffDecorator Fix

Co-authored-by: Oliver Nybroe <[email protected]>

Author: Jibbarth

.phpcs.xml.dist

@@ -14,7 +14,7 @@
     <arg name="colors"/>
     <arg name="parallel" value="75"/>
     <arg value="p"/>
-    <ini name="memory_limit" value="128M"/>
+    <ini name="memory_limit" value="512M"/>
 
     <!-- Configs -->
     <config name="installed_paths" value="vendor/slevomat/coding-standard"/>

composer.json

@@ -80,6 +80,10 @@
             "@phpunit:test",
             "@insights"
         ],
+        "fix": [
+            "@ecs:test --fix",
+            "@insights --fix --quiet"
+        ],
         "post-install-cmd": [
             "@website:copy-changelog",
             "@website:copy-logo"
@@ -96,6 +100,7 @@
         "phpstan:test": "Run the phpstan tests.",
         "phpunit:test": "Run the phpunit tests.",
         "insights": "Run the phpinsights tests",
-        "test": "Run all tests including phpstan, phpunit and ecs."
+        "test": "Run all tests including phpstan, phpunit and ecs.",
+        "fix": "Run ecs and phpinsights fixers."
     }
 }

config/routes/console.php

@@ -3,8 +3,10 @@
 declare(strict_types=1);
 
 use NunoMaduro\PhpInsights\Application\Console\Commands\AnalyseCommand;
+use NunoMaduro\PhpInsights\Application\Console\Commands\FixCommand;
 use NunoMaduro\PhpInsights\Application\Console\Commands\InvokableCommand;
 use NunoMaduro\PhpInsights\Application\Console\Definitions\AnalyseDefinition;
+use NunoMaduro\PhpInsights\Application\Console\Definitions\FixDefinition;
 
 return (static function (): array {
     $container = require dirname(__DIR__) . DIRECTORY_SEPARATOR . 'container.php';
@@ -15,7 +17,14 @@
         AnalyseDefinition::get()
     );
 
+    $fixCommand = new InvokableCommand(
+        'fix',
+        $container->get(FixCommand::class),
+        FixDefinition::get()
+    );
+
     return [
         $analyseCommand,
+        $fixCommand,
     ];
 })();

docs/get-started.md

@@ -76,6 +76,25 @@ In laravel, launch command as usual with your path:
 php artisan insights path/to/analyse
 ```
 
+## Fixing errors automatically <Badge text="^2.0"/>
+
+Some Insights support automatic fixing. 
+To fix your code automatically, two way are possibles: 
+
+* Add `--fix` option to your command. The output will be the classical output, with a resume of all issues fixed.
+* Or launch `phpinsights fix [directory]`
+
+```bash
+# Classical command with --fix option
+vendor/bin/phpinsights analyse path/to/analyse --fix
+
+# In laravel
+php artisan insights path/to/analyse --fix
+
+# Just fix
+vendor/bin/phpinsights fix path/to/analyse
+```
+
 ## Analyse multiple paths <Badge text="^2.0"/>
 You can ask `phpinsights` to analyse multiple directories, multiple files or even combining them by providing multiple paths with `analyse` command:
 

phpinsights.php

@@ -3,11 +3,13 @@
 declare(strict_types=1);
 
 use NunoMaduro\PhpInsights\Domain\Insights\ForbiddenDefineGlobalConstants;
+use NunoMaduro\PhpInsights\Domain\Insights\ForbiddenTraits;
 use NunoMaduro\PhpInsights\Domain\Sniffs\ForbiddenSetterSniff;
 use PHP_CodeSniffer\Standards\Generic\Sniffs\CodeAnalysis\EmptyStatementSniff;
 use PHP_CodeSniffer\Standards\Generic\Sniffs\Files\LineLengthSniff;
 use PHP_CodeSniffer\Standards\Generic\Sniffs\PHP\NoSilencedErrorsSniff;
 use SlevomatCodingStandard\Sniffs\Functions\UnusedParameterSniff;
+use SlevomatCodingStandard\Sniffs\TypeHints\DisallowArrayTypeHintSyntaxSniff;
 use SlevomatCodingStandard\Sniffs\TypeHints\DisallowMixedTypeHintSniff;
 
 return [
@@ -60,6 +62,12 @@
             'exclude' => [
                 'src/Domain/Reflection.php',
                 'src/Domain/Details.php',
+                'src/Application/ConfigResolver.php',
+            ],
+        ],
+        DisallowArrayTypeHintSyntaxSniff::class => [
+            'exclude' => [
+                'src/Application/ConfigResolver.php',
             ],
         ],
         ForbiddenSetterSniff::class => [
@@ -90,6 +98,11 @@
                 'src/Domain/FileProcessors/FixerFileProcessor.php',
             ],
         ],
+        ForbiddenTraits::class => [
+            'exclude' => [
+                'src/Domain/Insights/FixPerFileCollector.php',
+            ],
+        ],
     ],
 
     /*

phpstan.neon.dist

@@ -42,6 +42,7 @@ parameters:
             path: src/Domain/Reflection.php
         - '#NunoMaduro\\PhpInsights\\Domain\\File::addFixableError#'
         - '#iterable type PhpCsFixer\\Tokenizer\\Tokens#'
+        - '#Method NunoMaduro\\PhpInsights\\Application\\Console\\Definitions\\BaseDefinition::get\(\) is not final#'
     autoload_files:
         - %rootDir%/../../squizlabs/php_codesniffer/autoload.php
     reportUnmatchedIgnoredErrors: false

schema.json

@@ -67,6 +67,10 @@
                 "security issues": {
                     "type": "integer",
                     "minimum": 0
+                },
+                "fixed issues": {
+                    "type": "integer",
+                    "minimum": 0
                 }
             }
         },

src/Application/Adapters/Laravel/Commands/InsightsCommand.php

@@ -12,6 +12,7 @@
 use NunoMaduro\PhpInsights\Domain\Container;
 use NunoMaduro\PhpInsights\Domain\Kernel;
 use NunoMaduro\PhpInsights\Domain\Reflection;
+use Symfony\Component\Console\Output\ConsoleOutputInterface;
 
 /**
  * @internal
@@ -36,6 +37,7 @@ public function handle(): int
         }
 
         $configuration = require $configPath;
+        $configuration['fix'] = $this->hasOption('fix') && (bool) $this->option('fix') === true;
         $configuration = ConfigResolver::resolve($configuration, $this->input);
 
         $container = Container::make();
@@ -49,7 +51,14 @@ public function handle(): int
         $analyseCommand = $container->get(AnalyseCommand::class);
 
         $output = (new Reflection($this->output))->get('output');
-        return $analyseCommand->__invoke($this->input, $output);
+
+        $result = $analyseCommand->__invoke($this->input, $output);
+
+        if ($output instanceof ConsoleOutputInterface) {
+            $output->getErrorOutput()->writeln('✨ See something that needs to be improved? <options=bold>Create an issue</> or send us a <options=bold>pull request</>: <fg=cyan;options=bold>https://github.com/nunomaduro/phpinsights</>');
+        }
+
+        return $result;
     }
 
     public function configure(): void

src/Application/Console/Commands/AnalyseCommand.php

@@ -97,7 +97,6 @@ public function __invoke(InputInterface $input, OutputInterface $output): int
         }
 
         $consoleStyle->newLine();
-        $consoleStyle->writeln('✨ See something that needs to be improved? <bold>Create an issue</bold> or send us a <bold>pull request</bold>: <title>https://github.com/nunomaduro/phpinsights</title>');
 
         return (int) $hasError;
     }

src/Application/Console/Commands/FixCommand.php

@@ -0,0 +1,42 @@
+<?php
+
+declare(strict_types=1);
+
+namespace NunoMaduro\PhpInsights\Application\Console\Commands;
+
+use NunoMaduro\PhpInsights\Application\Console\Formatters\Console;
+use NunoMaduro\PhpInsights\Application\Console\OutputDecorator;
+use NunoMaduro\PhpInsights\Domain\Insights\InsightCollectionFactory;
+use NunoMaduro\PhpInsights\Domain\MetricsFinder;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+/**
+ * @internal
+ */
+final class FixCommand
+{
+    /**
+     * @var \NunoMaduro\PhpInsights\Domain\Insights\InsightCollectionFactory
+     */
+    private $collectionFactory;
+
+    public function __construct(
+        InsightCollectionFactory $collectionFactory
+    ) {
+        $this->collectionFactory = $collectionFactory;
+    }
+
+    public function __invoke(InputInterface $input, OutputInterface $output): int
+    {
+        $metrics = MetricsFinder::find();
+        $collection = $this->collectionFactory->get($metrics, $output);
+
+        $output = OutputDecorator::decorate($output);
+        $formatter = new Console($input, $output);
+
+        $formatter->formatFix($collection, $metrics);
+
+        return 0;
+    }
+}

src/Application/Console/Commands/InvokableCommand.php

@@ -7,6 +7,7 @@
 use Symfony\Component\Console\Command\Command as BaseCommand;
 use Symfony\Component\Console\Input\InputDefinition;
 use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\ConsoleOutputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 
 final class InvokableCommand extends BaseCommand
@@ -34,6 +35,12 @@ public function __construct(string $name, callable $callable, InputDefinition $d
 
     public function execute(InputInterface $input, OutputInterface $output): int
     {
-        return call_user_func($this->callable, $input, $output);
+        $result = call_user_func($this->callable, $input, $output);
+
+        if ($output instanceof ConsoleOutputInterface) {
+            $output->getErrorOutput()->writeln('✨ See something that needs to be improved? <options=bold>Create an issue</> or send us a <options=bold>pull request</>: <fg=cyan;options=bold>https://github.com/nunomaduro/phpinsights</>');
+        }
+
+        return $result;
     }
 }

src/Application/Console/Definitions/AnalyseDefinition.php

@@ -4,29 +4,18 @@
 
 namespace NunoMaduro\PhpInsights\Application\Console\Definitions;
 
-use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputDefinition;
 use Symfony\Component\Console\Input\InputOption;
 
 /**
  * @internal
  */
-final class AnalyseDefinition
+final class AnalyseDefinition extends BaseDefinition
 {
     public static function get(): InputDefinition
     {
-        return new InputDefinition([
-            new InputArgument(
-                'paths',
-                InputArgument::OPTIONAL | InputArgument::IS_ARRAY,
-                'Paths of directories or files to analyse'
-            ),
-            new InputOption(
-                'config-path',
-                'c',
-                InputOption::VALUE_OPTIONAL,
-                'The configuration file path'
-            ),
+        $definition = parent::get();
+        $definition->addOptions([
             new InputOption(
                 'min-quality',
                 null,
@@ -74,6 +63,14 @@ public static function get(): InputDefinition
                 InputOption::VALUE_OPTIONAL,
                 'The composer file path'
             ),
+            new InputOption(
+                'fix',
+                null,
+                InputOption::VALUE_NONE,
+                'Enable auto-fix for fixable insights'
+            ),
         ]);
+
+        return $definition;
     }
 }

src/Application/Console/Definitions/BaseDefinition.php

@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+namespace NunoMaduro\PhpInsights\Application\Console\Definitions;
+
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputDefinition;
+use Symfony\Component\Console\Input\InputOption;
+
+/**
+ * Minimum definition for each of our commands.
+ *
+ * @internal
+ */
+abstract class BaseDefinition
+{
+    public static function get(): InputDefinition
+    {
+        return new InputDefinition([
+            new InputArgument(
+                'paths',
+                InputArgument::OPTIONAL | InputArgument::IS_ARRAY,
+                'Paths of directories or files to analyse'
+            ),
+            new InputOption(
+                'config-path',
+                'c',
+                InputOption::VALUE_OPTIONAL,
+                'The configuration file path'
+            ),
+        ]);
+    }
+}

src/Application/Console/Definitions/DefinitionBinder.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace NunoMaduro\PhpInsights\Application\Console\Definitions;
+
+use Symfony\Component\Console\Application;
+use Symfony\Component\Console\Input\InputInterface;
+
+/**
+ * @internal
+ */
+final class DefinitionBinder
+{
+    public static function bind(InputInterface $input): void
+    {
+        // merge application default definition with current command definition.
+        $definition = (new Application())->getDefinition();
+
+        $commandDefinition = BaseDefinition::get();
+        if ($input->getFirstArgument() !== 'fix') {
+            $commandDefinition = AnalyseDefinition::get();
+        }
+
+        $definition->addArguments($commandDefinition->getArguments());
+        $definition->addOptions($commandDefinition->getOptions());
+
+        $input->bind($definition);
+    }
+}

src/Application/Console/Definitions/FixDefinition.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace NunoMaduro\PhpInsights\Application\Console\Definitions;
+
+/**
+ * @internal
+ */
+final class FixDefinition extends BaseDefinition
+{
+}