Add csproj file support to Documentation Source Generator

This will allow us to pass them into the generator and get additional info we can use in the Sample App for pointing folks towards Source code and Packages (for  now).

Author: michael-hawker

CommunityToolkit.Tooling.SampleGen.Tests/Helpers/TestHelpers.Compilation.cs

@@ -57,4 +57,18 @@ internal static GeneratorDriver WithMarkdown(this GeneratorDriver driver, params
 
         return driver;
     }
+
+    internal static GeneratorDriver WithCsproj(this GeneratorDriver driver, params string[] csprojFilesToCreate)
+    {
+        foreach (var proj in csprojFilesToCreate)
+        {
+            if (!string.IsNullOrWhiteSpace(proj))
+            {
+                var text = new InMemoryAdditionalText(@"C:\pathtorepo\components\experiment\src\componentname.csproj", proj);
+                driver = driver.AddAdditionalTexts(ImmutableArray.Create<AdditionalText>(text));
+            }
+        }
+
+        return driver;
+    }
 }

CommunityToolkit.Tooling.SampleGen.Tests/Helpers/TestHelpers.cs

@@ -19,13 +19,14 @@ internal static SourceGeneratorRunResult RunSourceGenerator<TGenerator>(this Syn
         return RunSourceGenerator<TGenerator>(compilation, markdown);
     }
 
