refactor: complete composer-command migration and cleanup for dev-tools

Author: coisa

bin/dev-tools.php

@@ -20,19 +20,10 @@
 namespace FastForward\DevTools;
 
 use FastForward\DevTools\Console\DevTools;
-use FastForward\DevTools\Console\DevToolsComposer;
-use Symfony\Component\Console\Input\ArgvInput;
 
 $projectVendorAutoload = \dirname(__DIR__, 4) . '/vendor/autoload.php';
 $pluginVendorAutoload = \dirname(__DIR__) . '/vendor/autoload.php';
 
 require_once file_exists($projectVendorAutoload) ? $projectVendorAutoload : $pluginVendorAutoload;
 
-$input = new ArgvInput([...$argv, '--no-plugins']);
-
-$command = $input->getFirstArgument();
-$application = (null !== $command && DevTools::create()->has($command))
-    ? DevTools::create()
-    : DevToolsComposer::create();
-
-$application->run($input);
+DevTools::create()->run();

docs/commands/funding.rst

@@ -33,7 +33,7 @@ Options
 
 ``--composer-file`` (optional)
    Path to the Composer manifest to synchronize. Default:
-   ``Factory::getComposerFile()``.
+   ``composer.json``.
 
 ``--funding-file`` (optional)
    Path to the GitHub funding file to synchronize. Default:

src/Composer/Capability/DevToolsCommandProvider.php

@@ -21,9 +21,8 @@
 
 use Composer\Command\BaseCommand;
 use Composer\Plugin\Capability\CommandProvider;
-use FastForward\DevTools\Console\Command\ProxyCommand;
+use FastForward\DevTools\Composer\Command\ProxyCommand;
 use FastForward\DevTools\Console\DevTools;
-use FastForward\DevTools\Console\DevToolsComposer;
 use Symfony\Component\Console\Command\Command;
 
 /**
@@ -37,76 +36,9 @@ final class DevToolsCommandProvider implements CommandProvider
      */
     public function getCommands()
     {
-        $legacyCommands = DevToolsComposer::create()->all();
-        $reservedCommandNames = $this->collectCommandNames($legacyCommands);
-        $migratedCommands = DevTools::create()->all();
-
-        $commands = $legacyCommands;
-
-        foreach ($migratedCommands as $command) {
-            if (! $command instanceof Command || $command instanceof BaseCommand) {
-                continue;
-            }
-
-            if ($this->hasReservedName($command, $reservedCommandNames)) {
-                continue;
-            }
-
-            $commands[] = new ProxyCommand($command);
-        }
-
-        return array_values(array_filter(
-            $commands,
-            static fn(object $command): bool => $command instanceof BaseCommand,
-        ));
-    }
-
-    /**
-     * Collects command names and aliases that must remain mapped to legacy commands.
-     *
-     * @param array<int, BaseCommand> $commands
-     *
-     * @return array<string, true>
-     */
-    private function collectCommandNames(array $commands): array
-    {
-        $commandNames = [];
-
-        foreach ($commands as $command) {
-            if (! $command instanceof BaseCommand) {
-                continue;
-            }
-
-            if (null !== $command->getName()) {
-                $commandNames[$command->getName()] = true;
-            }
-
-            foreach ($command->getAliases() as $alias) {
-                $commandNames[$alias] = true;
-            }
-        }
-
-        return $commandNames;
-    }
-
-    /**
-     * Verifies whether the command name or any aliases collide with legacy command names.
-     *
-     * @param Command $command
-     * @param array<string, true> $reservedCommandNames
-     */
-    private function hasReservedName(Command $command, array $reservedCommandNames): bool
-    {
-        if (null !== $command->getName() && isset($reservedCommandNames[$command->getName()])) {
-            return true;
-        }
-
-        foreach ($command->getAliases() as $alias) {
-            if (isset($reservedCommandNames[$alias])) {
-                return true;
-            }
-        }
-
-        return false;
+        return array_map(
+            static fn(Command $command): BaseCommand => new ProxyCommand($command),
+            DevTools::create()->all(),
+        );
     }
 }

src/Console/Command/ProxyCommand.php src/Composer/Command/ProxyCommand.phpsrc/Console/Command/ProxyCommand.php renamed to src/Composer/Command/ProxyCommand.php

@@ -17,7 +17,7 @@
  * @see      https://datatracker.ietf.org/doc/html/rfc2119
  */
 
-namespace FastForward\DevTools\Console\Command;
+namespace FastForward\DevTools\Composer\Command;
 
 use Composer\Command\BaseCommand;
 use Symfony\Component\Console\Command\Command;
