Adding a graphqlite:export-schema command

src/Console/Commands/GraphqliteExportSchema.php

@@ -0,0 +1,58 @@
+<?php
+
+namespace TheCodingMachine\GraphQLite\Laravel\Console\Commands;
+
+use GraphQL\Utils\SchemaPrinter;
+use Illuminate\Console\Command;
+use TheCodingMachine\GraphQLite\Schema;
+
+/**
+ * A command to export the GraphQL schema in "Schema Definition Language" (SDL) format.
+ */
+class GraphqliteExportSchema extends Command
+{
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'graphqlite:export-schema {--O|output= : Output file name. If not specified, prints on stdout}';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Exports the GraphQL schema in "Schema Definition Language" (SDL) format.';
+
+    public function __construct(private Schema $schema)
+    {
+        parent::__construct();
+    }
+
+    /**
+     * Execute the console command.
+     *
+     * @return int
+     */
+    public function handle()
+    {
+        $output = $this->option('output');
+
+        $sdl = SchemaPrinter::doPrint($this->schema, [
+            "sortArguments" => true,
+            "sortEnumValues" => true,
+            "sortFields" => true,
+            "sortInputFields" => true,
+            "sortTypes" => true,
+        ]);
+
+        if ($output === null) {
+            $this->line($sdl);
+        } else {
+            file_put_contents($output, $sdl);
+        }
+
+        return Command::SUCCESS;
+    }
+}

src/Providers/GraphQLiteServiceProvider.php

@@ -2,6 +2,8 @@
 
 namespace TheCodingMachine\GraphQLite\Laravel\Providers;
 
+use GraphQL\Type\Definition\ObjectType;
+use GraphQL\Type\SchemaConfig;
 use Illuminate\Contracts\Auth\Access\Gate;
 use Illuminate\Contracts\Auth\Factory as AuthFactory;
 use Illuminate\Contracts\Events\Dispatcher;
@@ -21,6 +23,7 @@
 use TheCodingMachine\GraphQLite\Exceptions\WebonyxErrorHandler;
 use TheCodingMachine\GraphQLite\Http\HttpCodeDecider;
 use TheCodingMachine\GraphQLite\Http\HttpCodeDeciderInterface;
+use TheCodingMachine\GraphQLite\Laravel\Console\Commands\GraphqliteExportSchema;
 use TheCodingMachine\GraphQLite\Laravel\Listeners\CachePurger;
 use TheCodingMachine\GraphQLite\Laravel\Mappers\Parameters\ValidateFieldMiddleware;
 use TheCodingMachine\GraphQLite\Laravel\Mappers\PaginatorTypeMapper;
@@ -71,6 +74,10 @@ public function boot(Dispatcher $events)
      */
     public function register()
     {
+        $this->commands([
+            GraphqliteExportSchema::class,
+        ]);
+
         $this->app->bind(WebonyxSchema::class, Schema::class);
 
         if (!$this->app->has(ServerRequestFactoryInterface::class)) {
@@ -146,6 +153,14 @@ public function register()
 
             $service->addTypeMapperFactory($app[PaginatorTypeMapperFactory::class]);
 
+            // We need to configure an empty Subscription type to avoid an exception in the generate-schema command.
+            $config = SchemaConfig::create();
+            $config->setSubscription(new ObjectType([
+                'name' => 'Subscription',
+                'fields' => [],
+            ]));
+            $service->setSchemaConfig($config);
+
             $controllers = config('graphqlite.controllers', 'App\\Http\\Controllers');
             if (!is_iterable($controllers)) {
                 $controllers = [ $controllers ];

tests/Console/Commands/GraphqliteExportSchemaTest.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace TheCodingMachine\GraphQLite\Laravel\Console\Commands;
+
+
+use Orchestra\Testbench\TestCase;
+use TheCodingMachine\GraphQLite\Laravel\Providers\GraphQLiteServiceProvider;
+use TheCodingMachine\TDBM\TDBMService;
+
+
+class GraphqliteExportSchemaTest extends TestCase
+{
+    protected function getPackageProviders($app)
+    {
+        return [GraphQLiteServiceProvider::class];
+    }
+
+    public function testCommand(): void
+    {
+        $this->artisan('graphqlite:export-schema -O test.graphql')
+            ->assertExitCode(0);
+
+        $this->assertFileExists('test.graphql');
+        $content = file_get_contents('test.graphql');
+        $this->assertStringContainsString('type Query {', $content);
+        unlink('test.graphql');
+    }
+}