Json schema generator (#45)

* add json schema generator

* add props & targets, cli tool

* fix incorrect type check in attribute factory
implement enum hints

* update pipeline

* undo namespace cleanup

* fix formatting

* move from InternalsVisibleTo to public types

Author: SleepWellPupper

Directory.Build.props

@@ -1,6 +1,6 @@
 <Project>
 	<PropertyGroup>
-		<AutoIncrementedAssemblyRevision>1473</AutoIncrementedAssemblyRevision>
+		<AutoIncrementedAssemblyRevision>1474</AutoIncrementedAssemblyRevision>
 	</PropertyGroup>
 
 	<PropertyGroup Condition="$(MSBuildProjectName.EndsWith('.Tests'))">

JsonSchemaGenerator.Cli/JsonSchemaGenerator.Cli.csproj

@@ -12,10 +12,6 @@
 	  <Compile Include="..\JsonSchemaGenerator\Attributes\GeneratedJsonSchemaAttribute.cs" Link="GeneratedJsonSchemaAttribute.cs" />
 	</ItemGroup>
 
-	<ItemGroup>
-		<InternalsVisibleTo Include="RhoMicro.CodeAnalysis.JsonSchemaGenerator.Tests.1.0.0" />
-	</ItemGroup>
-	
 	<ItemGroup>
 		<PackageReference Include="IKVM.Core.MSBuild" Version="0.1.103">
 		  <PrivateAssets>all</PrivateAssets>

JsonSchemaGenerator.Cli/MainService.cs

@@ -10,17 +10,46 @@
 using Microsoft.Extensions.Hosting;
 using Microsoft.Extensions.Logging;
 
-internal class MainService(Settings settings, ILogger logger, IHostApplicationLifetime lifetime) : BackgroundService
+/// <summary>
+/// Inspects an assembly for <see cref="GeneratedJsonSchemaAttribute"/>
+/// annotations and emits the json schemata provided by them to a directory.
+/// </summary>
+/// <param name="settings">
+/// The object providing settings to the service.
+/// </param>
+/// <param name="logger">
+/// The logger to use when logging progress.
+/// </param>
+/// <param name="lifetime">
+/// The lifetime of the application hosting the service. When done, the service
+/// will stop the application via this object.
+/// </param>
+public sealed class MainService(Settings settings, ILogger logger, IHostApplicationLifetime lifetime) : BackgroundService
 {
     private static readonly JsonSerializerOptions _schemaSerializationOptions = new(JsonSerializerDefaults.General)
     {
         WriteIndented = true,
         PropertyNamingPolicy = null
     };
-
+    /// <summary>
+    /// Creates a new instance of the service.
+    /// </summary>
+    /// <param name="settings">
+    /// The object providing settings to the service.
+    /// </param>
+    /// <param name="loggerFactory">
+    /// The factory to use when creating a logger to use when logging progress.
+    /// </param>
+    /// <param name="lifetime">
+    /// The lifetime of the application hosting the service. When done, the
+    /// service will stop the application via this object.
+    /// </param>
+    /// <returns>
+    /// A new service instance.
+    /// </returns>
     public static MainService Create(Settings settings, ILoggerFactory loggerFactory, IHostApplicationLifetime lifetime) =>
         new(settings, loggerFactory.CreateLogger<MainService>(), lifetime);
-
+    /// <inheritdoc/>
     protected override async Task ExecuteAsync(CancellationToken stoppingToken)
     {
         stoppingToken.ThrowIfCancellationRequested();

JsonSchemaGenerator.Cli/Settings.cs

@@ -1,8 +1,17 @@
 namespace RhoMicro.CodeAnalysis.JsonSchemaGenerator.Cli;
 using System;
 
-sealed class Settings
+/// <summary>
+/// Provides settings for the <see cref="MainService"/>.
+/// </summary>
+public sealed class Settings
 {
+    /// <summary>
+    /// Gets or sets the path of the assembly to emit generated json schemata for.
+    /// </summary>
     public required String AssemblyPath { get; set; }
+    /// <summary>
+    /// Gets or sets the path to output generated schemata into.
+    /// </summary>
     public required String SchemataPath { get; set; }
 }