[Toolkit] Big refactoring about the registry & kits system, kits architecture, and value-objects

- The registry system and JSON serialization were fully reworked, no more useless compilation to JSON
- Rename "default" theme to "shadcn"
- The "theme" term is now known as "kit"
useless JSON serialization
- Abuse ValueObjects usage for File, Example, Dependency, ...
 - Add binary for vendors

Author: Kocal

.github/workflows/test.yaml

@@ -90,6 +90,8 @@ jobs:
                     php-version: '8.1'
                   - component: Map/src/Bridge/Leaflet # does not support PHP 8.1
                     php-version: '8.1'
+                  - component: Toolkit # does not support PHP 8.1
+                    php-version: '8.1'
                   - component: Swup  # has no tests
                   - component: Turbo # has its own workflow (test-turbo.yml)
                   - component: Typed  # has no tests

biome.json

@@ -15,14 +15,7 @@
             "src/*/src/Bridge/*/assets/src/**",
             "src/*/src/Bridge/*/assets/test/**"
         ],
-        "ignore": [
-            "**/composer.json",
-            "**/vendor",
-            "**/package.json",
-            "**/node_modules",
-            "**/var",
-            "**/registry/default/**"
-        ]
+        "ignore": ["**/composer.json", "**/vendor", "**/package.json", "**/node_modules", "**/var"]
     },
     "linter": {
         "rules": {

src/Toolkit/Makefile

@@ -0,0 +1,45 @@
+#!/usr/bin/env php
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+if ('cli' !== \PHP_SAPI) {
+    throw new Exception('This script must be run from the command line.');
+}
+
+use Symfony\Component\Console\Application;
+use Symfony\Component\Filesystem\Filesystem;
+use Symfony\UX\Toolkit\Command\CreateKitCommand;
+
+function includeIfExists(string $file): bool
+{
+    return file_exists($file) && include $file;
+}
+
+if (
+    !includeIfExists(__DIR__ . '/../../../autoload.php') &&
+    !includeIfExists(__DIR__ . '/../vendor/autoload.php')
+) {
+    fwrite(STDERR, 'Install dependencies using Composer.'.PHP_EOL);
+    exit(1);
+}
+
+if (!class_exists(Application::class)) {
+    fwrite(STDERR, 'You need the "symfony/console" component in order to run the UX Toolkit kit linter.'.PHP_EOL);
+    exit(1);
+}
+
+$filesystem = new Filesystem();
+
+(new Application())->add($command = new CreateKitCommand($filesystem))
+    ->getApplication()
+    ->setDefaultCommand($command->getName(), true)
+    ->run()
+;

src/Toolkit/bin/build-registry.php

@@ -0,0 +1,61 @@
+#!/usr/bin/env php
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+if ('cli' !== \PHP_SAPI) {
+    throw new Exception('This script must be run from the command line.');
+}
+
+use Symfony\Component\Console\Application;
+use Symfony\Component\Filesystem\Filesystem;
+use Symfony\Component\HttpClient\HttpClient;
+use Symfony\Contracts\Service\ServiceLocatorTrait;
+use Symfony\Contracts\Service\ServiceProviderInterface;
+use Symfony\UX\Toolkit\Command\DebugKitCommand;
+use Symfony\UX\Toolkit\Dependency\DependenciesResolver;
+use Symfony\UX\Toolkit\Kit\KitFactory;
+use Symfony\UX\Toolkit\Registry\GitHubRegistry;
+use Symfony\UX\Toolkit\Registry\LocalRegistry;
+use Symfony\UX\Toolkit\Registry\RegistryFactory;
+use Symfony\UX\Toolkit\Registry\Type;
+
+function includeIfExists(string $file): bool
+{
+    return file_exists($file) && include $file;
+}
+
+if (
+    !includeIfExists(__DIR__ . '/../../../autoload.php') &&
+    !includeIfExists(__DIR__ . '/../vendor/autoload.php')
+) {
+    fwrite(STDERR, 'Install dependencies using Composer.'.PHP_EOL);
+    exit(1);
+}
+
+if (!class_exists(Application::class)) {
+    fwrite(STDERR, 'You need the "symfony/console" component in order to run the UX Toolkit kit linter.'.PHP_EOL);
+    exit(1);
+}
+
+$filesystem = new Filesystem();
+$kitFactory = new KitFactory($filesystem, new DependenciesResolver($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))
+    ->getApplication()
+    ->setDefaultCommand($command->getName(), true)
+    ->run()
+;

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

@@ -0,0 +1,61 @@
+#!/usr/bin/env php
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+if ('cli' !== \PHP_SAPI) {
+    throw new Exception('This script must be run from the command line.');
+}
+
+use Symfony\Component\Console\Application;
+use Symfony\Component\Filesystem\Filesystem;
+use Symfony\Component\HttpClient\HttpClient;
+use Symfony\Contracts\Service\ServiceLocatorTrait;
+use Symfony\Contracts\Service\ServiceProviderInterface;
+use Symfony\UX\Toolkit\Command\LintKitCommand;
+use Symfony\UX\Toolkit\Dependency\DependenciesResolver;
+use Symfony\UX\Toolkit\Kit\KitFactory;
+use Symfony\UX\Toolkit\Registry\GitHubRegistry;
+use Symfony\UX\Toolkit\Registry\LocalRegistry;
+use Symfony\UX\Toolkit\Registry\RegistryFactory;
+use Symfony\UX\Toolkit\Registry\Type;
+
+function includeIfExists(string $file): bool
+{
+    return file_exists($file) && include $file;
+}
+
+if (
+    !includeIfExists(__DIR__ . '/../../../autoload.php') &&
+    !includeIfExists(__DIR__ . '/../vendor/autoload.php')
+) {
+    fwrite(STDERR, 'Install dependencies using Composer.'.PHP_EOL);
+    exit(1);
+}
+
+if (!class_exists(Application::class)) {
+    fwrite(STDERR, 'You need the "symfony/console" component in order to run the UX Toolkit kit linter.'.PHP_EOL);
+    exit(1);
+}
+
+$filesystem = new Filesystem();
+$kitFactory = new KitFactory($filesystem, new DependenciesResolver($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 LintKitCommand($registryFactory))
+    ->getApplication()
+    ->setDefaultCommand($command->getName(), true)
+    ->run()
+;

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

@@ -31,10 +31,11 @@
     "php": ">=8.3",
     "twig/twig": "^2.12|^3.0",
     "symfony/console": "^6.4|^7.0",
+    "symfony/filesystem": "^6.4|^7.0",
     "symfony/framework-bundle": "^6.4|^7.0",
     "symfony/twig-bundle": "^6.4|^7.0",
     "symfony/ux-twig-component": "^2.23",
-    "symfony/filesystem": "^6.4|^7.0"
+    "symfony/yaml": "^6.4|^7.0"
   },
   "require-dev": {
     "symfony/finder": "6.4|^7.0",
@@ -46,6 +47,11 @@
     "symfony/stopwatch": "^6.4|^7.0",
     "symfony/phpunit-bridge": "^6.4|^7.0"
   },
+  "bin": [
+    "bin/ux-toolkit-kit-create",
+    "bin/ux-toolkit-kit-lint",
+    "bin/ux-toolkit-kit-debug"
+  ],
   "autoload": {
     "psr-4": {
       "Symfony\\UX\\Toolkit\\": "src"

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

@@ -11,86 +11,103 @@
 
 namespace Symfony\Component\DependencyInjection\Loader\Configurator;
 
+use Symfony\UX\Toolkit\Command\DebugKitCommand;
+use Symfony\UX\Toolkit\Command\InstallComponentCommand;
+use Symfony\UX\Toolkit\Command\InstallKitCommand;
+use Symfony\UX\Toolkit\Command\LintKitCommand;
+use Symfony\UX\Toolkit\Component\ComponentInstaller;
+use Symfony\UX\Toolkit\Dependency\DependenciesResolver;
+use Symfony\UX\Toolkit\Kit\KitFactory;
+use Symfony\UX\Toolkit\Registry\GitHubRegistry;
+use Symfony\UX\Toolkit\Registry\LocalRegistry;
+use Symfony\UX\Toolkit\Registry\RegistryFactory;
+use Symfony\UX\Toolkit\Registry\Type;
+
 /*
  * @author Hugo Alliaume <[email protected]>
  */
-
-use Symfony\UX\Toolkit\Command\BuildRegistryCommand;
-use Symfony\UX\Toolkit\Command\DebugUxToolkitCommand;
-use Symfony\UX\Toolkit\Command\UxToolkitInstallCommand;
-use Symfony\UX\Toolkit\Compiler\RegistryCompiler;
-use Symfony\UX\Toolkit\Compiler\TwigComponentCompiler;
-use Symfony\UX\Toolkit\ComponentRepository\CurrentTheme;
-use Symfony\UX\Toolkit\ComponentRepository\GithubRepository;
-use Symfony\UX\Toolkit\ComponentRepository\OfficialRepository;
-use Symfony\UX\Toolkit\ComponentRepository\RepositoryFactory;
-use Symfony\UX\Toolkit\ComponentRepository\RepositoryIdentifier;
-use Symfony\UX\Toolkit\Registry\DependenciesResolver;
-use Symfony\UX\Toolkit\Registry\RegistryFactory;
-
 return static function (ContainerConfigurator $container): void {
     $container->services()
-        ->set('.ux_toolkit.compiler.registry_compiler', RegistryCompiler::class)
+        // Commands
+
+        ->set('.ux_toolkit.command.debug_kit', DebugKitCommand::class)
             ->args([
-                service('filesystem')
+                service('.ux_toolkit.registry.factory'),
             ])
+            ->tag('console.command')
 
-        ->set('.ux_toolkit.compiler.twig_component_compiler', TwigComponentCompiler::class)
+        ->set('.ux_toolkit.command.install', InstallComponentCommand::class)
             ->args([
-                param('ux_toolkit.prefix'),
-                service('.ux_toolkit.registry.dependencies_resolver'),
-                service('filesystem'),
+                param('ux_toolkit.kit'),
+                service('.ux_toolkit.registry.factory'),
+                service('.ux_toolkit.component.component_installer'),
             ])
+            ->tag('console.command')
 
-        ->set('.ux_toolkit.component_repository.official_repository', OfficialRepository::class)
+        ->set('.ux_toolkit.command.install_kit', InstallKitCommand::class)
             ->args([
-                service('filesystem')
+                param('ux_toolkit.kit'),
+                service('.ux_toolkit.registry.factory'),
+                service('.ux_toolkit.component.component_installer'),
             ])
+            ->tag('console.command')
 
-        ->set('.ux_toolkit.component_repository.github_repository', GithubRepository::class)
+        ->set('.ux_toolkit.command.lint_kit', LintKitCommand::class)
             ->args([
-                service('filesystem'),
-                service('http_client')->nullOnInvalid(),
+                service('.ux_toolkit.registry.factory'),
             ])
+            ->tag('console.command')
+
+        // Registry
 
-        ->set('.ux_toolkit.component_repository.repository_factory', RepositoryFactory::class)
+        ->set('.ux_toolkit.registry.factory', RegistryFactory::class)
             ->args([
-                service('.ux_toolkit.component_repository.official_repository'),
-                service('.ux_toolkit.component_repository.github_repository'),
+                service_locator([
+                    Type::Local->value => service('.ux_toolkit.registry.local'),
+                    Type::GitHub->value => service('.ux_toolkit.registry.github'),
+                ]),
             ])
 
-        ->set('.ux_toolkit.component_repository.current_theme', CurrentTheme::class)
+        ->set('.ux_toolkit.registry.local', LocalRegistry::class)
             ->args([
-                param('ux_toolkit.theme'),
-                service('.ux_toolkit.component_repository.repository_factory'),
-                service('.ux_toolkit.component_repository.repository_identifier'),
+                service('.ux_toolkit.kit.kit_factory'),
+                service('filesystem'),
+                param('kernel.project_dir'),
             ])
 
-        ->set('.ux_toolkit.component_repository.repository_identifier', RepositoryIdentifier::class)
+        ->set('.ux_toolkit.registry.github', GitHubRegistry::class)
+            ->args([
+                service('.ux_toolkit.kit.kit_factory'),
+                service('filesystem'),
+                service('http_client')->nullOnInvalid(),
+            ])
 
-        ->set('.ux_toolkit.registry.dependencies_resolver', DependenciesResolver::class)
+        // Kit
 
-        ->set('.ux_toolkit.registry.registry_factory', RegistryFactory::class)
+        ->set('.ux_toolkit.kit.factory', KitFactory::class)
+            ->args([
+                service('filesystem'),
+                service('.ux_toolkit.dependency.dependencies_resolver'),
+            ])
 
-        ->set('.ux_toolkit.command.build_registry', BuildRegistryCommand::class)
+        ->set('.ux_toolkit.kit.kit_factory', KitFactory::class)
             ->args([
-                service('.ux_toolkit.compiler.registry_compiler')
+                service('filesystem'),
+                service('.ux_toolkit.dependency.dependencies_resolver'),
             ])
-            ->tag('console.command')
 
-        ->set('.ux_toolkit.command.install', UxToolkitInstallCommand::class)
+        // Component
+        ->set('.ux_toolkit.component.component_installer', ComponentInstaller::class)
             ->args([
-                service('.ux_toolkit.component_repository.current_theme'),
-                service('.ux_toolkit.registry.registry_factory'),
-                service('.ux_toolkit.compiler.twig_component_compiler'),
+                service('filesystem'),
             ])
-            ->tag('console.command')
 
-        ->set('.ux_toolkit.command.debug', DebugUxToolkitCommand::class)
+        // Dependency
+
+        ->set('.ux_toolkit.dependency.dependencies_resolver', DependenciesResolver::class)
             ->args([
-                service('.ux_toolkit.component_repository.current_theme'),
-                service('.ux_toolkit.registry.registry_factory'),
+                service('filesystem'),
             ])
-            ->tag('console.command')
+
     ;
 };