Refine structured command logging

Author: coisa

src/Console/Command/AgentsCommand.php

@@ -24,7 +24,6 @@
 use FastForward\DevTools\Filesystem\FilesystemInterface;
 use FastForward\DevTools\Path\DevToolsPathResolver;
 use FastForward\DevTools\Sync\PackagedDirectorySynchronizer;
-use Psr\Log\LoggerInterface;
 use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
@@ -48,12 +47,10 @@ final class AgentsCommand extends Command
     /**
      * @param PackagedDirectorySynchronizer $synchronizer
      * @param FilesystemInterface $filesystem
-     * @param LoggerInterface $logger
      */
     public function __construct(
         private readonly PackagedDirectorySynchronizer $synchronizer,
         private readonly FilesystemInterface $filesystem,
-        private readonly LoggerInterface $logger,
     ) {
         parent::__construct();
     }

src/Console/Command/ChangelogCheckCommand.php

@@ -23,7 +23,6 @@
 use FastForward\DevTools\Changelog\Checker\UnreleasedEntryCheckerInterface;
 use FastForward\DevTools\Console\Input\HasJsonOption;
 use FastForward\DevTools\Filesystem\FilesystemInterface;
-use Psr\Log\LoggerInterface;
 use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
@@ -45,12 +44,10 @@ final class ChangelogCheckCommand extends Command
     /**
      * @param FilesystemInterface $filesystem
      * @param UnreleasedEntryCheckerInterface $unreleasedEntryChecker
-     * @param LoggerInterface $logger
      */
     public function __construct(
         private readonly FilesystemInterface $filesystem,
         private readonly UnreleasedEntryCheckerInterface $unreleasedEntryChecker,
-        private readonly LoggerInterface $logger,
     ) {
         parent::__construct();
     }

src/Console/Command/ChangelogEntryCommand.php

@@ -25,7 +25,6 @@
 use FastForward\DevTools\Changelog\Manager\ChangelogManagerInterface;
 use FastForward\DevTools\Console\Input\HasJsonOption;
 use FastForward\DevTools\Filesystem\FilesystemInterface;
-use Psr\Log\LoggerInterface;
 use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputArgument;
@@ -48,12 +47,10 @@ final class ChangelogEntryCommand extends Command
     /**
      * @param FilesystemInterface $filesystem
      * @param ChangelogManagerInterface $changelogManager
-     * @param LoggerInterface $logger
      */
     public function __construct(
         private readonly FilesystemInterface $filesystem,
         private readonly ChangelogManagerInterface $changelogManager,
-        private readonly LoggerInterface $logger,
     ) {
         parent::__construct();
     }

src/Console/Command/ChangelogNextVersionCommand.php

@@ -24,7 +24,6 @@
 use FastForward\DevTools\Changelog\Manager\ChangelogManagerInterface;
 use FastForward\DevTools\Console\Input\HasJsonOption;
 use FastForward\DevTools\Filesystem\FilesystemInterface;
-use Psr\Log\LoggerInterface;
 use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
@@ -46,12 +45,10 @@ final class ChangelogNextVersionCommand extends Command
     /**
      * @param FilesystemInterface $filesystem
      * @param ChangelogManagerInterface $changelogManager
-     * @param LoggerInterface $logger
      */
     public function __construct(
         private readonly FilesystemInterface $filesystem,
         private readonly ChangelogManagerInterface $changelogManager,
-        private readonly LoggerInterface $logger,
     ) {
         parent::__construct();
     }

src/Console/Command/ChangelogPromoteCommand.php

@@ -25,7 +25,6 @@
 use FastForward\DevTools\Console\Input\HasJsonOption;
 use FastForward\DevTools\Filesystem\FilesystemInterface;
 use Psr\Clock\ClockInterface;
-use Psr\Log\LoggerInterface;
 use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputArgument;
@@ -49,13 +48,11 @@ final class ChangelogPromoteCommand extends Command
      * @param FilesystemInterface $filesystem
      * @param ChangelogManagerInterface $changelogManager
      * @param ClockInterface $clock
-     * @param LoggerInterface $logger
      */
     public function __construct(
         private readonly FilesystemInterface $filesystem,
         private readonly ChangelogManagerInterface $changelogManager,
         private readonly ClockInterface $clock,
-        private readonly LoggerInterface $logger,
     ) {
         parent::__construct();
     }

src/Console/Command/ChangelogShowCommand.php

