[TASK] Take .editorconfig into account

Resolves: #6215
rectorphp · May 1, 2021 · 9695171 · 9695171
1 parent 37e0776
commit 9695171
Show file tree

Hide file tree

Showing 18 changed files with 794 additions and 3 deletions.
diff --git a/composer.json b/composer.json
@@ -32,6 +32,8 @@
         "composer/xdebug-handler": "^1.4|^2.0",
         "danielstjules/stringy": "^3.1",
         "doctrine/inflector": "^2.0",
+        "ergebnis/json-printer": "^3.1",
+        "idiosyncratic/editorconfig": "dev-master",
         "jean85/pretty-package-versions": "^1.6",
         "nette/caching": "^3.1",
         "nette/robot-loader": "^3.4",
@@ -63,8 +65,8 @@
         "symplify/skipper": "^9.3",
         "symplify/smart-file-system": "^9.3",
         "symplify/symfony-php-config": "^9.3",
-        "webmozart/assert": "^1.10",
-        "tracy/tracy": "^2.8"
+        "tracy/tracy": "^2.8",
+        "webmozart/assert": "^1.10"
     },
     "require-dev": {
         "friendsofphp/php-cs-fixer": "^2.18.6",
@@ -155,5 +157,7 @@
     "config": {
         "sort-packages": true,
         "platform-check": false
-    }
+    },
+    "minimum-stability": "dev",
+    "prefer-stable": true
 }
diff --git a/config/services.php b/config/services.php
@@ -5,6 +5,8 @@
 use Composer\Semver\VersionParser;
 use Doctrine\Inflector\Inflector;
 use Doctrine\Inflector\Rules\English\InflectorFactory;
+use Ergebnis\Json\Printer\Printer;
+use Idiosyncratic\EditorConfig\EditorConfig;
 use Nette\Caching\Cache;
 use PhpParser\BuilderFactory;
 use PhpParser\Lexer;
@@ -25,6 +27,8 @@
 use Rector\BetterPhpDocParser\PhpDocParser\BetterTypeParser;
 use Rector\Caching\Cache\NetteCacheFactory;
 use Rector\Core\Console\ConsoleApplication;
+use Rector\Core\Contract\EditorConfig\EditorConfigParserInterface;
+use Rector\Core\EditorConfig\EditorConfigIdiosyncraticParser;
 use Rector\Core\PhpParser\Parser\NikicPhpParserFactory;
 use Rector\Core\PhpParser\Parser\PhpParserLexerFactory;
 use Rector\NodeTypeResolver\DependencyInjection\PHPStanServicesFactory;
@@ -142,4 +146,8 @@
         ->factory([service(PHPStanServicesFactory::class), 'createTypeNodeResolver']);
     $services->set(DynamicSourceLocatorProvider::class)
         ->factory([service(PHPStanServicesFactory::class), 'createDynamicSourceLocatorProvider']);
+
+    $services->set(Printer::class);
+    $services->set(EditorConfig::class);
+    $services->alias(EditorConfigParserInterface::class, EditorConfigIdiosyncraticParser::class);
 };
diff --git a/phpstan.neon b/phpstan.neon
@@ -447,6 +447,8 @@ parameters:
         - '#Method Rector\\Core\\Tests\\DependencyInjection\\ConfigurableRectorImportConfigCallsMergeTest\:\:provideData\(\) return type has no value type specified in iterable type Iterator#'
         - '#Class with base "PhpVersion" name is already used in "PHPStan\\Php\\PhpVersion", "Rector\\Core\\ValueObject\\PhpVersion"\. Use unique name to make classes easy to recognize#'
 
+        - '#Method Rector\\Core\\Tests\\Formatter\\JsonFormatter\\JsonFormatterTest\:\:provideData\(\) return type has no value type specified in iterable type Iterator#'
+
         -
             message: '#Use dependency injection instead of dependency juggling#'
             path: src/HttpKernel/RectorKernel.php

diff --git a/src/Application/ApplicationFileProcessor.php b/src/Application/ApplicationFileProcessor.php
@@ -32,19 +32,26 @@ final class ApplicationFileProcessor
      */
     private $fileDiffFileDecorator;
 