-    internal static SourceGeneratorRunResult RunSourceGenerator<TGenerator>(this Compilation compilation, string markdown = "")
+    internal static SourceGeneratorRunResult RunSourceGenerator<TGenerator>(this Compilation compilation, string markdown = "", string csproj = "")
         where TGenerator : class, IIncrementalGenerator, new()
     {
         // Create a driver for the source generator
         var driver = compilation
             .CreateSourceGeneratorDriver(new TGenerator())
-            .WithMarkdown(markdown);
+            .WithMarkdown(markdown)
+            .WithCsproj(csproj);
 
         // Update the original compilation using the source generator
         _ = driver.RunGeneratorsAndUpdateCompilation(compilation, out Compilation generatorCompilation, out ImmutableArray<Diagnostic> postGeneratorCompilationDiagnostics);

CommunityToolkit.Tooling.SampleGen.Tests/ToolkitSampleMetadataTests.Documentation.cs

@@ -270,6 +270,14 @@ public void DocumentationValidWithRegistry()
 Which is valid.
 > [!SAMPLE Sample]";
 
+        string csproj = """
+<Project Sdk="MSBuild.Sdk.Extras/3.0.23">
+  <PropertyGroup>
+    <ToolkitComponentName>Primitives</ToolkitComponentName>
+  </PropertyGroup>
+</Project>
+""";
+
         var sampleProjectAssembly = SimpleSource.ToSyntaxTree()
             .CreateCompilation("MyApp.Samples")
             .ToMetadataReference();
@@ -279,7 +287,7 @@ Which is valid.
             .CreateCompilation("MyApp.Head")
             .AddReferences(sampleProjectAssembly);
 
-        var result = headCompilation.RunSourceGenerator<ToolkitSampleMetadataGenerator>(markdown);
+        var result = headCompilation.RunSourceGenerator<ToolkitSampleMetadataGenerator>(markdown, csproj);
 
         result.AssertNoCompilationErrors();
 
@@ -291,7 +299,7 @@ public static class ToolkitDocumentRegistry
         {
             public static System.Collections.Generic.IEnumerable<CommunityToolkit.Tooling.SampleGen.Metadata.ToolkitFrontMatter> Execute()
             {
-                yield return new CommunityToolkit.Tooling.SampleGen.Metadata.ToolkitFrontMatter() { Title = "Canvas Layout", Author = "mhawker", Description = "A canvas-like VirtualizingLayout for use in an ItemsRepeater", Keywords = "CanvasLayout, ItemsRepeater, VirtualizingLayout, Canvas, Layout, Panel, Arrange", Category = ToolkitSampleCategory.Controls, Subcategory = ToolkitSampleSubcategory.Layout, DiscussionId = 0, IssueId = 0, Icon = @"experiment/samples/assets/icon.png", FilePath = @"experiment\samples\documentation.md", SampleIdReferences = new string[] { "Sample" }, IsExperimental = true };
+                yield return new CommunityToolkit.Tooling.SampleGen.Metadata.ToolkitFrontMatter() { ComponentName = "Primitives", Title = "Canvas Layout", Author = "mhawker", Description = "A canvas-like VirtualizingLayout for use in an ItemsRepeater", Keywords = "CanvasLayout, ItemsRepeater, VirtualizingLayout, Canvas, Layout, Panel, Arrange", Category = ToolkitSampleCategory.Controls, Subcategory = ToolkitSampleSubcategory.Layout, DiscussionId = 0, IssueId = 0, Icon = @"experiment/samples/assets/icon.png", FilePath = @"experiment\samples\documentation.md", SampleIdReferences = new string[] { "Sample" }, IsExperimental = true, CsProjName = @"componentname.csproj" };
             }
         }
         """, "Unexpected code generated");

CommunityToolkit.Tooling.SampleGen/Metadata/ToolkitFrontMatter.cs

@@ -25,4 +25,6 @@ public sealed class ToolkitFrontMatter : DocsFrontMatter
     public string? FilePath { get; set; }
     public string[]? SampleIdReferences { get; set; }
     public string? Icon { get; set; }
+    public string? ComponentName { get; set; }
+    public string? CsProjName { get; set; }
 }

CommunityToolkit.Tooling.SampleGen/ToolkitSampleMetadataGenerator.Documentation.cs

@@ -49,6 +49,9 @@ public partial class ToolkitSampleMetadataGenerator
     private const string FrontMatterRegexIsExperimentalExpression = @"^experimental:\s*(?<experimental>.*)$";
     private static readonly Regex FrontMatterRegexIsExperimental = new Regex(FrontMatterRegexIsExperimentalExpression, RegexOptions.Compiled | RegexOptions.IgnoreCase | RegexOptions.Multiline);
 
+    private const string CsProjRegexComponentNameExpression = @"^\s*<ToolkitComponentName>(?<ToolkitComponentName>.*)<\/ToolkitComponentName>\s*$";
+    private static readonly Regex CsProjRegexComponentName = new Regex(CsProjRegexComponentNameExpression, RegexOptions.Compiled | RegexOptions.IgnoreCase | RegexOptions.Multiline);
+
     private static void ReportDocumentDiagnostics(SourceProductionContext ctx, Dictionary<string, ToolkitSampleRecord> sampleMetadata, IEnumerable<AdditionalText> markdownFileData, IEnumerable<(ToolkitSampleAttribute Attribute, string AttachedQualifiedTypeName, ISymbol Symbol)> toolkitSampleAttributeData, ImmutableArray<ToolkitFrontMatter> docFrontMatter)
     {
         // Keep track of all sample ids and remove them as we reference them so we know if we have any unreferenced samples.
@@ -90,14 +93,16 @@ private static void ReportDocumentDiagnostics(SourceProductionContext ctx, Dicti
         }
     }
 
-    private ImmutableArray<ToolkitFrontMatter> GatherDocumentFrontMatter(SourceProductionContext ctx, IEnumerable<AdditionalText> data)
+    private static ImmutableArray<ToolkitFrontMatter> GatherDocumentFrontMatter(SourceProductionContext ctx, IEnumerable<(AdditionalText Document, AdditionalText? CsProj)> data)
     {
-        return data.Select(file =>
+        return data.Select(info =>
         {
+            var file = info.Document;
+
             // We have to manually parse the YAML here for now because of
             // https://github.com/dotnet/roslyn/issues/43903
 
-            var content = file.GetText()!.ToString();
+            var content = info.Document.GetText()!.ToString();
             var matter = content.Split(new[] { "---" }, StringSplitOptions.RemoveEmptyEntries);
 
             if (matter.Length <= 1)
@@ -221,6 +226,28 @@ private ImmutableArray<ToolkitFrontMatter> GatherDocumentFrontMatter(SourceProdu
                     return null;
                 }
 
+                string? componentName = null;
+                string? csprojName = null;
+
+                // Get component name from csproj file (if we have one) and its filename, otherwise, use path data of doc file
+                if (info.CsProj != null)
+                {
+                    var text = info.CsProj.GetText()!.ToString();
+
+                    var match = CsProjRegexComponentName.Match(text);
+
+                    if (match.Success)
+                    {
+                        componentName = match.Groups["ToolkitComponentName"].Value.Trim();
+                    }
+
+                    csprojName = info.CsProj.Path.Split(new char[] { '/', '\\' }).LastOrDefault();
+                }
+                else
+                {
+                    componentName = filepath.Split(new char[] { '/', '\\' }).FirstOrDefault();
+                }
+
                 // Finally, construct the complete object.
                 return new ToolkitFrontMatter()
                 {
@@ -236,12 +263,14 @@ private ImmutableArray<ToolkitFrontMatter> GatherDocumentFrontMatter(SourceProdu
                     IssueId = issueId,
                     Icon = iconpath,
                     IsExperimental = isExperimental,
+                    ComponentName = componentName,
+                    CsProjName = csprojName,
                 };
             }
         }).OfType<ToolkitFrontMatter>().ToImmutableArray();
     }
 
-    private string? ParseYamlField(ref SourceProductionContext ctx, string filepath, ref string content, Regex pattern, string captureGroupName, bool optional = false)
+    private static string? ParseYamlField(ref SourceProductionContext ctx, string filepath, ref string content, Regex pattern, string captureGroupName, bool optional = false)
     {
         var match = pattern.Match(content);
 
@@ -263,7 +292,7 @@ private ImmutableArray<ToolkitFrontMatter> GatherDocumentFrontMatter(SourceProdu
         return match.Groups[captureGroupName].Value.Trim();
     }
 
-    private void CreateDocumentRegistry(SourceProductionContext ctx, ImmutableArray<ToolkitFrontMatter> matter)
+    private static void CreateDocumentRegistry(SourceProductionContext ctx, ImmutableArray<ToolkitFrontMatter> matter)
     {
         // TODO: Emit a better error that no documentation is here?
         if (matter.Length == 0)
@@ -292,6 +321,6 @@ private static string FrontMatterToRegistryCall(ToolkitFrontMatter metadata)
         var categoryParam = $"{nameof(ToolkitSampleCategory)}.{metadata.Category}";
         var subcategoryParam = $"{nameof(ToolkitSampleSubcategory)}.{metadata.Subcategory}";
 
-        return @$"yield return new {typeof(ToolkitFrontMatter).FullName}() {{ Title = ""{metadata.Title}"", Author = ""{metadata.Author}"", Description = ""{metadata.Description}"", Keywords = ""{metadata.Keywords}"", Category = {categoryParam}, Subcategory = {subcategoryParam}, DiscussionId = {metadata.DiscussionId}, IssueId = {metadata.IssueId}, Icon = @""{metadata.Icon}"", FilePath = @""{metadata.FilePath}"", SampleIdReferences = new string[] {{ ""{string.Join("\",\"", metadata.SampleIdReferences)}"" }}, IsExperimental = {metadata.IsExperimental.ToString().ToLowerInvariant()} }};"; // TODO: Add list of sample ids in document
+        return @$"yield return new {typeof(ToolkitFrontMatter).FullName}() {{ ComponentName = ""{metadata.ComponentName}"", Title = ""{metadata.Title}"", Author = ""{metadata.Author}"", Description = ""{metadata.Description}"", Keywords = ""{metadata.Keywords}"", Category = {categoryParam}, Subcategory = {subcategoryParam}, DiscussionId = {metadata.DiscussionId}, IssueId = {metadata.IssueId}, Icon = @""{metadata.Icon}"", FilePath = @""{metadata.FilePath}"", SampleIdReferences = new string[] {{ ""{string.Join("\",\"", metadata.SampleIdReferences)}"" }}, IsExperimental = {metadata.IsExperimental.ToString().ToLowerInvariant()}, CsProjName = @""{metadata.CsProjName}"" }};"; // TODO: Add list of sample ids in document
     }
 }

CommunityToolkit.Tooling.SampleGen/ToolkitSampleMetadataGenerator.Sample.cs

@@ -8,6 +8,7 @@
 using Microsoft.CodeAnalysis;
 using Microsoft.CodeAnalysis.CSharp;
 using Microsoft.CodeAnalysis.CSharp.Syntax;
+using System.Linq;
 
 namespace CommunityToolkit.Tooling.SampleGen;
 
@@ -35,6 +36,10 @@ public void Initialize(IncrementalGeneratorInitializationContext context)
             .Where(static file => file.Path.EndsWith(".md"))
             .Collect();
 
+        var csprojFiles = context.AdditionalTextsProvider
+            .Where(static file => file.Path.EndsWith(".csproj"))
+            .Collect();
+
         var assemblyName = context.CompilationProvider.Select((x, _) => x.Assembly.Name);
 
         // Only generate diagnostics (sample projects)
@@ -106,15 +111,30 @@ void Execute(IncrementalValuesProvider<ISymbol> types, bool skipDiagnostics = fa
                 .Combine(toolkitSampleAttributeData)
                 .Combine(generatedPaneOptions)
                 .Combine(markdownFiles)
+                .Combine(csprojFiles)
                 .Combine(assemblyName);
 
+            // TODO: We can make this static if we could pass in our two boolean values as context, no idea how to do that...
             context.RegisterSourceOutput(all, (ctx, data) =>
             {
-                var toolkitSampleAttributeData = data.Left.Left.Left.Right.Where(x => x != default).Distinct();
-                var optionsPaneAttribute = data.Left.Left.Left.Left.Where(x => x != default).Distinct();
-                var generatedOptionPropertyData = data.Left.Left.Right.Where(x => x.Attribute is not null && x.Symbol is not null);
-                var markdownFileData = data.Left.Right.Where(x => x != default).Distinct();
-                var currentAssembly = data.Right;
+                var (((((optionsPaneAttributes, toolkitSampleAttributes), generatedPaneOptions), markdownFiles), csprojFiles), currentAssembly) = data;
+
+                var toolkitSampleAttributeData = toolkitSampleAttributes.Where(x => x != default).Distinct();
+                var optionsPaneAttributeData = optionsPaneAttributes.Where(x => x != default).Distinct();
+                var generatedOptionPropertyData = generatedPaneOptions.Where(x => x.Attribute is not null && x.Symbol is not null);
+
+                var markdownFileData = markdownFiles.Where(x => x != default).Distinct();
+                var csprojFileData = csprojFiles.Where(x => x != default).Distinct();
+
+                var markdownProjPairings = markdownFileData.Select<AdditionalText, (AdditionalText Document, AdditionalText? CsProj)>((docFile, _) =>
+                {
+                    // TODO: We use these splits a lot to extra path info, so we should probably make a helper function?
+                    var rootPathFile = docFile.Path.Split(new string[] { @"\components\", "/components/", @"\tooling\", "/tooling/" }, StringSplitOptions.RemoveEmptyEntries).LastOrDefault()?.Split(new char[] { '/', '\\' }).FirstOrDefault();
+
+                    var csproj = csprojFileData.FirstOrDefault(csProjFile => csProjFile.Path.Split(new string[] { @"\components\", "/components/", @"\tooling\", "/tooling/" }, StringSplitOptions.RemoveEmptyEntries).LastOrDefault()?.Split(new char[] { '/', '\\' }).FirstOrDefault() == rootPathFile);
+
+                    return (docFile, csproj);
+                });
 
                 var isExecutingInSampleProject = currentAssembly?.EndsWith(".Samples") ?? false;
 
@@ -129,16 +149,16 @@ void Execute(IncrementalValuesProvider<ISymbol> types, bool skipDiagnostics = fa
                                 sample.Attribute.DisplayName,
                                 sample.Attribute.Description,
                                 sample.AttachedQualifiedTypeName,
-                                optionsPaneAttribute.FirstOrDefault(x => x.Item1?.SampleId == sample.Attribute.Id).Item2?.ToString(),
+                                optionsPaneAttributeData.FirstOrDefault(x => x.Item1?.SampleId == sample.Attribute.Id).Item2?.ToString(),
                                 generatedOptionPropertyData.Where(x => x.Symbol.Equals(sample.Symbol, SymbolEqualityComparer.Default)).Select(x => x.Item2)
                             )
                     );
 
-                var docFrontMatter = GatherDocumentFrontMatter(ctx, markdownFileData);
+                var docFrontMatter = GatherDocumentFrontMatter(ctx, markdownProjPairings);
 
                 if (isExecutingInSampleProject && !skipDiagnostics)
                 {
-                    ReportSampleDiagnostics(ctx, toolkitSampleAttributeData, optionsPaneAttribute, generatedOptionPropertyData);
+                    ReportSampleDiagnostics(ctx, toolkitSampleAttributeData, optionsPaneAttributeData, generatedOptionPropertyData);
                     ReportDocumentDiagnostics(ctx, sampleMetadata, markdownFileData, toolkitSampleAttributeData, docFrontMatter);
                 }