Merge pull request #118 from context-hub/feature/json-schema-init

JSON Schema Support for IDE Autocompletion

Author: butschster

src/Application/JsonSchema.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Butschster\ContextGenerator\Application;
+
+final readonly class JsonSchema
+{
+    /**
+     * The URL where the JSON schema is hosted
+     */
+    public const string SCHEMA_URL = 'https://raw.githubusercontent.com/context-hub/generator/refs/heads/main/json-schema.json';
+}

src/Config/Registry/ConfigRegistry.php

@@ -7,11 +7,15 @@
 /**
  * Container for all registries
  */
-final class ConfigRegistry
+final class ConfigRegistry implements \JsonSerializable
 {
     /** @var array<string, RegistryInterface> */
     private array $registries = [];
 
+    public function __construct(
+        private readonly ?string $schema = null,
+    ) {}
+
     /**
      * Register a new registry
      */
@@ -65,4 +69,20 @@ public function all(): array
     {
         return $this->registries;
     }
+
+    public function jsonSerialize(): array
+    {
+        $data = [
+            '$schema' => $this->schema,
+        ];
+
+        foreach ($this->registries as $type => $registry) {
+            $data[$type] = $registry;
+        }
+
+        return \array_filter(
+            $data,
+            static fn($value) => $value !== null && $value !== [],
+        );
+    }
 }

src/Console/InitCommand.php

@@ -4,7 +4,9 @@
 
 namespace Butschster\ContextGenerator\Console;
 
+use Butschster\ContextGenerator\Application\JsonSchema;
 use Butschster\ContextGenerator\Config\ConfigType;
+use Butschster\ContextGenerator\Config\Registry\ConfigRegistry;
 use Butschster\ContextGenerator\Directories;
 use Butschster\ContextGenerator\Document\Document;
 use Butschster\ContextGenerator\Document\DocumentRegistry;
@@ -51,7 +53,11 @@ public function __invoke(Directories $dirs, FilesInterface $files): int
             return Command::FAILURE;
         }
 
-        $content = new DocumentRegistry([
+        $config = new ConfigRegistry(
+            schema: JsonSchema::SCHEMA_URL,
+        );
+
+        $config->register(new DocumentRegistry([
             new Document(
                 description: 'Project structure overview',
                 outputPath: 'project-structure.md',
@@ -62,13 +68,13 @@ public function __invoke(Directories $dirs, FilesInterface $files): int
                     ),
                 ),
             ),
-        ]);
+        ]));
 
         try {
             $content = match ($type) {
-                ConfigType::Json => \json_encode($content, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES),
+                ConfigType::Json => \json_encode($config, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES),
                 ConfigType::Yaml => Yaml::dump(
-                    \json_decode(\json_encode($content), true),
+                    \json_decode(\json_encode($config), true),
                     10,
                     2,
                     Yaml::DUMP_MULTI_LINE_LITERAL_BLOCK,

src/Console/SchemaCommand.php

@@ -4,6 +4,7 @@
 
 namespace Butschster\ContextGenerator\Console;
 
+use Butschster\ContextGenerator\Application\JsonSchema;
 use Butschster\ContextGenerator\Directories;
 use Butschster\ContextGenerator\Lib\HttpClient\Exception\HttpException;
 use Butschster\ContextGenerator\Lib\HttpClient\HttpClientInterface;
@@ -19,11 +20,6 @@
 )]
 final class SchemaCommand extends BaseCommand
 {
-    /**
-     * The URL where the JSON schema is hosted
-     */
-    private const string SCHEMA_URL = 'https://raw.githubusercontent.com/context-hub/generator/refs/heads/main/json-schema.json';
-
     #[Option(
         name: 'download',
         shortcut: 'd',
@@ -49,7 +45,7 @@ public function __invoke(
         $outputPath = $dirs->getFilePath($this->outputPath);
 
         // Always show the URL where the schema is hosted
-        $this->output->info('JSON schema URL: ' . self::SCHEMA_URL);
+        $this->output->info('JSON schema URL: ' . JsonSchema::SCHEMA_URL);
 
         // If no download requested, exit early
         if (!$this->download) {
@@ -59,7 +55,7 @@ public function __invoke(
 
         // Download and save the schema
         try {
-            $response = $httpClient->get(self::SCHEMA_URL, [
+            $response = $httpClient->get(JsonSchema::SCHEMA_URL, [
                 'User-Agent' => 'Context-Generator-Schema-Download',
                 'Accept' => 'application/json',
             ]);

src/Document/DocumentRegistry.php

@@ -38,8 +38,6 @@ public function getItems(): array
 
     public function jsonSerialize(): array
     {
-        return [
-            'documents' => $this->documents,
-        ];
+        return $this->documents;
     }
 }