Improve ImportIconCommand

- handle same prefix icons per batchs
- improve feedback

Author: smnandre

src/Icons/src/Command/ImportIconCommand.php

@@ -18,7 +18,6 @@
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Style\SymfonyStyle;
-use Symfony\UX\Icons\Exception\IconNotFoundException;
 use Symfony\UX\Icons\Iconify;
 use Symfony\UX\Icons\Registry\LocalSvgIconRegistry;
 
@@ -50,9 +49,9 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         $io = new SymfonyStyle($input, $output);
         $names = $input->getArgument('names');
         $result = Command::SUCCESS;
+        $importedIcons = 0;
 
         $prefixIcons = [];
-        $importedIcons = 0;
         foreach ($names as $name) {
             if (!preg_match('#^([\w-]+):([\w-]+)$#', $name, $matches)) {
                 $io->error(\sprintf('Invalid icon name "%s".', $name));
@@ -61,10 +60,9 @@ protected function execute(InputInterface $input, OutputInterface $output): int
                 continue;
             }
 
-            [$fullName, $prefix, $name] = $matches;
-
+            [, $prefix, $name] = $matches;
             $prefixIcons[$prefix] ??= [];
-            $prefixIcons[$prefix][$name] = $fullName;
+            $prefixIcons[$prefix][$name] = $name;
         }
 
         foreach ($prefixIcons as $prefix => $icons) {
@@ -77,43 +75,50 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             }
 
             $metadata = $this->iconify->metadataFor($prefix);
-            $io->writeln([
-                "\n",
-                \sprintf(' IconSet: <fg=bright-white;bg=black>%s</> - %s', $metadata['name'], $prefix),
-                \sprintf('  (Licence: %s)', $metadata['license']['title']),
-                "\n",
-            ]);
-
-            foreach (array_chunk($icons, 25, true) as $iconBatch) {
-                foreach ($iconBatch as $name => $fullName) {
+            $io->newLine();
+            $io->writeln(\sprintf(' Icon set: %s (License: %s)', $metadata['name'], $metadata['license']['title']));
+
+            foreach ($this->iconify->chunk($prefix, \array_keys($icons)) as $iconNames) {
+
+                $cursor = new Cursor($output);
+                foreach ($iconNames as $name) {
                     $io->writeln(\sprintf('  Importing %s:%s ...', $prefix, $name));
                 }
+                $cursor->moveUp(count($iconNames));
 
                 try {
-                    $batchResults = $this->iconify->fetchIcons($prefix, $names);
-                } catch (IconNotFoundException $e) {
+                    $batchResults = $this->iconify->fetchIcons($prefix, $iconNames);
+                } catch (\InvalidArgumentException $e) {
+                    // At this point no exception should be thrown
                     $io->error($e->getMessage());
-                    $result = Command::FAILURE;
 
-                    continue;
+                    return COMMAND::FAILURE;
                 }
 
-                $cursor = new Cursor($output);
-                $cursor->moveUp(count($iconBatch));
+                foreach ($iconNames as $name) {
+                    $cursor->clearLineAfter();
+
+                    // If the icon is not found, the value will be null
+                    if (null === $icon = $batchResults[$name] ?? null) {
+                        $io->writeln(\sprintf(" <fg=red;options=bold>✗</> Not Found <fg=bright-white;bg=black>%s:</><fg=bright-red;bg=black>%s</>", $prefix, $name));
+
+                        continue;
+                    }
 
-                foreach ($batchResults as $name => $icon) {
-                    $this->registry->add(\sprintf('%s/%s', $prefix, $name), (string) $icon);
                     ++$importedIcons;
-                    $cursor->clearLine();
+                    $this->registry->add(\sprintf('%s/%s', $prefix, $name), (string) $icon);
                     $io->writeln(\sprintf(" <fg=bright-green;options=bold>✓</> Imported <fg=bright-white;bg=black>%s:</><fg=bright-magenta;bg=black;options>%s</>", $prefix, $name));
                 }
-
-                $cursor->clearLineAfter();
             }
         }
 
-        if (Command::SUCCESS === $result) {
-            $io->success(sprintf('Imported %d icons.', $importedIcons));
+        if ($importedIcons === $totalIcons = count($names)) {
+            $io->success(sprintf('Imported %d/%d icons.', $importedIcons, $totalIcons));
+        } elseif ($importedIcons > 0) {
+            $io->warning(sprintf('Imported %d/%d icons.', $importedIcons, $totalIcons));
+        } else {
+            $io->error(sprintf('Imported %d/%d icons.', $importedIcons, $totalIcons));
+            $result = Command::FAILURE;
         }
 
         return $result;

src/Icons/tests/Integration/Command/ImportIconCommandTest.php

@@ -23,7 +23,7 @@ final class ImportIconCommandTest extends KernelTestCase
     use InteractsWithConsole;
 
     private const ICON_DIR = __DIR__.'/../../Fixtures/icons';
-    private const ICONS = ['uiw/dashboard.svg'];
+    private const ICONS = ['uiw/dashboard.svg', 'lucide/circle.svg'];
 
     /**
      * @before
@@ -45,8 +45,8 @@ public function testCanImportIcon(): void
 
         $this->executeConsoleCommand('ux:icons:import uiw:dashboard')
             ->assertSuccessful()
-            ->assertOutputContains('Importing uiw:dashboard')
-            ->assertOutputContains("Imported uiw:dashboard (License: MIT). Render with: {{ ux_icon('uiw:dashboard') }}")
+            ->assertOutputContains('Icon set: uiw icons (License: MIT)')
+            ->assertOutputContains("Importing uiw:dashboard")
         ;
 
         $this->assertFileExists($expectedFile);
@@ -60,13 +60,34 @@ public function testImportInvalidIconName(): void
         ;
     }
 
-    public function testImportNonExistentIcon(): void
+    public function testImportNonExistentIconSet(): void
     {
         $this->executeConsoleCommand('ux:icons:import something:invalid')
             ->assertStatusCode(1)
-            ->assertOutputContains('[ERROR] The icon "something:invalid" does not exist on iconify.design.')
+            ->assertOutputContains('[ERROR] Icon set "something" not found.')
+        ;
+    }
+
+    public function testImportNonExistentIcon(): void
+    {
+        $this->executeConsoleCommand('ux:icons:import lucide:not-existing-icon')
+            ->assertStatusCode(1)
+            ->assertOutputContains('Not Found lucide:not-existing-icon')
+            ->assertOutputContains('[ERROR] Imported 0/1 icons.')
+        ;
+
+        $this->assertFileDoesNotExist(self::ICON_DIR.'/not-existing-icon.svg');
+    }
+
+    public function testImportNonExistentIconWithExistentOne(): void
+    {
+        $this->executeConsoleCommand('ux:icons:import lucide:circle lucide:not-existing-icon')
+            ->assertStatusCode(0)
+            ->assertOutputContains('Imported lucide:circle')
+            ->assertOutputContains('Not Found lucide:not-existing-icon')
+            ->assertOutputContains('[WARNING] Imported 1/2 icons.')
         ;
 
-        $this->assertFileDoesNotExist(self::ICON_DIR.'/invalid.svg');
+        $this->assertFileDoesNotExist(self::ICON_DIR.'/not-existing-icon.svg');
     }
 }