@@ -29,17 +29,20 @@
  */
 final class ProxyCommand extends BaseCommand
 {
+    /**
+     * @param Command $command the Symfony command adapted for Composer plugin execution
+     */
     public function __construct(
         private readonly Command $command,
     ) {
-        parent::__construct($command->getName());
-
-        $this->setAliases($command->getAliases());
-        $this->setDescription($command->getDescription());
-        $this->setHelp($command->getHelp());
-        $this->setDefinition(clone $command->getDefinition());
-        $this->setHidden($command->isHidden());
-        $this->setIgnoreValidationErrors($command->ignoreValidationErrors());
+        parent::__construct($this->command->getName());
+
+        $this
+            ->setAliases($this->command->getAliases())
+            ->setDescription($this->command->getDescription())
+            ->setHelp($this->command->getHelp())
+            ->setDefinition(clone $this->command->getDefinition())
+            ->setHidden($this->command->isHidden());
     }
 
     /**
@@ -50,9 +53,6 @@ public function __construct(
      */
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
-        $this->command->setApplication($this->getApplication());
-        $this->command->setHelperSet($this->getHelperSet());
-
         return $this->command->run($input, $output);
     }
 }

src/Composer/Json/ComposerJson.php

@@ -29,6 +29,8 @@
 use FastForward\DevTools\Composer\Json\Schema\SupportInterface;
 use FastForward\DevTools\Path\WorkingProjectPathResolver;
 use UnderflowException;
+
+use function Safe\file_get_contents;
 use function Safe\json_decode;
 
 /**
@@ -592,9 +594,7 @@ public function getComments(): array
     private function readComposerJsonFile(string $path): array
     {
         if (! file_exists($path)) {
-            throw new RuntimeException(
-                \sprintf('Unable to read composer manifest file at path: %s', $path),
-            );
+            throw new RuntimeException(\sprintf('Unable to read composer manifest file at path: %s', $path));
         }
 
         return $this->decodeJson($path);
@@ -628,9 +628,7 @@ private function decodeJson(string $path): array
         $contents = file_get_contents($path);
 
         if (false === $contents) {
-            throw new RuntimeException(
-                \sprintf('Unable to read composer manifest file at path: %s', $path),
-            );
+            throw new RuntimeException(\sprintf('Unable to read composer manifest file at path: %s', $path));
         }
 
         $data = json_decode($contents, true, 512, \JSON_THROW_ON_ERROR);

src/Console/Command/AgentsCommand.php

@@ -98,8 +98,6 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $this->logger->info('Created .agents/agents directory.');
         }
 
-        $this->synchronizer->setLogger($this->logger);
-
         $result = $this->synchronizer->synchronize($agentsDir, $packageAgentsPath, self::AGENTS_DIRECTORY);
 
         if ($result->failed()) {

src/Console/Command/ChangelogCheckCommand.php

@@ -20,12 +20,12 @@
 namespace FastForward\DevTools\Console\Command;
 
 use FastForward\DevTools\Console\Command\Traits\LogsCommandResults;
-use Composer\Command\BaseCommand;
 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;
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
@@ -37,7 +37,7 @@
     name: 'changelog:check',
     description: 'Checks whether a changelog file contains meaningful unreleased entries.'
 )]
-final class ChangelogCheckCommand extends BaseCommand implements LoggerAwareCommandInterface
+final class ChangelogCheckCommand extends Command implements LoggerAwareCommandInterface
 {
     use HasJsonOption;
     use LogsCommandResults;

src/Console/Command/ChangelogEntryCommand.php

@@ -20,14 +20,14 @@
 namespace FastForward\DevTools\Console\Command;
 
 use FastForward\DevTools\Console\Command\Traits\LogsCommandResults;
-use Composer\Command\BaseCommand;
 use FastForward\DevTools\Changelog\Document\ChangelogDocument;
 use FastForward\DevTools\Changelog\Entry\ChangelogEntryType;
 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;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
@@ -40,7 +40,7 @@
     name: 'changelog:entry',
     description: 'Adds a changelog entry to Unreleased or a specific version section.'
 )]
-final class ChangelogEntryCommand extends BaseCommand implements LoggerAwareCommandInterface
+final class ChangelogEntryCommand extends Command implements LoggerAwareCommandInterface
 {
     use HasJsonOption;
     use LogsCommandResults;

src/Console/Command/ChangelogNextVersionCommand.php

@@ -21,12 +21,12 @@
 
 use FastForward\DevTools\Console\Command\Traits\LogsCommandResults;
 use Throwable;
-use Composer\Command\BaseCommand;
 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;
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
@@ -38,7 +38,7 @@
     name: 'changelog:next-version',
     description: 'Infers the next semantic version from the Unreleased changelog section.'
 )]
-final class ChangelogNextVersionCommand extends BaseCommand implements LoggerAwareCommandInterface
+final class ChangelogNextVersionCommand extends Command implements LoggerAwareCommandInterface
 {
     use HasJsonOption;
     use LogsCommandResults;

src/Console/Command/ChangelogPromoteCommand.php

@@ -21,13 +21,13 @@
 
 use FastForward\DevTools\Console\Command\Traits\LogsCommandResults;
 use Throwable;
-use Composer\Command\BaseCommand;
 use FastForward\DevTools\Changelog\Manager\ChangelogManagerInterface;
 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;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
@@ -40,7 +40,7 @@
     name: 'changelog:promote',
     description: 'Promotes Unreleased entries into a published changelog version.'
 )]
-final class ChangelogPromoteCommand extends BaseCommand implements LoggerAwareCommandInterface
+final class ChangelogPromoteCommand extends Command implements LoggerAwareCommandInterface
 {
     use HasJsonOption;
     use LogsCommandResults;