+    /**
+     * @var FileFormatter
+     */
+    private $fileFormatter;
+
     /**
      * @param FileProcessorInterface[] $fileProcessors
      */
     public function __construct(
         Configuration $configuration,
         SmartFileSystem $smartFileSystem,
         FileDiffFileDecorator $fileDiffFileDecorator,
+        FileFormatter $fileFormatter,
         array $fileProcessors = []
     ) {
         $this->fileProcessors = $fileProcessors;
         $this->smartFileSystem = $smartFileSystem;
         $this->configuration = $configuration;
         $this->fileDiffFileDecorator = $fileDiffFileDecorator;
+        $this->fileFormatter = $fileFormatter;
     }
 
     /**
@@ -54,6 +61,8 @@ public function run(array $files): void
     {
         $this->processFiles($files);
 
+        $this->fileFormatter->format($files);
+
         $this->fileDiffFileDecorator->decorate($files);
 
         $this->printFiles($files);

diff --git a/src/Application/FileFormatter.php b/src/Application/FileFormatter.php
@@ -0,0 +1,56 @@
+<?php
+declare(strict_types=1);
+
+namespace Rector\Core\Application;
+
+use Rector\Core\Contract\EditorConfig\EditorConfigParserInterface;
+use Rector\Core\Contract\Formatter\FormatterInterface;
+use Rector\Core\ValueObject\Application\File;
+
+final class FileFormatter
+{
+    /**
+     * @var EditorConfigParserInterface
+     */
+    private $editorConfigParser;
+
+    /**
+     * @var FormatterInterface[]
+     */
+    private $fileFormatters;
+
+    /**
+     * @param FormatterInterface[] $fileFormatters
+     */
+    public function __construct(EditorConfigParserInterface $editorConfigParser, array $fileFormatters = [])
+    {
+        $this->editorConfigParser = $editorConfigParser;
+        $this->fileFormatters = $fileFormatters;
+    }
+
+    /**
+     * @param File[] $files
+     */
+    public function format(array $files): void
+    {
+        foreach ($files as $file) {
+
+            if (! $file->hasChanged()) {
+                continue;
+            }
+
+            foreach ($this->fileFormatters as $fileFormatter) {
+                if (! $fileFormatter->supports($file)) {
+                    continue;
+                }
+
+                $editorConfiguration = $this->editorConfigParser->extractConfigurationForFile(
+                    $file,
+                    $fileFormatter->createEditorConfigConfigurationBuilder()
+                );
+
+                $fileFormatter->format($file, $editorConfiguration);
+            }
+        }
+    }
+}
diff --git a/src/Contract/EditorConfig/EditorConfigParserInterface.php b/src/Contract/EditorConfig/EditorConfigParserInterface.php
@@ -0,0 +1,40 @@
+<?php
+
+namespace Rector\Core\Contract\EditorConfig;
+
+use Rector\Core\ValueObject\Application\File;
+use Rector\Core\ValueObject\EditorConfigConfiguration;
+use Rector\Core\ValueObjectFactory\EditorConfigConfigurationBuilder;
+
+interface EditorConfigParserInterface
+{
+    /**
+     * @var string
+     */
+    public const INDENT_STYLE = 'indent_style';
+
+    /**
+     * @var string
+     */
+    public const INDENT_SIZE = 'indent_size';
+
+    /**
+     * @var string
+     */
+    public const END_OF_LINE = 'end_of_line';
+
+    /**
+     * @var string
+     */
+    public const INSERT_FINAL_NEWLINE = 'insert_final_newline';
+
+    /**
+     * @var string
+     */
+    public const TAB_WIDTH = 'tab_width';
+
+    public function extractConfigurationForFile(
+        File $file,
+        EditorConfigConfigurationBuilder $editorConfigConfigurationBuilder
+    ): EditorConfigConfiguration;
+}
diff --git a/src/Contract/Formatter/FormatterInterface.php b/src/Contract/Formatter/FormatterInterface.php
@@ -0,0 +1,16 @@
+<?php
+
+namespace Rector\Core\Contract\Formatter;
+
+use Rector\Core\ValueObject\Application\File;
+use Rector\Core\ValueObject\EditorConfigConfiguration;
+use Rector\Core\ValueObjectFactory\EditorConfigConfigurationBuilder;
+
+interface FormatterInterface
+{
+    public function supports(File $file): bool;
+
+    public function format(File $file, EditorConfigConfiguration $editorConfigConfiguration): void;
+
+    public function createEditorConfigConfigurationBuilder(): EditorConfigConfigurationBuilder;
+}
diff --git a/src/EditorConfig/EditorConfigIdiosyncraticParser.php b/src/EditorConfig/EditorConfigIdiosyncraticParser.php
@@ -0,0 +1,58 @@
+<?php
+declare(strict_types=1);
+
+namespace Rector\Core\EditorConfig;
+
+use Idiosyncratic\EditorConfig\EditorConfig;
+use Rector\Core\Contract\EditorConfig\EditorConfigParserInterface;
+use Rector\Core\ValueObject\Application\File;
+use Rector\Core\ValueObject\EditorConfigConfiguration;
+use Rector\Core\ValueObjectFactory\EditorConfigConfigurationBuilder;
+
+/**
+ * @see \Rector\Core\Tests\EditorConfig\EditorConfigIdiosyncraticParser\EditorConfigIdiosyncraticParserTest
+ */
+final class EditorConfigIdiosyncraticParser implements EditorConfigParserInterface
+{
+    /**
+     * @var EditorConfig
+     */
+    private $editorConfig;
+
+    public function __construct(EditorConfig $editorConfig)
+    {
+        $this->editorConfig = $editorConfig;
+    }
+
+    public function extractConfigurationForFile(
+        File $file,
+        EditorConfigConfigurationBuilder $editorConfigConfigurationBuilder
+    ): EditorConfigConfiguration {
+        $smartFileInfo = $file->getSmartFileInfo();
+        $configuration = $this->editorConfig->getConfigForPath($smartFileInfo->getRealPath());
+
+        if (array_key_exists(self::INDENT_STYLE, $configuration)) {
+            $editorConfigConfigurationBuilder->withIndentStyle($configuration[self::INDENT_STYLE]->getValue());
+        }
+
+        if (array_key_exists(self::INDENT_SIZE, $configuration)) {
+            $editorConfigConfigurationBuilder->withIndentSize($configuration[self::INDENT_SIZE]->getValue());
+        }
+
+        if (array_key_exists(self::END_OF_LINE, $configuration)) {
+            $editorConfigConfigurationBuilder->withEndOfLine($configuration[self::END_OF_LINE]->getValue());
+        }
+
+        if (array_key_exists(self::INSERT_FINAL_NEWLINE, $configuration)) {
+            $editorConfigConfigurationBuilder->withInsertFinalNewline(
+                $configuration[self::INSERT_FINAL_NEWLINE]->getValue()
+            );
+        }
+
+        if (array_key_exists(self::TAB_WIDTH, $configuration)) {
+            $editorConfigConfigurationBuilder->withTabWidth($configuration[self::TAB_WIDTH]->getValue());
+        }
+
+        return $editorConfigConfigurationBuilder->build();
+    }
+}
diff --git a/src/Exception/EditorConfigConfigurationException.php b/src/Exception/EditorConfigConfigurationException.php
@@ -0,0 +1,10 @@
+<?php
+declare(strict_types=1);
+
+namespace Rector\Core\Exception;
+
+use InvalidArgumentException;
+
+final class EditorConfigConfigurationException extends InvalidArgumentException
+{
+}
diff --git a/src/Formatter/JsonFormatter.php b/src/Formatter/JsonFormatter.php
@@ -0,0 +1,57 @@
+<?php
+declare(strict_types=1);
+
+namespace Rector\Core\Formatter;
+
+use Ergebnis\Json\Printer\Printer;
+use Rector\Core\Contract\Formatter\FormatterInterface;
+use Rector\Core\ValueObject\Application\File;
+use Rector\Core\ValueObject\EditorConfigConfiguration;
+use Rector\Core\ValueObjectFactory\EditorConfigConfigurationBuilder;
+
+/**
+ * @see \Rector\Core\Tests\Formatter\JsonFormatter\JsonFormatterTest
+ */
+final class JsonFormatter implements FormatterInterface
+{
+    /**
+     * @var Printer
+     */
+    private $jsonPrinter;
+
+    public function __construct(Printer $jsonPrinter)
+    {
+        $this->jsonPrinter = $jsonPrinter;
+    }
+
+    public function supports(File $file): bool
+    {
+        $smartFileInfo = $file->getSmartFileInfo();
+
+        return in_array($smartFileInfo->getExtension(), ['json'], true);
+    }
+
+    public function format(File $file, EditorConfigConfiguration $editorConfigConfiguration): void
+    {
+        $newContent = $this->jsonPrinter->print(
+            $file->getFileContent(),
+            $editorConfigConfiguration->getIndent(),
+            $editorConfigConfiguration->getEndOfLine()
+        );
+
+        $newContent .= $editorConfigConfiguration->getFinalNewline();
+
+        $file->changeFileContent($newContent);
+    }
+
+    public function createEditorConfigConfigurationBuilder(): EditorConfigConfigurationBuilder
+    {
+        $editorConfigConfigurationBuilder = EditorConfigConfigurationBuilder::anEditorConfigConfiguration();
+        $editorConfigConfigurationBuilder->withLineFeed();
+        $editorConfigConfigurationBuilder->withSpace();
+        $editorConfigConfigurationBuilder->withIndentSize(4);
+        $editorConfigConfigurationBuilder->withFinalNewline();
+
+        return $editorConfigConfigurationBuilder;
+    }
+}