Update to components v2 and improve UX

Author: KubaZ2

NetCordBuddy/Docs/DocsService.cs

@@ -166,13 +166,13 @@ void LoadMember(ISymbol symbol, string? parentId)
                 if (symbol is INamespaceOrTypeSymbol namespaceOrType)
                 {
                     if (namespaceOrType is ITypeSymbol)
-                        symbols.Add(new(id, null, docsUrl));
+                        symbols.Add(new(id, null, SymbolFormatter.GetQualifiedName(symbol), docsUrl));
 
                     foreach (var child in namespaceOrType.GetMembers())
                         LoadMember(child, id);
                 }
                 else
-                    symbols.Add(new(id, parentId, docsUrl));
+                    symbols.Add(new(id, parentId, SymbolFormatter.GetQualifiedName(symbol), docsUrl));
             }
         }
 

NetCordBuddy/Docs/DocsSymbolInfo.cs

@@ -2,12 +2,12 @@
 
 namespace NetCordBuddy.Docs;
 
-public partial class DocsSymbolInfo(string id, string? parentId, string docsUrl)
+public partial class DocsSymbolInfo(string id, string? parentId, string displayName, string docsUrl)
 {
     [GeneratedRegex(@"\W")]
     private static partial Regex GetFragmentRegex();
 
-    public string Name { get; } = id;
+    public string Name => displayName;
 
     public string DocsUrl { get; } = parentId is null ? $"{docsUrl}/{id.Replace('`', '-')}.html" : $"{docsUrl}/{parentId.Replace('`', '-')}.html#{GetFragmentRegex().Replace(id, "_")}";
 }

NetCordBuddy/Docs/SymbolFormatter.cs

@@ -109,7 +109,7 @@ private static ImmutableArray<SymbolDisplayPart> GetDisplayParts(
         }
         catch (InvalidOperationException)
         {
-            return ImmutableArray<SymbolDisplayPart>.Empty;
+            return [];
         }
 
         static ImmutableArray<SymbolDisplayPart> GetCastOperatorOverloadDisplayParts(ImmutableArray<SymbolDisplayPart> parts)
@@ -122,7 +122,7 @@ static ImmutableArray<SymbolDisplayPart> GetCastOperatorOverloadDisplayParts(Imm
                 if (part.Kind is SymbolDisplayPartKind.Keyword && part.ToString() is "operator" or "checked")
                     break;
             }
-            return parts.Take(endIndex + 1).ToImmutableArray();
+            return [.. parts.Take(endIndex + 1)];
         }
     }
 

…ddy/Modules/SlashCommands/DocsCommand.cs …dules/ApplicationCommands/DocsCommand.csNetCordBuddy/Modules/SlashCommands/DocsCommand.cs renamed to NetCordBuddy/Modules/ApplicationCommands/DocsCommand.cs NetCordBuddy/Modules/SlashCommands/DocsCommand.cs renamed to NetCordBuddy/Modules/ApplicationCommands/DocsCommand.cs

@@ -1,21 +1,22 @@
-using Microsoft.Extensions.Options;
+using Microsoft.CodeAnalysis;
+using Microsoft.Extensions.Options;
 
 using NetCord;
 using NetCord.Rest;
 using NetCord.Services.ApplicationCommands;
 
 using NetCordBuddy.Docs;
 
-namespace NetCordBuddy.Modules.SlashCommands;
+namespace NetCordBuddy.Modules.ApplicationCommands;
 