@@ -24,7 +24,6 @@
 use FastForward\DevTools\Changelog\Manager\ChangelogManagerInterface;
 use FastForward\DevTools\Console\Input\HasJsonOption;
 use FastForward\DevTools\Filesystem\FilesystemInterface;
-use Psr\Log\LoggerInterface;
 use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputArgument;
@@ -44,12 +43,10 @@ final class ChangelogShowCommand extends Command
     /**
      * @param FilesystemInterface $filesystem
      * @param ChangelogManagerInterface $changelogManager
-     * @param LoggerInterface $logger
      */
     public function __construct(
         private readonly FilesystemInterface $filesystem,
         private readonly ChangelogManagerInterface $changelogManager,
-        private readonly LoggerInterface $logger,
     ) {
         parent::__construct();
     }

src/Console/Command/CodeOwnersCommand.php

@@ -24,7 +24,6 @@
 use FastForward\DevTools\CodeOwners\CodeOwnersGenerator;
 use FastForward\DevTools\Filesystem\FilesystemInterface;
 use FastForward\DevTools\Resource\FileDiffer;
-use Psr\Log\LoggerInterface;
 use Psr\Log\LogLevel;
 use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
@@ -53,14 +52,12 @@ final class CodeOwnersCommand extends Command
      * @param CodeOwnersGenerator $generator the generator used to infer and render CODEOWNERS contents
      * @param FilesystemInterface $filesystem the filesystem used to read and write the target file
      * @param FileDiffer $fileDiffer the differ used to report managed-file drift
-     * @param LoggerInterface $logger the output-aware logger
      * @param SymfonyStyle $io the SymfonyStyle instance for interactive prompts
      */
     public function __construct(
         private readonly CodeOwnersGenerator $generator,
         private readonly FilesystemInterface $filesystem,
         private readonly FileDiffer $fileDiffer,
-        private readonly LoggerInterface $logger,
         private readonly SymfonyStyle $io,
     ) {
         parent::__construct();
@@ -153,21 +150,22 @@ protected function execute(InputInterface $input, OutputInterface $output): int
                 : \sprintf('Updating managed file %s from generated CODEOWNERS content.', $targetPath),
         );
 
