Use Incremental Source Generators

Author: Turnerj

Source/Schema.NET.Pending/Schema.NET.Pending.csproj

@@ -27,4 +27,8 @@
     <Compile Include="../Common/*.*" />
   </ItemGroup>
 
+  <ItemGroup Label="Source Generation">
+    <AdditionalFiles Include="../../Data/*.*" LinkBase="Data" />
+  </ItemGroup>
+
 </Project>

Source/Schema.NET/Schema.NET.csproj

@@ -27,4 +27,8 @@
     <Compile Include="../Common/*.*" />
   </ItemGroup>
 
+  <ItemGroup Label="Source Generation">
+    <AdditionalFiles Include="../../Data/*.*" LinkBase="Data" />
+  </ItemGroup>
+
 </Project>

Tools/Schema.NET.Tool/Repositories/ISchemaRepository.cs

@@ -1,10 +1,9 @@
 namespace Schema.NET.Tool.Repositories;
 
 using System.Collections.Generic;
-using System.Threading.Tasks;
 using Schema.NET.Tool.Models;
 
 public interface ISchemaRepository
 {
-    Task<(IEnumerable<SchemaClass> Classes, IEnumerable<SchemaProperty> Properties, IEnumerable<SchemaEnumerationValue> EnumerationValues)> GetObjectsAsync();
+    (IEnumerable<SchemaClass> Classes, IEnumerable<SchemaProperty> Properties, IEnumerable<SchemaEnumerationValue> EnumerationValues) GetObjects();
 }

Tools/Schema.NET.Tool/Repositories/SchemaRepository.cs

@@ -2,26 +2,23 @@ namespace Schema.NET.Tool.Repositories;
 
 using System;
 using System.Collections.Generic;
-using System.IO;
 using System.Linq;
 using System.Text.Json;
 using System.Text.Json.Serialization;
-using System.Threading.Tasks;
+using Microsoft.CodeAnalysis.Text;
 using Schema.NET.Tool.Models;
 
 public class SchemaRepository : ISchemaRepository
 {
-    private readonly Stream stream;
+    private readonly SourceText jsonLd;
 
-    public SchemaRepository(Stream stream) => this.stream = stream;
+    public SchemaRepository(SourceText jsonLd) => this.jsonLd = jsonLd;
 
-    public async Task<(IEnumerable<SchemaClass> Classes, IEnumerable<SchemaProperty> Properties, IEnumerable<SchemaEnumerationValue> EnumerationValues)> GetObjectsAsync()
+    public (IEnumerable<SchemaClass> Classes, IEnumerable<SchemaProperty> Properties, IEnumerable<SchemaEnumerationValue> EnumerationValues) GetObjects()
     {
-        var schemaObjects = await this.GetSchemaObjectsAsync().ConfigureAwait(false) ??
+        var schemaObjects = Deserialize<List<SchemaObject>>(this.jsonLd.ToString(), new SchemaPropertyJsonConverter()) ??
             throw new InvalidOperationException("No schema objects found.");
 
-        schemaObjects = schemaObjects.ToArray();
-
         var schemaClasses = schemaObjects.OfType<SchemaClass>().ToArray();
 
         foreach (var schemaClass in schemaClasses)
@@ -34,17 +31,13 @@ public class SchemaRepository : ISchemaRepository
             schemaObjects.OfType<SchemaEnumerationValue>().ToArray());
     }
 
-    public async Task<IEnumerable<SchemaObject>?> GetSchemaObjectsAsync() =>
-        await DeserializeAsync<List<SchemaObject>>(this.stream, new SchemaPropertyJsonConverter())
-        .ConfigureAwait(false);
-
-    private static async Task<T?> DeserializeAsync<T>(Stream jsonStream, JsonConverter converter)
+    private static T? Deserialize<T>(string json, JsonConverter converter)
     {
         var options = new JsonSerializerOptions
         {
             PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
         };
         options.Converters.Add(converter);
-        return await JsonSerializer.DeserializeAsync<T>(jsonStream, options).ConfigureAwait(false);
+        return JsonSerializer.Deserialize<T>(json, options);
     }
 }

Tools/Schema.NET.Tool/Schema.NET.Tool.csproj

@@ -68,7 +68,6 @@
       <Generator>ResXFileCodeGenerator</Generator>
       <LastGenOutput>Resources.Designer.cs</LastGenOutput>
     </EmbeddedResource>
-    <EmbeddedResource Include="../../Data/*.*" LinkBase="Data" />
   </ItemGroup>
 
 </Project>

Tools/Schema.NET.Tool/SchemaSourceGenerator.cs

@@ -1,31 +1,41 @@
 namespace Schema.NET.Tool;
 
 using System;
+using System.Collections.Immutable;
 using System.Linq;
-using System.Reflection;
 using Microsoft.CodeAnalysis;
