[make:*] use php-cs-fixer to style/lint all generated php templates (#1251)

Author: jrushlow

composer.json

@@ -23,7 +23,8 @@
         "symfony/filesystem": "^5.4.7|^6.0",
         "symfony/finder": "^5.4.3|^6.0",
         "symfony/framework-bundle": "^5.4.7|^6.0",
-        "symfony/http-kernel": "^5.4.7|^6.0"
+        "symfony/http-kernel": "^5.4.7|^6.0",
+        "symfony/process": "^5.4.7|^6.0"
     },
     "require-dev": {
         "composer/semver": "^3.0",
@@ -32,7 +33,6 @@
         "symfony/http-client": "^5.4.7|^6.0",
         "symfony/phpunit-bridge": "^5.4.7|^6.0",
         "symfony/polyfill-php80": "^1.16.0",
-        "symfony/process": "^5.4.7|^6.0",
         "symfony/security-core": "^5.4.7|^6.0",
         "symfony/yaml": "^5.4.3|^6.0",
         "twig/twig": "^2.0|^3.0"

src/Command/MakerCommand.php

@@ -19,6 +19,7 @@
 use Symfony\Bundle\MakerBundle\Generator;
 use Symfony\Bundle\MakerBundle\InputConfiguration;
 use Symfony\Bundle\MakerBundle\MakerInterface;
+use Symfony\Bundle\MakerBundle\Util\TemplateLinter;
 use Symfony\Bundle\MakerBundle\Validator;
 use Symfony\Component\Console\Application;
 use Symfony\Component\Console\Command\Command;
@@ -36,8 +37,12 @@ final class MakerCommand extends Command
     private ConsoleStyle $io;
     private bool $checkDependencies = true;
 
-    public function __construct(private MakerInterface $maker, private FileManager $fileManager, private Generator $generator)
-    {
+    public function __construct(
+        private MakerInterface $maker,
+        private FileManager $fileManager,
+        private Generator $generator,
+        private TemplateLinter $linter,
+    ) {
         $this->inputConfig = new InputConfiguration();
 
         parent::__construct();
@@ -90,13 +95,19 @@ protected function interact(InputInterface $input, OutputInterface $output): voi
 
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
+        if ($output->isVerbose()) {
+            $this->linter->writeLinterMessage($output);
+        }
+
         $this->maker->generate($input, $this->io, $this->generator);
 
         // sanity check for custom makers
         if ($this->generator->hasPendingOperations()) {
             throw new \LogicException('Make sure to call the writeChanges() method on the generator.');
         }
 
+        $this->linter->lintFiles($this->generator->getGeneratedFiles());
+
         return 0;
     }
 

src/Generator.php

@@ -26,6 +26,7 @@ class Generator
     private GeneratorTwigHelper $twigHelper;
     private array $pendingOperations = [];
     private ?TemplateComponentGenerator $templateComponentGenerator;
+    private array $generatedFiles = [];
 
     public function __construct(
         private FileManager $fileManager,
@@ -74,6 +75,8 @@ public function generateClass(string $className, string $templateName, array $va
 
     /**
      * Generate a normal file from a template.
+     *
+     * @return void
      */
     public function generateFile(string $targetPath, string $templateName, array $variables = [])
     {
@@ -84,6 +87,9 @@ public function generateFile(string $targetPath, string $templateName, array $va
         $this->addOperation($targetPath, $templateName, $variables);
     }
 
+    /**
+     * @return void
+     */
     public function dumpFile(string $targetPath, string $contents)
     {
         $this->pendingOperations[$targetPath] = [
@@ -160,29 +166,6 @@ public function getRootDirectory(): string
         return $this->fileManager->getRootDirectory();
     }
 
-    private function addOperation(string $targetPath, string $templateName, array $variables): void
-    {
-        if ($this->fileManager->fileExists($targetPath)) {
-            throw new RuntimeCommandException(sprintf('The file "%s" can\'t be generated because it already exists.', $this->fileManager->relativizePath($targetPath)));
-        }
-
-        $variables['relative_path'] = $this->fileManager->relativizePath($targetPath);
-
-        $templatePath = $templateName;
-        if (!file_exists($templatePath)) {
-            $templatePath = __DIR__.'/Resources/skeleton/'.$templateName;
-
-            if (!file_exists($templatePath)) {
-                throw new \Exception(sprintf('Cannot find template "%s"', $templateName));
-            }
-        }
-
-        $this->pendingOperations[$targetPath] = [
-            'template' => $templatePath,
-            'variables' => $variables,
-        ];
-    }
-
     public function hasPendingOperations(): bool
     {
         return !empty($this->pendingOperations);
@@ -196,6 +179,8 @@ public function hasPendingOperations(): bool
     public function writeChanges()
     {
         foreach ($this->pendingOperations as $targetPath => $templateData) {
+            $this->generatedFiles[] = $targetPath;
+
             if (isset($templateData['contents'])) {
                 $this->fileManager->dumpFile($targetPath, $templateData['contents']);
 
@@ -204,7 +189,7 @@ public function writeChanges()
 
             $this->fileManager->dumpFile(
                 $targetPath,
-                $this->getFileContentsForPendingOperation($targetPath, $templateData)
+                $this->getFileContentsForPendingOperation($targetPath)
             );
         }
 
@@ -242,6 +227,14 @@ public function generateTemplate(string $targetPath, string $templateName, array
         );
     }
 
+    /**
+     * Get the full path of each file created by the Generator.
+     */
+    public function getGeneratedFiles(): array
+    {
+        return $this->generatedFiles;
+    }
+
     /**
      * @deprecated MakerBundle only supports AbstractController::class. This method will be removed in the future.
      */
@@ -251,4 +244,27 @@ public static function getControllerBaseClass(): ClassNameDetails
 
         return new ClassNameDetails(AbstractController::class, '\\');
     }
+
+    private function addOperation(string $targetPath, string $templateName, array $variables): void
+    {
+        if ($this->fileManager->fileExists($targetPath)) {
+            throw new RuntimeCommandException(sprintf('The file "%s" can\'t be generated because it already exists.', $this->fileManager->relativizePath($targetPath)));
+        }
+
+        $variables['relative_path'] = $this->fileManager->relativizePath($targetPath);
+
+        $templatePath = $templateName;
+        if (!file_exists($templatePath)) {
+            $templatePath = __DIR__.'/Resources/skeleton/'.$templateName;
+
+            if (!file_exists($templatePath)) {
+                throw new \Exception(sprintf('Cannot find template "%s"', $templateName));
+            }
+        }
+
+        $this->pendingOperations[$targetPath] = [
+            'template' => $templatePath,
+            'variables' => $variables,
+        ];
+    }
 }

src/Resources/bin/php-cs-fixer-v3.13.0.phar

@@ -0,0 +1,20 @@
+<?php
+
+/*
+ * This file is part of the Symfony MakerBundle package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+return (new PhpCsFixer\Config())
+    ->setRules([
+        '@Symfony' => true,
+        '@Symfony:risky' => true,
+        'native_function_invocation' => false,
+        'blank_line_before_statement' => ['statements' => ['break', 'case', 'continue', 'declare', 'default', 'do', 'exit', 'for', 'foreach', 'goto', 'if', 'include', 'include_once', 'phpdoc', 'require', 'require_once', 'return', 'switch', 'throw', 'try', 'while', 'yield', 'yield_from']],
+    ])
+    ->setRiskyAllowed(true)
+;

src/Resources/config/php-cs-fixer.config.php

@@ -40,10 +40,16 @@
                 <argument type="service" id="doctrine" on-invalid="ignore" />
             </service>
 
+            <service id="maker.template_linter" class="Symfony\Bundle\MakerBundle\Util\TemplateLinter">
+                <argument>%env(default::string:MAKER_PHP_CS_FIXER_BINARY_PATH)%</argument>
+                <argument>%env(default::string:MAKER_PHP_CS_FIXER_CONFIG_PATH)%</argument>
+            </service>
+
             <service id="maker.auto_command.abstract" class="Symfony\Bundle\MakerBundle\Command\MakerCommand" abstract="true">
                 <argument /> <!-- maker -->
                 <argument type="service" id="maker.file_manager" />
                 <argument type="service" id="maker.generator" />
+                <argument type="service" id="maker.template_linter" />
             </service>
 
             <service id="maker.generator" class="Symfony\Bundle\MakerBundle\Generator">

src/Resources/config/services.xml

@@ -43,6 +43,27 @@ optional arguments and options. Check them out with the ``--help`` option:
 
     $ php bin/console make:controller --help
 
+
+Linting Generated Code
+______________________
+
+MakerBundle uses php-cs-fixer to enforce coding standards when generating ``.php``
+files. When running a ``make`` command, MakerBundle will use a ``php-cs-fixer``
+version and configuration that is packaged with this bundle.
+
+You can explicitly set a custom path to a php-cs-fixer binary and/or configuration
+file by their respective environment variables:
+
+- ``MAKER_PHP_CS_FIXER_BINARY_PATH`` e.g. tools/vendor/bin/php-cs-fixer
+- ``MAKER_PHP_CS_FIXER_CONFIG_PATH`` e.g. .php-cs-fixer.config.php
+
+
+.. tip::
+
+    Is PHP-CS-Fixer installed globally? To avoid needing to set these in every
+    project, you can instead set these on your operating system.
+
+
 Configuration
 -------------
 

src/Resources/doc/index.rst

@@ -77,16 +77,6 @@ protected function executeMakerCommand(MakerTestDetails $testDetails)
         foreach ($files as $file) {
             $this->assertTrue($testEnv->fileExists($file), sprintf('The file "%s" does not exist after generation', $file));
 
-            if (str_ends_with($file, '.php')) {
-                $csProcess = $testEnv->runPhpCSFixer($file);
-
-                $this->assertTrue($csProcess->isSuccessful(), sprintf(
-                    "File '%s' has a php-cs problem: %s\n",
-                    $file,
-                    $csProcess->getErrorOutput()."\n".$csProcess->getOutput()
-                ));
-            }
-
             if (str_ends_with($file, '.twig')) {
                 $csProcess = $testEnv->runTwigCSLint($file);
 

src/Resources/test/.php_cs.test

@@ -216,19 +216,6 @@ public function fileExists(string $file): bool
         return $this->fs->exists($this->path.'/'.$file);
     }
 
-    public function runPhpCSFixer(string $file): MakerTestProcess
-    {
-        if (!file_exists(__DIR__.'/../../tools/php-cs-fixer/vendor/bin/php-cs-fixer')) {
-            throw new \Exception('php-cs-fixer not found: run: "composer install --working-dir=tools/php-cs-fixer".');
-        }
-
-        return MakerTestProcess::create(
-            sprintf('php tools/php-cs-fixer/vendor/bin/php-cs-fixer --config=%s fix --dry-run --diff %s', __DIR__.'/../Resources/test/.php_cs.test', $this->path.'/'.$file),
-            $this->rootPath,
-            ['PHP_CS_FIXER_IGNORE_ENV' => '1']
-        )->run(true);
-    }
-
     public function runTwigCSLint(string $file): MakerTestProcess
     {
         if (!file_exists(__DIR__.'/../../tools/twigcs/vendor/bin/twigcs')) {