Add git-based template system spec and command stubs

aspire-template-index.json

@@ -0,0 +1,12 @@
+{
+  "$schema": "https://aka.ms/aspire/template-index-schema/v1",
+  "version": 1,
+  "templates": [
+    {
+      "name": "aspire-starter",
+      "path": "templates/aspire-starter",
+      "language": "csharp",
+      "tags": ["starter", "web", "api"]
+    }
+  ]
+}

src/Aspire.Cli/Commands/RootCommand.cs

@@ -133,6 +133,7 @@ public RootCommand(
         DocsCommand docsCommand,
         SecretCommand secretCommand,
         SdkCommand sdkCommand,
+        Template.TemplateCommand templateCommand,
         SetupCommand setupCommand,
 #if DEBUG
         RenderCommand renderCommand,
@@ -237,6 +238,11 @@ public RootCommand(
 
         Subcommands.Add(sdkCommand);
 
+        if (featureFlags.IsFeatureEnabled(KnownFeatures.GitTemplatesEnabled, false))
+        {
+            Subcommands.Add(templateCommand);
+        }
+
         // Replace the default --help action with grouped help output.
         // Add -v as a short alias for --version.
         foreach (var option in Options)

src/Aspire.Cli/Commands/Template/TemplateCommand.cs

@@ -0,0 +1,46 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using System.CommandLine;
+using System.CommandLine.Help;
+using Aspire.Cli.Configuration;
+using Aspire.Cli.Interaction;
+using Aspire.Cli.Telemetry;
+using Aspire.Cli.Utils;
+
+namespace Aspire.Cli.Commands.Template;
+
+internal sealed class TemplateCommand : BaseCommand
+{
+    internal override HelpGroup HelpGroup => HelpGroup.ToolsAndConfiguration;
+
+    public TemplateCommand(
+        TemplateListCommand listCommand,
+        TemplateSearchCommand searchCommand,
+        TemplateRefreshCommand refreshCommand,
+        TemplateNewManifestCommand newManifestCommand,
+        TemplateNewIndexCommand newIndexCommand,
+        TemplateTestCommand testCommand,
+        IFeatures features,
+        ICliUpdateNotifier updateNotifier,
+        CliExecutionContext executionContext,
+        IInteractionService interactionService,
+        AspireCliTelemetry telemetry)
+        : base("template", "Manage git-based Aspire templates", features, updateNotifier, executionContext, interactionService, telemetry)
+    {
+        Subcommands.Add(listCommand);
+        Subcommands.Add(searchCommand);
+        Subcommands.Add(refreshCommand);
+        Subcommands.Add(newManifestCommand);
+        Subcommands.Add(newIndexCommand);
+        Subcommands.Add(testCommand);
+    }
+
+    protected override bool UpdateNotificationsEnabled => false;
+
+    protected override Task<int> ExecuteAsync(ParseResult parseResult, CancellationToken cancellationToken)
+    {
+        new HelpAction().Invoke(parseResult);
+        return Task.FromResult(ExitCodeConstants.InvalidCommand);
+    }
+}

src/Aspire.Cli/Commands/Template/TemplateListCommand.cs

@@ -0,0 +1,70 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using System.CommandLine;
+using Aspire.Cli.Configuration;
+using Aspire.Cli.Interaction;
+using Aspire.Cli.Telemetry;
+using Aspire.Cli.Templating.Git;
+using Aspire.Cli.Utils;
+using Spectre.Console;
+
+namespace Aspire.Cli.Commands.Template;
+
+internal sealed class TemplateListCommand(
+    IGitTemplateIndexService indexService,
+    IFeatures features,
+    ICliUpdateNotifier updateNotifier,
+    CliExecutionContext executionContext,
+    IInteractionService interactionService,
+    AspireCliTelemetry telemetry)
+    : BaseCommand("list", "List available templates from all configured sources", features, updateNotifier, executionContext, interactionService, telemetry)
+{
+    protected override bool UpdateNotificationsEnabled => false;
+
+    protected override async Task<int> ExecuteAsync(ParseResult parseResult, CancellationToken cancellationToken)
+    {
+        using var activity = Telemetry.StartDiagnosticActivity("template-list");
+
+        IReadOnlyList<ResolvedTemplate> templates;
+        try
+        {
+            templates = await InteractionService.ShowStatusAsync(
+                ":magnifying_glass_tilted_right: Fetching templates...",
+                () => indexService.GetTemplatesAsync(cancellationToken: cancellationToken));
+        }
+        catch (Exception ex) when (ex is not OperationCanceledException)
+        {
+            Telemetry.RecordError("Failed to fetch template list", ex);
+            InteractionService.DisplayError("Failed to fetch templates. Check your network connection and try again.");
+            return 1;
+        }
+
+        activity?.AddTag("template.count", templates.Count);
+
+        if (templates.Count == 0)
+        {
+            InteractionService.DisplayMessage(KnownEmojis.Information, "No templates found. Try 'aspire template refresh' to update the index cache.");
+            return ExitCodeConstants.Success;
+        }
+
+        var table = new Table();
+        table.Border(TableBorder.Rounded);
+        table.AddColumn(new TableColumn("[bold]Name[/]").NoWrap());
+        table.AddColumn(new TableColumn("[bold]Source[/]"));
+        table.AddColumn(new TableColumn("[bold]Language[/]"));
+        table.AddColumn(new TableColumn("[bold]Tags[/]"));
+
+        foreach (var t in templates)
+        {
+            table.AddRow(
+                t.Entry.Name.EscapeMarkup(),
+                t.Source.Name.EscapeMarkup(),
+                (t.Entry.Language ?? "").EscapeMarkup(),
+                t.Entry.Tags is { Count: > 0 } ? string.Join(", ", t.Entry.Tags).EscapeMarkup() : "");
+        }
+
+        AnsiConsole.Write(table);
+        return ExitCodeConstants.Success;
+    }
+}

src/Aspire.Cli/Commands/Template/TemplateNewIndexCommand.cs

@@ -0,0 +1,78 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using System.CommandLine;
+using System.Text.Json;
+using Aspire.Cli.Configuration;
+using Aspire.Cli.Interaction;
+using Aspire.Cli.Telemetry;
+using Aspire.Cli.Templating.Git;
+using Aspire.Cli.Utils;
+
+namespace Aspire.Cli.Commands.Template;
+
+internal sealed class TemplateNewIndexCommand : BaseCommand
+{
+    private static readonly Argument<string?> s_pathArgument = new("path")
+    {
+        Description = "Directory to create aspire-template-index.json in (defaults to current directory)",
+        Arity = ArgumentArity.ZeroOrOne
+    };
+
+    public TemplateNewIndexCommand(
+        IFeatures features,
+        ICliUpdateNotifier updateNotifier,
+        CliExecutionContext executionContext,
+        IInteractionService interactionService,
+        AspireCliTelemetry telemetry)
+        : base("new-index", "Scaffold a new aspire-template-index.json index file", features, updateNotifier, executionContext, interactionService, telemetry)
+    {
+        Arguments.Add(s_pathArgument);
+    }
+
+    protected override bool UpdateNotificationsEnabled => false;
+
+    protected override async Task<int> ExecuteAsync(ParseResult parseResult, CancellationToken cancellationToken)
+    {
+        var targetDir = parseResult.GetValue(s_pathArgument) ?? Directory.GetCurrentDirectory();
+        targetDir = Path.GetFullPath(targetDir);
+
+        var outputPath = Path.Combine(targetDir, "aspire-template-index.json");
+
+        if (File.Exists(outputPath))
+        {
+            var overwrite = await InteractionService.ConfirmAsync(
+                $"aspire-template-index.json already exists in {targetDir}. Overwrite?",
+                defaultValue: false,
+                cancellationToken: cancellationToken).ConfigureAwait(false);
+
+            if (!overwrite)
+            {
+                InteractionService.DisplayMessage(KnownEmojis.Information, "Cancelled.");
+                return ExitCodeConstants.Success;
+            }
+        }
+
+        var index = new GitTemplateIndex
+        {
+            Schema = "https://aka.ms/aspire/template-index-schema/v1",
+            Templates =
+            [
+                new GitTemplateIndexEntry
+                {
+                    Name = "my-template",
+                    Path = "templates/my-template"
+                }
+            ]
+        };
+
+        Directory.CreateDirectory(targetDir);
+
+        var json = JsonSerializer.Serialize(index, GitTemplateJsonContext.RelaxedEscaping.GitTemplateIndex);
+        await File.WriteAllTextAsync(outputPath, json, cancellationToken).ConfigureAwait(false);
+
+        InteractionService.DisplaySuccess($"Created {outputPath}");
+        InteractionService.DisplayMessage(KnownEmojis.Information, "Edit the file to add your templates, then run 'aspire template new' in each template directory.");
+        return ExitCodeConstants.Success;
+    }
+}

src/Aspire.Cli/Commands/Template/TemplateNewManifestCommand.cs

@@ -0,0 +1,117 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using System.CommandLine;
+using System.Text.Json;
+using System.Text.RegularExpressions;
+using Aspire.Cli.Configuration;
+using Aspire.Cli.Interaction;
+using Aspire.Cli.Telemetry;
+using Aspire.Cli.Templating.Git;
+using Aspire.Cli.Utils;
+using Spectre.Console;
+
+namespace Aspire.Cli.Commands.Template;
+
+internal sealed partial class TemplateNewManifestCommand : BaseCommand
+{
+    private static readonly Argument<string?> s_pathArgument = new("path")
+    {
+        Description = "Directory to create aspire-template.json in (defaults to current directory)",
+        Arity = ArgumentArity.ZeroOrOne
+    };
+
+    public TemplateNewManifestCommand(
+        IFeatures features,
+        ICliUpdateNotifier updateNotifier,
+        CliExecutionContext executionContext,
+        IInteractionService interactionService,
+        AspireCliTelemetry telemetry)
+        : base("new", "Scaffold a new aspire-template.json manifest", features, updateNotifier, executionContext, interactionService, telemetry)
+    {
+        Arguments.Add(s_pathArgument);
+    }
+
+    protected override bool UpdateNotificationsEnabled => false;
+
+    protected override async Task<int> ExecuteAsync(ParseResult parseResult, CancellationToken cancellationToken)
+    {
+        var targetDir = parseResult.GetValue(s_pathArgument) ?? Directory.GetCurrentDirectory();
+        targetDir = Path.GetFullPath(targetDir);
+
+        var outputPath = Path.Combine(targetDir, "aspire-template.json");
+
+        if (File.Exists(outputPath))
+        {
+            var overwrite = await InteractionService.ConfirmAsync(
+                $"aspire-template.json already exists in {targetDir}. Overwrite?",
+                defaultValue: false,
+                cancellationToken: cancellationToken).ConfigureAwait(false);
+
+            if (!overwrite)
+            {
+                InteractionService.DisplayMessage(KnownEmojis.Information, "Cancelled.");
+                return ExitCodeConstants.Success;
+            }
+        }
+
+        var name = await InteractionService.PromptForStringAsync(
+            "Template name (kebab-case identifier)",
+            defaultValue: Path.GetFileName(targetDir)?.ToLowerInvariant(),
+            validator: value => KebabCasePattern().IsMatch(value)
+                ? ValidationResult.Success()
+                : ValidationResult.Error("Must be lowercase kebab-case (e.g. my-template)"),
+            required: true,
+            cancellationToken: cancellationToken).ConfigureAwait(false);
+
+        var canonicalName = ToPascalCase(name);
+
+        var manifest = new GitTemplateManifest
+        {
+            Schema = "https://aka.ms/aspire/template-schema/v1",
+            Name = name,
+            Variables = new Dictionary<string, GitTemplateVariable>
+            {
+                ["projectName"] = new()
+                {
+                    Type = "string",
+                    Required = true,
+                    DefaultValue = canonicalName,
+                    Validation = new GitTemplateVariableValidation
+                    {
+                        Pattern = "^[A-Za-z][A-Za-z0-9_.]*$",
+                    }
+                }
+            },
+            Substitutions = new GitTemplateSubstitutions
+            {
+                Filenames = new Dictionary<string, string>
+                {
+                    [canonicalName] = "{{projectName}}"
+                },
+                Content = new Dictionary<string, string>
+                {
+                    [canonicalName] = "{{projectName}}",
+                    [canonicalName.ToLowerInvariant()] = "{{projectName | lowercase}}"
+                }
+            }
+        };
+
+        Directory.CreateDirectory(targetDir);
+
+        var json = JsonSerializer.Serialize(manifest, GitTemplateJsonContext.RelaxedEscaping.GitTemplateManifest);
+        await File.WriteAllTextAsync(outputPath, json, cancellationToken).ConfigureAwait(false);
+
+        InteractionService.DisplaySuccess($"Created {outputPath}");
+        return ExitCodeConstants.Success;
+    }
+
+    private static string ToPascalCase(string kebab)
+    {
+        return string.Concat(kebab.Split('-').Select(part =>
+            part.Length == 0 ? "" : char.ToUpperInvariant(part[0]) + part[1..]));
+    }
+
+    [GeneratedRegex("^[a-z][a-z0-9]*(-[a-z0-9]+)*$")]
+    private static partial Regex KebabCasePattern();
+}

src/Aspire.Cli/Commands/Template/TemplateRefreshCommand.cs

@@ -0,0 +1,48 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using System.CommandLine;
+using Aspire.Cli.Configuration;
+using Aspire.Cli.Interaction;
+using Aspire.Cli.Telemetry;
+using Aspire.Cli.Templating.Git;
+using Aspire.Cli.Utils;
+
+namespace Aspire.Cli.Commands.Template;
+
+internal sealed class TemplateRefreshCommand(
+    IGitTemplateIndexService indexService,
+    IFeatures features,
+    ICliUpdateNotifier updateNotifier,
+    CliExecutionContext executionContext,
+    IInteractionService interactionService,
+    AspireCliTelemetry telemetry)
+    : BaseCommand("refresh", "Force refresh the template index cache", features, updateNotifier, executionContext, interactionService, telemetry)
+{
+    protected override bool UpdateNotificationsEnabled => false;
+
+    protected override async Task<int> ExecuteAsync(ParseResult parseResult, CancellationToken cancellationToken)
+    {
+        using var activity = Telemetry.StartDiagnosticActivity("template-refresh");
+
+        try
+        {
+            await InteractionService.ShowStatusAsync(
+                ":counterclockwise_arrows_button: Refreshing template index cache...",
+                async () =>
+                {
+                    await indexService.RefreshAsync(cancellationToken);
+                    return 0;
+                });
+        }
+        catch (Exception ex) when (ex is not OperationCanceledException)
+        {
+            Telemetry.RecordError("Failed to refresh template cache", ex);
+            InteractionService.DisplayError("Failed to refresh template cache. Check your network connection and try again.");
+            return 1;
+        }
+
+        InteractionService.DisplaySuccess("Template index cache refreshed.");
+        return ExitCodeConstants.Success;
+    }
+}