[Toolkit] Update version handling in dependencies to use string format, improve command output messages, improve InstallComponentCommand (interactive ask), remove LintKitCommand

Author: Kocal

src/Toolkit/bin/ux-toolkit-kit-debug

@@ -47,14 +47,8 @@ if (!class_exists(Application::class)) {
 
 $filesystem = new Filesystem();
 $kitFactory = new KitFactory($filesystem, new KitSynchronizer($filesystem));
-$registryFactory = new RegistryFactory(new class([
-    Type::Local->value => fn () => new LocalRegistry($kitFactory, $filesystem, getcwd() ?? throw new \RuntimeException('The current working directory could not be determined.')),
-    Type::GitHub->value => fn () => new GitHubRegistry($kitFactory, $filesystem, class_exists(HttpClient::class) ? HttpClient::create() : null),
-]) implements ServiceProviderInterface {
-    use ServiceLocatorTrait;
-});
-
-(new Application())->add($command = new DebugKitCommand($registryFactory))
+
+(new Application())->add($command = new DebugKitCommand($kitFactory))
     ->getApplication()
     ->setDefaultCommand($command->getName(), true)
     ->run()

src/Toolkit/bin/ux-toolkit-kit-lint

@@ -49,7 +49,6 @@
   },
   "bin": [
     "bin/ux-toolkit-kit-create",
-    "bin/ux-toolkit-kit-lint",
     "bin/ux-toolkit-kit-debug"
   ],
   "autoload": {

src/Toolkit/composer.json

@@ -13,7 +13,6 @@
 
 use Symfony\UX\Toolkit\Command\DebugKitCommand;
 use Symfony\UX\Toolkit\Command\InstallComponentCommand;
-use Symfony\UX\Toolkit\Command\LintKitCommand;
 use Symfony\UX\Toolkit\Kit\KitFactory;
 use Symfony\UX\Toolkit\Kit\KitSynchronizer;
 use Symfony\UX\Toolkit\Registry\GitHubRegistry;
@@ -30,27 +29,21 @@
 
         ->set('.ux_toolkit.command.debug_kit', DebugKitCommand::class)
             ->args([
-                service('.ux_toolkit.registry.factory'),
+                service('.ux_toolkit.kit.kit_factory'),
             ])
             ->tag('console.command')
 
         ->set('.ux_toolkit.command.install', InstallComponentCommand::class)
             ->args([
                 param('ux_toolkit.kit'),
-                service('.ux_toolkit.registry.factory'),
+                service('.ux_toolkit.registry.registry_factory'),
                 service('filesystem'),
             ])
             ->tag('console.command')
 
-        ->set('.ux_toolkit.command.lint_kit', LintKitCommand::class)
-            ->args([
-                service('.ux_toolkit.registry.factory'),
-            ])
-            ->tag('console.command')
-
         // Registry
 
-        ->set('.ux_toolkit.registry.factory', RegistryFactory::class)
+        ->set('.ux_toolkit.registry.registry_factory', RegistryFactory::class)
             ->args([
                 service_locator([
                     Type::Local->value => service('.ux_toolkit.registry.local'),

src/Toolkit/config/services.php

@@ -19,7 +19,8 @@
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Style\SymfonyStyle;
-use Symfony\UX\Toolkit\Registry\RegistryFactory;
+use Symfony\Component\Filesystem\Path;
+use Symfony\UX\Toolkit\Kit\KitFactory;
 
 /**
  * @author Jean-François Lépine
@@ -29,33 +30,28 @@
  */
 #[AsCommand(
     name: 'ux:toolkit:debug-kit',
-    description: 'Debug a kit, dump the dependencies.',
+    description: 'Debug a local Kit.',
     hidden: true,
 )]
 class DebugKitCommand extends Command
 {
     public function __construct(
-        private readonly RegistryFactory $registryFactory,
+        private readonly KitFactory $kitFactory,
     ) {
         parent::__construct();
     }
 
     protected function configure(): void
     {
         $this
-            ->addArgument('kit', InputArgument::REQUIRED, 'The kit name, can be a local kit (e.g.: "shadcn") or a GitHub kit (e.g.: "https://github.com/user/repository@kit-name").')
+            ->addArgument('kit-path', InputArgument::OPTIONAL, 'The path to the kit to debug', '.')
             ->setHelp(<<<'EOF'
-The kit name can be a local kit (e.g.: "shadcn") or a GitHub kit (e.g.: "https://github.com/user/repository@kit-name").
-
-To debug a local kit:
-
-  <info>php %command.full_name% shadcn</info>
-
-To debug a GitHub kit:
-
-  <info>php %command.full_name% https://github.com/user/repository@kit-name</info>
-  <info>php %command.full_name% https://github.com/user/repository@[email protected]</info>
+To debug a Kit in the current directory:
+    <info>php %command.full_name%</info>
 
+Or in another directory:
+    <info>php %command.full_name% ./kits/shadcn</info>
+    <info>php %command.full_name% /path/to/my-kit</info>
 EOF
             );
     }
@@ -64,9 +60,9 @@ protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $io = new SymfonyStyle($input, $output);
 
-        $kitName = $input->getArgument('kit');
-        $registry = $this->registryFactory->getForKit($kitName);
-        $kit = $registry->getKit($kitName);
+        $kitPath = $input->getArgument('kit-path');
+        $kitPath = Path::makeAbsolute($kitPath, getcwd());
+        $kit = $this->kitFactory->createKitFromAbsolutePath($kitPath);
 
         $io->title(\sprintf('Kit "%s"', $kit->name));
 

src/Toolkit/src/Command/DebugKitCommand.php

@@ -34,7 +34,7 @@
  */
 #[AsCommand(
     name: 'ux:toolkit:install-component',
-    description: 'This command will install a new UX Component in your project',
+    description: 'Install a new UX Component (e.g. Alert) in your project',
 )]
 class InstallComponentCommand extends Command
 {
@@ -52,7 +52,7 @@ public function __construct(
     protected function configure(): void
     {
         $this
-            ->addArgument('component', InputArgument::REQUIRED, 'The component name (Ex: Button)')
+            ->addArgument('component', InputArgument::OPTIONAL, 'The component name (Ex: Button)')
             ->addOption(
                 'destination',
                 'd',
@@ -76,8 +76,8 @@ protected function configure(): void
 
 To install a component from an external GitHub kit, use the <info>--kit</info> option:
 
-<info>php %command.full_name% Button --kit=https://github.com/user/repository@kit</info>
-<info>php %command.full_name% Button --kit=https://github.com/user/repository@kit:branch</info>
+<info>php %command.full_name% Button --kit=https://github.com/user/my-kit</info>
+<info>php %command.full_name% Button --kit=https://github.com/user/my-kit:branch</info>
 EOF
             );
     }
@@ -95,8 +95,12 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         $registry = $this->registryFactory->getForKit($kitName);
         $kit = $registry->getKit($kitName);
 
-        // Get the component name from the argument, or suggest alternatives if it doesn't exist
-        if (null === $component = $kit->getComponent($componentName = $input->getArgument('component'))) {
+        if (null === $componentName = $input->getArgument('component')) {
+            // Ask for the component name if not provided
+            $componentName = $io->choice('Which component do you want to install?', array_map(fn (Component $component) => $component->name, $this->getAvailableComponents($kit)));
+            $component = $kit->getComponent($componentName);
+        } elseif (null === $component = $kit->getComponent($componentName)) {
+            // Suggest alternatives if component does not exist
             $message = \sprintf('The component "%s" does not exist.', $componentName);
 
             $alternativeComponents = $this->getAlternativeComponents($kit, $componentName);
@@ -120,7 +124,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             }
         }
 
-        $this->io->text(\sprintf('Installing component <info>%s</>...', $component->name));
+        $io->writeln(\sprintf('Installing component <info>%s</> from the <info>%s</> kit...', $component->name, $kitName));
 
         $installer = new Installer($this->filesystem, fn (string $question) => $this->io->confirm($question, $input->isInteractive()));
         $installationReport = $installer->installComponent($kit, $component, $destinationPath = $input->getOption('destination'), $input->getOption('force'));
@@ -144,7 +148,25 @@ protected function execute(InputInterface $input, OutputInterface $output): int
     }
 
     /**
-     * Get alternative components that are similar to the given component name.
+     * @return list<Component>
+     */
+    private function getAvailableComponents(Kit $kit): array
+    {
+        $availableComponents = [];
+
+        foreach ($kit->getComponents() as $component) {
+            if (str_contains($component->name, ':')) {
+                continue;
+            }
+
+            $availableComponents[] = $component;
+        }
+
+        return $availableComponents;
+    }
+
+    /**
+     * @return list<Component>
      */
     private function getAlternativeComponents(Kit $kit, string $componentName): array
     {

src/Toolkit/src/Command/InstallComponentCommand.php

@@ -12,7 +12,7 @@
 namespace Symfony\UX\Toolkit\Dependency;
 
 /**
- * Represents a version number, following a simplified version of the SemVer specification.
+ * Represents a version number, following the SemVer specification.
  *
  * @internal
  *
@@ -21,26 +21,20 @@
 final class Version implements \Stringable
 {
     /**
-     * @param int<0, max> $major
-     * @param int<0, max> $minor
-     * @param int<0, max> $patch
+     * @param non-empty-string
      */
     public function __construct(
-        public readonly int $major,
-        public readonly int $minor,
-        public readonly int $patch,
+        public readonly string $value,
     ) {
     }
 
     public function isHigherThan(self $version): bool
     {
-        return $this->major > $version->major
-            || ($this->major === $version->major && $this->minor > $version->minor)
-            || ($this->major === $version->major && $this->minor === $version->minor && $this->patch > $version->patch);
+        return version_compare($this->value, $version->value, '>');
     }
 
     public function __toString(): string
     {
-        return \sprintf('%d.%d.%d', $this->major, $this->minor, $this->patch);
+        return $this->value;
     }
 }

src/Toolkit/src/Command/LintKitCommand.php

@@ -106,7 +106,7 @@ private function resolveComponentDependencies(Kit $kit, Component $component): v
             if (FileType::Twig === $file->type) {
                 if (str_contains($fileContent, 'html_cva')) {
                     $component->addDependency(new PhpPackageDependency('twig/extra-bundle'));
-                    $component->addDependency(new PhpPackageDependency('twig/html-extra', new Version(3, 12, 0)));
+                    $component->addDependency(new PhpPackageDependency('twig/html-extra', new Version('3.12.0')));
                 }
 
                 if (str_contains($fileContent, 'tailwind_merge')) {