refactor to track all generated files

Author: jrushlow

src/Command/MakerCommand.php

@@ -102,7 +102,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             throw new \LogicException('Make sure to call the writeChanges() method on the generator.');
         }
 
-        $this->linter->lintPhpTemplate($this->generator->getGeneratedPhpFiles());
+        $this->linter->lintFiles($this->generator->getGeneratedFiles());
 
         return 0;
     }

src/Generator.php

@@ -26,7 +26,7 @@ class Generator
     private GeneratorTwigHelper $twigHelper;
     private array $pendingOperations = [];
     private ?TemplateComponentGenerator $templateComponentGenerator;
-    private array $generatedPhpFiles = [];
+    private array $generatedFiles = [];
 
     public function __construct(
         private FileManager $fileManager,
@@ -70,13 +70,13 @@ public function generateClass(string $className, string $templateName, array $va
 
         $this->addOperation($targetPath, $templateName, $variables);
 
-        $this->generatedPhpFiles[] = $targetPath;
-
         return $targetPath;
     }
 
     /**
      * Generate a normal file from a template.
+     *
+     * @return void
      */
     public function generateFile(string $targetPath, string $templateName, array $variables = [])
     {
@@ -87,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] = [
@@ -163,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);
@@ -199,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']);
 
@@ -207,7 +189,7 @@ public function writeChanges()
 
             $this->fileManager->dumpFile(
                 $targetPath,
-                $this->getFileContentsForPendingOperation($targetPath, $templateData)
+                $this->getFileContentsForPendingOperation($targetPath)
             );
         }
 
@@ -245,9 +227,12 @@ public function generateTemplate(string $targetPath, string $templateName, array
         );
     }
 
-    public function getGeneratedPhpFiles(): array
+    /**
+     * Get the full path of each file created by the Generator.
+     */
+    public function getGeneratedFiles(): array
     {
-        return $this->generatedPhpFiles;
+        return $this->generatedFiles;
     }
 
     /**
@@ -259,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/Util/TemplateLinter.php

@@ -31,6 +31,19 @@ public function __construct(
         $this->setBinary();
     }
 
+    public function lintFiles(array $templateFilePaths): void
+    {
+        $phpFiles = [];
+
+        foreach ($templateFilePaths as $filePath) {
+            if (str_ends_with($filePath, '.php')) {
+                $phpFiles[] = $filePath;
+            }
+        }
+
+        $this->lintPhpTemplate($phpFiles);
+    }
+
     public function lintPhpTemplate(string|array $templateFilePath): void
     {
         if (\is_string($templateFilePath)) {