-        $this->notice($comparison->getSummary(), $input, [
+        $this->log($comparison->getSummary(), $input, [
             'target_path' => $targetPath,
-        ]);
+        ], LogLevel::NOTICE);
 
         if ($comparison->isChanged()) {
             $consoleDiff = $this->fileDiffer->formatForConsole($comparison->getDiff(), $output->isDecorated());
 
             if (null !== $consoleDiff) {
-                $this->notice(
+                $this->log(
                     $consoleDiff,
                     $input,
                     [
                         'target_path' => $targetPath,
                         'diff' => $comparison->getDiff(),
                     ],
+                    LogLevel::NOTICE,
                 );
             }
         }

src/Console/Command/CodeStyleCommand.php

@@ -24,7 +24,6 @@
 use FastForward\DevTools\Path\DevToolsPathResolver;
 use FastForward\DevTools\Process\ProcessBuilderInterface;
 use FastForward\DevTools\Process\ProcessQueueInterface;
-use Psr\Log\LoggerInterface;
 use Symfony\Component\Config\FileLocatorInterface;
 use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
@@ -63,13 +62,11 @@ final class CodeStyleCommand extends Command
      * @param FileLocatorInterface $fileLocator locates the configuration file required by EasyCodingStandard
      * @param ProcessBuilderInterface $processBuilder builds the process instances used to execute Composer and ECS commands
      * @param ProcessQueueInterface $processQueue queues and executes the generated processes in the required order
-     * @param LoggerInterface $logger logs command feedback
      */
     public function __construct(
         private readonly FileLocatorInterface $fileLocator,
         private readonly ProcessBuilderInterface $processBuilder,
         private readonly ProcessQueueInterface $processQueue,
-        private readonly LoggerInterface $logger,
     ) {
         parent::__construct();
     }

src/Console/Command/CopyResourceCommand.php

@@ -24,7 +24,6 @@
 use FastForward\DevTools\Filesystem\FinderFactoryInterface;
 use FastForward\DevTools\Filesystem\FilesystemInterface;
 use FastForward\DevTools\Resource\FileDiffer;
-use Psr\Log\LoggerInterface;
 use Psr\Log\LogLevel;
 use Symfony\Component\Config\FileLocatorInterface;
 use Symfony\Component\Console\Attribute\AsCommand;
@@ -56,15 +55,13 @@ final class CopyResourceCommand extends Command
      * @param FileLocatorInterface $fileLocator the locator used to resolve source resources
      * @param FinderFactoryInterface $finderFactory the factory used to create finders for directory resources
      * @param FileDiffer $fileDiffer the service used to summarize overwrite changes
-     * @param LoggerInterface $logger the output-aware logger
      * @param SymfonyStyle $io the input/output service used to interact with the user
      */
     public function __construct(
         private readonly FilesystemInterface $filesystem,
         private readonly FileLocatorInterface $fileLocator,
         private readonly FinderFactoryInterface $finderFactory,
         private readonly FileDiffer $fileDiffer,
-        private readonly LoggerInterface $logger,
         private readonly SymfonyStyle $io,
     ) {
         parent::__construct();
@@ -162,11 +159,11 @@ protected function execute(InputInterface $input, OutputInterface $output): int
      * @param string $sourcePath the resolved source directory
      * @param string $targetPath the resolved target directory
      * @param bool $overwrite whether existing files MAY be overwritten
+     * @param bool $dryRun whether the command is previewing changes only
+     * @param bool $check whether the command SHOULD fail on detected drift
+     * @param bool $interactive whether the command SHOULD prompt before overwriting drifted files
+     * @param InputInterface $input the originating command input
      * @param OutputInterface $output the output used to report copy results
-     * @param bool $dryRun
-     * @param bool $check
-     * @param bool $interactive
-     * @param InputInterface $input
      *
      * @return int the command status code
      */
@@ -213,11 +210,11 @@ private function copyDirectory(
      * @param string $sourcePath the resolved source file
      * @param string $targetPath the resolved target file
      * @param bool $overwrite whether an existing target file MAY be overwritten
+     * @param bool $dryRun whether the command is previewing changes only
+     * @param bool $check whether the command SHOULD fail on detected drift
+     * @param bool $interactive whether the command SHOULD prompt before overwriting drifted files
+     * @param InputInterface $input the originating command input
      * @param OutputInterface $output the output used to report copy results
-     * @param bool $dryRun
-     * @param bool $check
-     * @param bool $interactive
-     * @param InputInterface $input
      *
      * @return int the command status code
      */
@@ -246,27 +243,29 @@ private function copyFile(
         if (($overwrite || $dryRun || $check || $interactive) && $this->filesystem->exists($targetPath)) {
             $comparison = $this->fileDiffer->diff($sourcePath, $targetPath);
 
-            $this->notice(
+            $this->log(
                 $comparison->getSummary(),
                 $input,
                 [
                     'source_path' => $sourcePath,
                     'target_path' => $targetPath,
                 ],
+                LogLevel::NOTICE,
             );
 
             if ($comparison->isChanged()) {
                 $consoleDiff = $this->fileDiffer->formatForConsole($comparison->getDiff(), $output->isDecorated());
 
                 if (null !== $consoleDiff) {
-                    $this->notice(
+                    $this->log(
                         $consoleDiff,
                         $input,
                         [
                             'source_path' => $sourcePath,
                             'target_path' => $targetPath,
                             'diff' => $comparison->getDiff(),
                         ],
+                        LogLevel::NOTICE,
                     );
                 }
             }

src/Console/Command/DependenciesCommand.php

@@ -26,7 +26,6 @@
 use FastForward\DevTools\Process\ProcessBuilderInterface;
 use FastForward\DevTools\Process\ProcessQueueInterface;
 use InvalidArgumentException;
-use Psr\Log\LoggerInterface;
 use Symfony\Component\Config\FileLocatorInterface;
 use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
@@ -61,13 +60,11 @@ final class DependenciesCommand extends Command
      * @param ProcessBuilderInterface $processBuilder creates analyzer and upgrade processes
      * @param ProcessQueueInterface $processQueue executes queued processes
      * @param FileLocatorInterface $fileLocator resolves the dependency analyser configuration
-     * @param LoggerInterface $logger writes command feedback
      */
     public function __construct(
         private readonly ProcessBuilderInterface $processBuilder,
         private readonly ProcessQueueInterface $processQueue,
         private readonly FileLocatorInterface $fileLocator,
-        private readonly LoggerInterface $logger,
     ) {
         return parent::__construct();
     }