+using Microsoft.CodeAnalysis.Diagnostics;
 using Schema.NET.Tool.CustomOverrides;
 using Schema.NET.Tool.GeneratorModels;
 using Schema.NET.Tool.Repositories;
 using Schema.NET.Tool.Services;
 
 [Generator]
-public class SchemaSourceGenerator : ISourceGenerator
+public class SchemaSourceGenerator : IIncrementalGenerator
 {
-    private const string SchemaDataName = "Schema.NET.Tool.Data.schemaorg-all-https.jsonld";
+    private const string SchemaDataName = "schemaorg-all-https.jsonld";
 
-    public void Initialize(GeneratorInitializationContext context)
+    public void Initialize(IncrementalGeneratorInitializationContext context)
     {
+        var schemaJsonLdDataFile = context.AdditionalTextsProvider
+            .Where(static text => text.Path.EndsWith(SchemaDataName, StringComparison.OrdinalIgnoreCase))
+            .Collect();
+
+        var configuration = context.AnalyzerConfigOptionsProvider
+            .Select((provider, _) => provider.GlobalOptions);
+
+        context.RegisterSourceOutput(configuration.Combine(schemaJsonLdDataFile), Generate);
     }
 
-    public void Execute(GeneratorExecutionContext context)
+    private static void Generate(SourceProductionContext context, (AnalyzerConfigOptions Options, ImmutableArray<AdditionalText> AdditionalText) data)
     {
-        var schemaDataStream = Assembly
-            .GetExecutingAssembly()
-            .GetManifestResourceStream(SchemaDataName) ??
-            throw new InvalidOperationException($"Schema data file '{SchemaDataName}' not found.");
+        var schemaJsonLdDataFile = data.AdditionalText.SingleOrDefault() ??
+            throw new InvalidOperationException($"Schema data file '{SchemaDataName}' not configured.");
+
+        var schemaJsonLdData = schemaJsonLdDataFile.GetText(context.CancellationToken) ??
+            throw new InvalidOperationException($"Unable to read schema data file '{SchemaDataName}'.");
 
-        var schemaRepository = new SchemaRepository(schemaDataStream);
+        var schemaRepository = new SchemaRepository(schemaJsonLdData);
         var schemaService = new SchemaService(
             new IClassOverride[]
             {
@@ -35,12 +45,9 @@ public void Execute(GeneratorExecutionContext context)
             },
             Array.Empty<IEnumerationOverride>(),
             schemaRepository,
-            IncludePendingSchemaObjects(context));
-
-#pragma warning disable VSTHRD002 // Avoid problematic synchronous waits
-        var schemaObjects = schemaService.GetObjectsAsync().GetAwaiter().GetResult();
-#pragma warning restore VSTHRD002 // Avoid problematic synchronous waits
+            IncludePendingSchemaObjects(data.Options));
 
+        var schemaObjects = schemaService.GetObjects();
         if (schemaObjects is not null)
         {
             foreach (var schemaObject in schemaObjects)
@@ -60,12 +67,9 @@ public void Execute(GeneratorExecutionContext context)
         }
     }
 
-    private static bool IncludePendingSchemaObjects(GeneratorExecutionContext context)
-    {
-        var configuration = context.AnalyzerConfigOptions.GlobalOptions;
-        return configuration.TryGetValue($"build_property.IncludePendingSchemaObjects", out var value) &&
+    private static bool IncludePendingSchemaObjects(AnalyzerConfigOptions options) =>
+        options.TryGetValue($"build_property.IncludePendingSchemaObjects", out var value) &&
             value.Equals("true", StringComparison.OrdinalIgnoreCase);
-    }
 
     private static string RenderClass(GeneratorSchemaClass schemaClass)
     {

Tools/Schema.NET.Tool/Services/SchemaService.cs

@@ -6,7 +6,6 @@ namespace Schema.NET.Tool.Services;
 using System.Linq;
 using System.Text;
 using System.Text.RegularExpressions;
-using System.Threading.Tasks;
 using Schema.NET.Tool.CustomOverrides;
 using Schema.NET.Tool.GeneratorModels;
 using Schema.NET.Tool.Repositories;
@@ -32,11 +31,10 @@ public SchemaService(
         this.includePending = includePending;
     }
 
-    public async Task<IEnumerable<GeneratorSchemaObject>> GetObjectsAsync()
+    public IEnumerable<GeneratorSchemaObject> GetObjects()
     {
-        var (schemaClasses, schemaProperties, schemaValues) = await this.schemaRepository
-            .GetObjectsAsync()
-            .ConfigureAwait(false);
+        var (schemaClasses, schemaProperties, schemaValues) = this.schemaRepository
+            .GetObjects();
 
         var isEnumMap = new HashSet<string>(
             schemaClasses.Where(c => c.IsEnum).Select(c => c.Label),