Updated System.CommandLine in the AspNetCore.CommandLine project (#9083)

Author: glen-84

src/Directory.Packages.props

@@ -60,7 +60,7 @@
     <PackageVersion Include="Squadron.Redis" Version="0.27.1" />
     <PackageVersion Include="StackExchange.Redis" Version="2.6.80" />
     <PackageVersion Include="System.Collections.Immutable" Version="8.0.0" />
-    <PackageVersion Include="System.CommandLine" Version="2.0.0-beta4.22272.1" />
+    <PackageVersion Include="System.CommandLine" Version="2.0.2" />
     <PackageVersion Include="System.IdentityModel.Tokens.Jwt" Version="8.13.1" />
     <PackageVersion Include="System.Linq.Async" Version="6.0.3" />
     <PackageVersion Include="System.Reactive" Version="6.0.0" />

src/HotChocolate/AspNetCore/src/AspNetCore.CommandLine/App.cs

@@ -1,22 +1,67 @@
-using System.CommandLine.Builder;
+using System.CommandLine;
+using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Hosting;
 
 namespace HotChocolate.AspNetCore.CommandLine;
 
 /// <summary>
 /// A command line builder for the GraphQL server.
 /// </summary>
-internal sealed class App : CommandLineBuilder
+internal sealed class App
 {
+    private readonly IServiceProvider _serviceProvider;
+
     /// <summary>
     /// Initializes a new instance of <see cref="App"/>.
     /// </summary>
     /// <param name="host">
     /// The host that is used to resolve services from the GraphQL Server.
     /// </param>
-    public App(IHost host) : base(new GraphQLRootCommand())
+    public App(IHost host)
     {
-        this.AddMiddleware(x => x.BindingContext.AddService(_ => host))
-            .UseDefaults();
+        var serviceCollection = new ServiceCollection();
+        serviceCollection.AddSingleton(host);
+        serviceCollection.AddSingleton<ExportCommand>();
+        serviceCollection.AddSingleton<ListCommand>();
+        serviceCollection.AddSingleton<PrintCommand>();
+        serviceCollection.AddSingleton<SchemaCommand>();
+        serviceCollection.AddSingleton<GraphQLRootCommand>();
+        _serviceProvider = serviceCollection.BuildServiceProvider();
+    }
+
+    public int Invoke(string args, TextWriter? output = null)
+    {
+        var rootCommand = _serviceProvider.GetRequiredService<GraphQLRootCommand>();
+        var parseResult = rootCommand.Parse(args);
+        var configuration = output is null ? null : new InvocationConfiguration { Output = output };
+
+        return parseResult.Invoke(configuration);
+    }
+
+    public int Invoke(string[] args, TextWriter? output = null)
+    {
+        var rootCommand = _serviceProvider.GetRequiredService<GraphQLRootCommand>();
+        var parseResult = rootCommand.Parse(args);
+        var configuration = output is null ? null : new InvocationConfiguration { Output = output };
+
+        return parseResult.Invoke(configuration);
+    }
+
+    public async Task<int> InvokeAsync(string[] args, TextWriter? output = null)
+    {
+        var rootCommand = _serviceProvider.GetRequiredService<GraphQLRootCommand>();
+        var parseResult = rootCommand.Parse(args);
+        var configuration = output is null ? null : new InvocationConfiguration { Output = output };
+
+        return await parseResult.InvokeAsync(configuration);
+    }
+
+    public async Task<int> InvokeAsync(string args, TextWriter? output = null)
+    {
+        var rootCommand = _serviceProvider.GetRequiredService<GraphQLRootCommand>();
+        var parseResult = rootCommand.Parse(args);
+        var configuration = output is null ? null : new InvocationConfiguration { Output = output };
+
+        return await parseResult.InvokeAsync(configuration);
     }
 }

src/HotChocolate/AspNetCore/src/AspNetCore.CommandLine/Command/ExportCommand.cs

@@ -14,26 +14,28 @@ internal sealed class ExportCommand : Command
     /// <summary>
     /// Initializes a new instance of the <see cref="ExportCommand"/> class.
     /// </summary>
-    public ExportCommand() : base("export")
+    public ExportCommand(IHost host) : base("export")
     {
         Description = "Export the graphql schema to a schema file";
 
-        AddOption(Opt<OutputOption>.Instance);
-        AddOption(Opt<SchemaNameOption>.Instance);
+        Options.Add(Opt<OutputOption>.Instance);
+        Options.Add(Opt<SchemaNameOption>.Instance);
 
-        this.SetHandler(
-            ExecuteAsync,
-            Bind.FromServiceProvider<IConsole>(),
-            Bind.FromServiceProvider<IHost>(),
-            Opt<OutputOption>.Instance,
-            Opt<SchemaNameOption>.Instance,
-            Bind.FromServiceProvider<CancellationToken>());
+        SetAction(
+            (parseResult, cancellationToken) =>
+            {
+                var output = parseResult.InvocationConfiguration.Output;
+                var outputFile = parseResult.GetValue(Opt<OutputOption>.Instance);
+                var schemaName = parseResult.GetValue(Opt<SchemaNameOption>.Instance);
+
+                return ExecuteAsync(output, host, outputFile, schemaName, cancellationToken);
+            });
     }
 
     private static async Task ExecuteAsync(
-        IConsole console,
+        TextWriter output,
         IHost host,
-        FileInfo? output,
+        FileInfo? outputFile,
         string? schemaName,
         CancellationToken cancellationToken)
     {
@@ -45,7 +47,7 @@ private static async Task ExecuteAsync(
 
             if (schemaNames.IsEmpty)
             {
-                console.WriteLine("No schemas registered.");
+                await output.WriteLineAsync("No schemas registered.");
                 return;
             }
 
@@ -55,13 +57,11 @@ private static async Task ExecuteAsync(
         }
 
         var executor = await provider.GetExecutorAsync(schemaName, cancellationToken);
-        output ??= new FileInfo(System.IO.Path.Combine(Environment.CurrentDirectory, "schema.graphqls"));
-        var result = await SchemaFileExporter.Export(output.FullName, executor, cancellationToken);
+        outputFile ??= new FileInfo(System.IO.Path.Combine(Environment.CurrentDirectory, "schema.graphqls"));
+        var result = await SchemaFileExporter.Export(outputFile.FullName, executor, cancellationToken);
 
-        // ReSharper disable LocalizableElement
-        console.WriteLine("Exported Files:");
-        console.WriteLine($"- {result.SchemaFileName}");
-        console.WriteLine($"- {result.SettingsFileName}");
-        // ReSharper restore LocalizableElement
+        await output.WriteLineAsync("Exported Files:");
+        await output.WriteLineAsync($"- {result.SchemaFileName}");
+        await output.WriteLineAsync($"- {result.SettingsFileName}");
     }
 }

src/HotChocolate/AspNetCore/src/AspNetCore.CommandLine/Command/GraphQLRootCommand.cs

@@ -5,15 +5,15 @@ namespace HotChocolate.AspNetCore.CommandLine;
 /// <summary>
 /// The root command of the GraphQL CLI.
 /// </summary>
-internal sealed class GraphQLRootCommand : Command
+internal sealed class GraphQLRootCommand : RootCommand
 {
     /// <summary>
     /// Initializes a new instance of <see cref="GraphQLRootCommand"/>.
     /// </summary>
-    public GraphQLRootCommand() : base("graphql")
+    public GraphQLRootCommand(SchemaCommand schemaCommand)
     {
         Description = "A command line tool for a GraphQL Server.";
 
-        AddCommand(new SchemaCommand());
+        Subcommands.Add(schemaCommand);
     }
 }

src/HotChocolate/AspNetCore/src/AspNetCore.CommandLine/Command/ListCommand.cs

@@ -6,42 +6,33 @@
 namespace HotChocolate.AspNetCore.CommandLine;
 
 /// <summary>
-/// The export command can be used to export the schema to a file.
+/// The list command can be used to list all registered schemas.
 /// </summary>
 internal sealed class ListCommand : Command
 {
     /// <summary>
-    /// Initializes a new instance of the <see cref="ExportCommand"/> class.
+    /// Initializes a new instance of the <see cref="ListCommand"/> class.
     /// </summary>
-    public ListCommand() : base("list")
+    public ListCommand(IHost host) : base("list")
     {
         Description = "List all registered GraphQL schemas.";
 
-        this.SetHandler(
-            ExecuteAsync,
-            Bind.FromServiceProvider<IConsole>(),
-            Bind.FromServiceProvider<IHost>(),
-            Bind.FromServiceProvider<CancellationToken>());
+        SetAction(parseResult => ExecuteAsync(parseResult.InvocationConfiguration.Output, host));
     }
 
-    private static Task ExecuteAsync(
-        IConsole console,
-        IHost host,
-        CancellationToken cancellationToken)
+    private static async Task ExecuteAsync(TextWriter output, IHost host)
     {
         var schemaNames = host.Services.GetRequiredService<IRequestExecutorProvider>().SchemaNames;
 
         if (schemaNames.IsEmpty)
         {
-            console.WriteLine("No schemas registered.");
-            return Task.CompletedTask;
+            await output.WriteLineAsync("No schemas registered.");
+            return;
         }
 
         foreach (var name in schemaNames)
         {
-            console.WriteLine(name);
+            await output.WriteLineAsync(name);
         }
-
-        return Task.CompletedTask;
     }
 }

src/HotChocolate/AspNetCore/src/AspNetCore.CommandLine/Command/PrintCommand.cs

@@ -6,29 +6,31 @@
 namespace HotChocolate.AspNetCore.CommandLine;
 
 /// <summary>
-/// The print command can be used to print the schema to the console output
+/// The print command can be used to print the schema to the console output.
 /// </summary>
 internal sealed class PrintCommand : Command
 {
     /// <summary>
-    /// Initializes a new instance of the <see cref="ExportCommand"/> class.
+    /// Initializes a new instance of the <see cref="PrintCommand"/> class.
     /// </summary>
-    public PrintCommand() : base("print")
+    public PrintCommand(IHost host) : base("print")
     {
         Description = "Prints the graphql schema to the console output";
 
-        AddOption(Opt<SchemaNameOption>.Instance);
+        Options.Add(Opt<SchemaNameOption>.Instance);
 
-        this.SetHandler(
-            ExecuteAsync,
-            Bind.FromServiceProvider<IConsole>(),
-            Bind.FromServiceProvider<IHost>(),
-            Opt<SchemaNameOption>.Instance,
-            Bind.FromServiceProvider<CancellationToken>());
+        SetAction(
+            (parseResult, cancellationToken) =>
+            {
+                var output = parseResult.InvocationConfiguration.Output;
+                var schemaName = parseResult.GetValue(Opt<SchemaNameOption>.Instance);
+
+                return ExecuteAsync(output, host, schemaName, cancellationToken);
+            });
     }
 
     private static async Task ExecuteAsync(
-        IConsole console,
+        TextWriter output,
         IHost host,
         string? schemaName,
         CancellationToken cancellationToken)
@@ -41,7 +43,7 @@ private static async Task ExecuteAsync(
 
             if (schemaNames.IsEmpty)
             {
-                console.WriteLine("No schemas registered.");
+                await output.WriteLineAsync("No schemas registered.");
                 return;
             }
 
@@ -51,6 +53,6 @@ private static async Task ExecuteAsync(
         }
 
         var executor = await provider.GetExecutorAsync(schemaName, cancellationToken);
-        console.WriteLine(executor.Schema.ToString());
+        await output.WriteLineAsync(executor.Schema.ToString());
     }
 }

src/HotChocolate/AspNetCore/src/AspNetCore.CommandLine/Command/SchemaCommand.cs

@@ -3,19 +3,22 @@
 namespace HotChocolate.AspNetCore.CommandLine;
 
 /// <summary>
-/// The schema command
+/// The schema command.
 /// </summary>
 internal sealed class SchemaCommand : Command
 {
     /// <summary>
     /// Initializes a new instance of <see cref="SchemaCommand"/>.
     /// </summary>
-    public SchemaCommand() : base("schema")
+    public SchemaCommand(
+        ExportCommand exportCommand,
+        ListCommand listCommand,
+        PrintCommand printCommand) : base("schema")
     {
         Description = "Schema management commands.";
 
-        AddCommand(new ExportCommand());
-        AddCommand(new PrintCommand());
-        AddCommand(new ListCommand());
+        Subcommands.Add(exportCommand);
+        Subcommands.Add(listCommand);
+        Subcommands.Add(printCommand);
     }
 }

src/HotChocolate/AspNetCore/src/AspNetCore.CommandLine/Helpers/Bind.cs

@@ -57,7 +57,7 @@ public static async Task<int> RunWithGraphQLCommandsAsync(
     {
         if (args.IsGraphQLCommand())
         {
-            return await new App(host).Build().InvokeAsync(args);
+            return await new App(host).InvokeAsync(args);
         }
 
         await host.RunAsync();
@@ -82,7 +82,7 @@ public static int RunWithGraphQLCommands(
     {
         if (args.IsGraphQLCommand())
         {
-            return new App(host).Build().Invoke(args);
+            return new App(host).Invoke(args);
         }
 
         host.Run();

src/HotChocolate/AspNetCore/src/AspNetCore.CommandLine/WebApplicationExtensions.cs

@@ -0,0 +1,14 @@
+using System.Text.RegularExpressions;
+
+namespace HotChocolate.AspNetCore.CommandLine;
+
+internal static partial class OutputHelper
+{
+    public static string ReplaceExecutableName(string output)
+    {
+        return ExecutableNameRegex().Replace(output, "$1  graphql");
+    }
+
+    [GeneratedRegex(@"(Usage:\r?\n)  [\w]+")]
+    private static partial Regex ExecutableNameRegex();
+}