Fixed compilation errors caused by sample IDs not being transformed by the project template (#185)

* Added safety and diagnostics for detecting duplicate sample ids

* Renamed to prevent name conflicts

* Completed rename to prevent name conflicts

Author: Arlodotexe

common/CommunityToolkit.Labs.Core.SourceGenerators/Diagnostics/DiagnosticDescriptors.cs

@@ -19,7 +19,7 @@ public static class DiagnosticDescriptors
     /// </summary>
     public static readonly DiagnosticDescriptor SamplePaneOptionAttributeOnNonSample = new(
         id: "TKSMPL0001",
-        title: $"Invalid sample option delaration",
+        title: $"Invalid sample option declaration",
         messageFormat: $"Cannot generate sample pane options for type {{0}} as it does not use {nameof(Attributes.ToolkitSampleAttribute)}",
         category: typeof(ToolkitSampleMetadataGenerator).FullName,
         defaultSeverity: DiagnosticSeverity.Error,
@@ -34,7 +34,7 @@ public static class DiagnosticDescriptors
     /// </summary>
     public static readonly DiagnosticDescriptor SamplePaneOptionWithBadName = new(
         id: "TKSMPL0002",
-        title: $"Invalid sample option delaration",
+        title: $"Invalid sample option declaration",
         messageFormat: $"Cannot generate sample pane options for type {{0}} as the provided name is empty or invalid",
         category: typeof(ToolkitSampleMetadataGenerator).FullName,
         defaultSeverity: DiagnosticSeverity.Error,
@@ -205,4 +205,19 @@ public static class DiagnosticDescriptors
         defaultSeverity: DiagnosticSeverity.Warning,
         isEnabledByDefault: true,
         description: $"Document contains no interactive sample code.");
+
+    /// <summary>
+    /// Gets a <see cref="DiagnosticDescriptor"/> indicating a sample ID is already in use by another sample.
+    /// <para>
+    /// Format: <c>"Cannot generate sample with id {0} as the provided id is already in use by another sample"</c>.
+    /// </para>
+    /// </summary>
+    public static readonly DiagnosticDescriptor SampleIdAlreadyInUse = new(
+        id: "TKSMPL0015",
+        title: $"Sample ID already in use",
+        messageFormat: $"Cannot generate sample with id {{0}} as the provided id is already in use by another sample",
+        category: typeof(ToolkitSampleMetadataGenerator).FullName,
+        defaultSeverity: DiagnosticSeverity.Error,
+        isEnabledByDefault: true,
+        description: $"Cannot generate sample as the id is already in use by another sample.");
 }

common/CommunityToolkit.Labs.Core.SourceGenerators/ToolkitSampleMetadataGenerator.Sample.cs

@@ -104,6 +104,7 @@ void Execute(IncrementalValuesProvider<ISymbol> types, bool skipDiagnostics = fa
 
                 // Reconstruct sample metadata from attributes
                 var sampleMetadata = toolkitSampleAttributeData
+                     .GroupBy(x => x.Attribute.Id).Select(x => x.First()) // Filter out non-unique Ids. Diagnostics happen below.
                      .ToDictionary(
                         sample => sample.Attribute.Id,
                         sample =>
@@ -129,6 +130,9 @@ void Execute(IncrementalValuesProvider<ISymbol> types, bool skipDiagnostics = fa
                 {
                     CreateDocumentRegistry(ctx, docFrontMatter);
                     CreateSampleRegistry(ctx, sampleMetadata);
+
+                    // These diagnostics need to scan all symbols referenced from a sample head.
+                    ReportDiagnosticsForConflictingSampleId(ctx, toolkitSampleAttributeData);
                 }
             });
         }
@@ -177,6 +181,16 @@ private static void ReportDiagnosticsForInvalidAttributeUsage(SourceProductionCo
 
     }
 
+    private static void ReportDiagnosticsForConflictingSampleId(SourceProductionContext ctx,
+                                                              IEnumerable<(ToolkitSampleAttribute Attribute, string AttachedQualifiedTypeName, ISymbol Symbol)> toolkitSampleAttributeData)
+    {
+        foreach (var sampleIdGroup in toolkitSampleAttributeData.GroupBy(x => x.Attribute.Id))
+        {
+            if (sampleIdGroup.Count() > 1)
+                ctx.ReportDiagnostic(Diagnostic.Create(DiagnosticDescriptors.SampleIdAlreadyInUse, null, sampleIdGroup.Key));
+        }
+    }
+
     private static void ReportDiagnosticsForLinkedOptionsPane(SourceProductionContext ctx,
                                                               IEnumerable<(ToolkitSampleAttribute Attribute, string AttachedQualifiedTypeName, ISymbol Symbol)> toolkitSampleAttributeData,
                                                               IEnumerable<(ToolkitSampleOptionsPaneAttribute?, ISymbol)> optionsPaneAttribute)
@@ -212,7 +226,6 @@ private static void ReportDiagnosticsGeneratedOptionsPane(SourceProductionContex
         // Check for generated options with duplicate names.
         var generatedOptionsWithDuplicateName = generatedOptionPropertyData.GroupBy(x => x.Item1, SymbolEqualityComparer.Default) // Group by containing symbol (allow reuse across samples)
                                                                            .SelectMany(y => y.GroupBy(x => x.Item2.Name) // In this symbol, group options by name.
-                                                                                             .Where(x => x.Any(x => x.Item2 is not ToolkitSampleMultiChoiceOptionAttribute)) // Exclude Multichoice.
                                                                                              .Where(x => x.Count() > 1)); // Options grouped by name should only contain 1 item.
 
         foreach (var item in generatedOptionsWithDuplicateName)
@@ -245,9 +258,7 @@ public static class ToolkitSampleRegistry
 {{
     public static System.Collections.Generic.Dictionary<string, {typeof(ToolkitSampleMetadata).FullName}> Listing
     {{ get; }} = new() {{
-        {
-        string.Join(",\n        ", sampleMetadata.Select(MetadataToRegistryCall).ToArray())
-    }
+        {string.Join(",\n        ", sampleMetadata.Select(MetadataToRegistryCall).ToArray())}
     }};
 }}";
     }

template/lab/samples/ProjectTemplate.Sample/ProjectTemplate.md

@@ -31,7 +31,7 @@ TODO: Fill in information about this experiment and how to get started here...
 
 ### Custom style
 
-> [!SAMPLE TemplatedControlWithCustomStyleSample]
+> [!SAMPLE ProjectTemplateCustomStyleSample]
 
 # Templated Controls with x:Bind
 ### Implict style
@@ -40,5 +40,5 @@ TODO: Fill in information about this experiment and how to get started here...
 
 ### Custom style
 
-> [!SAMPLE BackedTemplatedControlWithCustomStyleSample]
+> [!SAMPLE ProjectTemplateCustomStyleBackedSample]
 

template/lab/samples/ProjectTemplate.Sample/BackedTemplatedControlSample.xaml renamed to template/lab/samples/ProjectTemplate.Sample/ProjectTemplateBackedSample.xaml

@@ -1,5 +1,5 @@
 <!--  Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license. See the LICENSE file in the project root for more information.  -->
-<Page x:Class="ProjectTemplate.Sample.BackedTemplatedControlWithCustomStyleSample"
+<Page x:Class="ProjectTemplate.Sample.ProjectTemplateCustomStyleBackedSample"
       xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
       xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
       xmlns:d="http://schemas.microsoft.com/expression/blend/2008"

template/lab/samples/ProjectTemplate.Sample/BackedTemplatedControlSample.xaml.cs renamed to template/lab/samples/ProjectTemplate.Sample/ProjectTemplateBackedSample.xaml.cs

@@ -14,10 +14,10 @@ namespace ProjectTemplate.Sample;
     "Sand       : #e7a676",
     "Dull green : #5d7577")]
 