-public class DocsCommand(DocsService docsService, IOptions<Configuration> options) : ApplicationCommandModule<SlashCommandContext>
+public class DocsCommand(DocsService docsService, IOptions<Configuration> options) : ApplicationCommandModule<ApplicationCommandContext>
 {
     [SlashCommand("docs", "Allows you to search the documentation via Discord", IntegrationTypes = [ApplicationIntegrationType.GuildInstall, ApplicationIntegrationType.UserInstall])]
     public InteractionMessageProperties Docs([SlashCommandParameter(Description = "Search query", MaxLength = 90, AutocompleteProviderType = typeof(QueryAutocompleteProvider))] string query)
     {
         var config = options.Value;
-        return new InteractionMessageProperties().AddEmbeds(DocsHelper.CreateDocsEmbed(query, 0, docsService, config, Context.Interaction.Id, Context.User, out var more))
-                                                                      .WithComponents(DocsHelper.CreateDocsComponents(query, 0, more, config));
+        return new InteractionMessageProperties().AddComponents(DocsHelper.CreateDocsComponents(query, 0, docsService, config))
+                                                 .WithFlags(MessageFlags.IsComponentsV2);
     }
 
     private class QueryAutocompleteProvider(DocsService docsService) : IAutocompleteProvider<AutocompleteInteractionContext>

NetCordBuddy/Modules/ButtonInteractions/DocsInteraction.cs

@@ -8,14 +8,12 @@
 
 namespace NetCordBuddy.Modules.ButtonInteractions;
 
-public class DocsInteraction(DocsService docsService, IOptions<Configuration> options) : ComponentInteractionModule<ButtonInteractionContext>
+public class DocsInteraction(DocsService docsService, IOptions<Configuration> options) : ComponentInteractionModule<ComponentInteractionContext>
 {
     [ComponentInteraction("docs")]
     public InteractionCallback Docs(int page, string query)
     {
-        var interactionMetadata = Context.Message.InteractionMetadata!;
         var config = options.Value;
-        return InteractionCallback.ModifyMessage(m => m.AddEmbeds(DocsHelper.CreateDocsEmbed(query, page, docsService, config, interactionMetadata.Id, interactionMetadata.User, out var more))
-                                                       .WithComponents(DocsHelper.CreateDocsComponents(query, page, more, config)));
+        return InteractionCallback.ModifyMessage(m => m.AddComponents(DocsHelper.CreateDocsComponents(query, page, docsService, config)));
     }
 }

NetCordBuddy/Modules/DocsHelper.cs

@@ -7,55 +7,42 @@ namespace NetCordBuddy.Modules;
 
 internal static class DocsHelper
 {
-    public static EmbedProperties CreateDocsEmbed(string query, int page, DocsService docsService, Configuration config, ulong interactionId, User interactionUser, out bool more)
+    public static IEnumerable<IComponentProperties> CreateDocsComponents(string query, int page, DocsService docsService, Configuration config)
     {
-        var results = docsService.FindSymbols(query, page * 5, 5, out more);
-
-        if (results.Count == 0)
-            throw new("No results found!");
-
-        var embedTitle = "Results";
-        var footerText = interactionUser.Username;
-
-        int length = embedTitle.Length + footerText.Length;
-
-        var embedFields = results
-            .Select(s => new EmbedFieldProperties()
-            {
-                Value = $"```cs\n{s.Name}```[Docs]({s.DocsUrl})",
-            })
-            .Where(f => f.Value!.Length <= 1024)
-            .TakeWhile(f => (length += f.Value!.Length) <= 6000);
-
-        return new()
-        {
-            Title = embedTitle,
-            Footer = new()
-            {
-                Text = footerText,
-                IconUrl = (interactionUser.HasAvatar ? interactionUser.GetAvatarUrl() : interactionUser.DefaultAvatarUrl).ToString(),
-            },
-            Fields = embedFields,
-            Timestamp = Snowflake.CreatedAt(interactionId),
-            Color = new(config.PrimaryColor),
-        };
-    }
+        var results = docsService.FindSymbols(query, page * 5, 5, out var more);
+
+        var container = new ComponentContainerProperties()
+            .WithAccentColor(new(config.PrimaryColor));
+
+        if (results.Count is 0)
+            return
+            [
+                container
+                    .AddComponents(new TextDisplayProperties("# No symbols found!"))
+            ];
+
+        var title = "# Symbols";
+
+        int length = title.Length;
+
+        var sections = results
+                .Select(s => new ComponentSectionProperties(new LinkButtonProperties(s.DocsUrl, "Docs"))
+                                .AddComponents(new TextDisplayProperties($"```cs\n{s.Name}```")))
+                .TakeWhile(s => (length += s.Components.First().Content.Length) <= 4000);
 
-    public static IEnumerable<MessageComponentProperties> CreateDocsComponents(string query, int page, bool more, Configuration config)
-    {
         return
         [
-            new ActionRowProperties(
-            [
-                new ButtonProperties($"docs:{page - 1}:{query}", new EmojiProperties(config.Emojis.Left), ButtonStyle.Primary)
-                {
-                    Disabled = page < 1,
-                },
-                new ButtonProperties($"docs:{page + 1}:{query}", new EmojiProperties(config.Emojis.Right), ButtonStyle.Primary)
-                {
-                    Disabled = !more,
-                },
-            ]),
+            container
+                .AddComponents(new TextDisplayProperties(title))
+                .AddComponents(sections)
+                .AddComponents(new ActionRowProperties()
+                    .AddButtons(
+                        new ButtonProperties($"docs:{page - 1}:{query}", new EmojiProperties(config.Emojis.Left), ButtonStyle.Primary)
+                            .WithDisabled(page < 1),
+                        new ButtonProperties($"docs:{page + 1}:{query}", new EmojiProperties(config.Emojis.Right), ButtonStyle.Primary)
+                            .WithDisabled(!more)
+                    )
+                )
         ];
     }
 }

NetCordBuddy/NetCordBuddy.csproj

@@ -2,20 +2,20 @@
 
   <PropertyGroup>
     <OutputType>Exe</OutputType>
-    <TargetFramework>net8.0</TargetFramework>
+    <TargetFramework>net9.0</TargetFramework>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="4.9.2" />
-    <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="8.0.0" />
-    <PackageReference Include="Microsoft.Extensions.Hosting" Version="8.0.0" />
-    <PackageReference Include="Microsoft.Extensions.Http" Version="8.0.0" />
-    <PackageReference Include="NetCord" Version="1.0.0-alpha.292" />
-    <PackageReference Include="NetCord.Hosting" Version="1.0.0-alpha.62" />
-    <PackageReference Include="NetCord.Hosting.Services" Version="1.0.0-alpha.71" />
-    <PackageReference Include="NetCord.Services" Version="1.0.0-alpha.193" />
+    <PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="4.14.0" />
+    <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="9.0.5" />
+    <PackageReference Include="Microsoft.Extensions.Hosting" Version="9.0.5" />
+    <PackageReference Include="Microsoft.Extensions.Http" Version="9.0.5" />
+    <PackageReference Include="NetCord" Version="1.0.0-alpha.371" />
+    <PackageReference Include="NetCord.Hosting" Version="1.0.0-alpha.371" />
+    <PackageReference Include="NetCord.Hosting.Services" Version="1.0.0-alpha.371" />
+    <PackageReference Include="NetCord.Services" Version="1.0.0-alpha.371" />
   </ItemGroup>
 
   <ItemGroup>

NetCordBuddy/Program.cs

@@ -1,35 +1,31 @@
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Hosting;
 
-using NetCord;
 using NetCord.Hosting.Gateway;
 using NetCord.Hosting.Services;
 using NetCord.Hosting.Services.ApplicationCommands;
 using NetCord.Hosting.Services.ComponentInteractions;
-using NetCord.Services.ApplicationCommands;
-using NetCord.Services.ComponentInteractions;
 
 using NetCordBuddy;
 using NetCordBuddy.Docs;
 
 var builder = Host.CreateApplicationBuilder(args);
 
-builder.Services
+var services = builder.Services;
+
+services
     .AddOptions<Configuration>()
     .BindConfiguration(string.Empty)
     .ValidateOnStart()
     .ValidateDataAnnotations();
 
-builder.Services
+services
     .ConfigureHttpClientDefaults(b => b.RemoveAllLoggers())
     .AddSingleton<DocsService>()
     .AddHostedService(services => services.GetRequiredService<DocsService>())
-    .AddApplicationCommands<SlashCommandInteraction, SlashCommandContext, AutocompleteInteractionContext>()
-    .AddComponentInteractions<ButtonInteraction, ButtonInteractionContext>()
-    .AddDiscordGateway(options => options.Configuration = new()
-    {
-        Intents = 0,
-    });
+    .AddApplicationCommands()
+    .AddComponentInteractions()
+    .AddDiscordGateway(options => options.Intents = 0);
 
 var host = builder.Build()
     .AddModules(typeof(Program).Assembly)