-[ToolkitSample(id: nameof(BackedTemplatedControlWithCustomStyleSample), "Backed templated control (restyled)", description: "A sample for showing how to create and use a templated control with a backed resource dictionary and a custom style.")]
-public sealed partial class BackedTemplatedControlWithCustomStyleSample : Page
+[ToolkitSample(id: nameof(ProjectTemplateCustomStyleBackedSample), "Backed templated control (restyled)", description: "A sample for showing how to create and use a templated control with a backed resource dictionary and a custom style.")]
+public sealed partial class ProjectTemplateCustomStyleBackedSample : Page
 {
-    public BackedTemplatedControlWithCustomStyleSample()
+    public ProjectTemplateCustomStyleBackedSample()
     {
         this.InitializeComponent();
     }

template/lab/samples/ProjectTemplate.Sample/BackedTemplatedControlWithCustomStyleSample.xaml renamed to template/lab/samples/ProjectTemplate.Sample/ProjectTemplateCustomStyleBackedSample.xaml

@@ -1,5 +1,5 @@
 <!--  Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license. See the LICENSE file in the project root for more information.  -->
-<Page x:Class="ProjectTemplate.Sample.TemplatedControlWithCustomStyleSample"
+<Page x:Class="ProjectTemplate.Sample.ProjectTemplateCustomStyleSample"
       xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
       xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
       xmlns:d="http://schemas.microsoft.com/expression/blend/2008"

template/lab/samples/ProjectTemplate.Sample/BackedTemplatedControlWithCustomStyleSample.xaml.cs renamed to template/lab/samples/ProjectTemplate.Sample/ProjectTemplateCustomStyleBackedSample.xaml.cs

@@ -14,10 +14,10 @@ namespace ProjectTemplate.Sample;
     "Sand       : #e7a676",
     "Dull green : #5d7577")]
 
-[ToolkitSample(id: nameof(TemplatedControlWithCustomStyleSample), "Templated control (restyled)", description: "A sample for showing how to create a use and templated control with a custom style.")]
-public sealed partial class TemplatedControlWithCustomStyleSample : Page
+[ToolkitSample(id: nameof(ProjectTemplateCustomStyleSample), "Templated control (restyled)", description: "A sample for showing how to create a use and templated control with a custom style.")]
+public sealed partial class ProjectTemplateCustomStyleSample : Page
 {
-    public TemplatedControlWithCustomStyleSample()
+    public ProjectTemplateCustomStyleSample()
     {
         this.InitializeComponent();
     }