diff --git a/examples/StreetlightsAPI.AsyncApiSpecFirst/StreetlightsAPI.AsyncApiSpecFirst.csproj b/examples/StreetlightsAPI.AsyncApiSpecFirst/StreetlightsAPI.AsyncApiSpecFirst.csproj index 21137df..0424646 100644 --- a/examples/StreetlightsAPI.AsyncApiSpecFirst/StreetlightsAPI.AsyncApiSpecFirst.csproj +++ b/examples/StreetlightsAPI.AsyncApiSpecFirst/StreetlightsAPI.AsyncApiSpecFirst.csproj @@ -5,12 +5,19 @@ false true + Generated + + + + + + - + diff --git a/src/AsyncAPI.Saunter.Generator.SourceGenerator/AnalyzerReleases.Unshipped.md b/src/AsyncAPI.Saunter.Generator.SourceGenerator/AnalyzerReleases.Unshipped.md index ff9342a..061df9e 100644 --- a/src/AsyncAPI.Saunter.Generator.SourceGenerator/AnalyzerReleases.Unshipped.md +++ b/src/AsyncAPI.Saunter.Generator.SourceGenerator/AnalyzerReleases.Unshipped.md @@ -2,4 +2,5 @@ Rule ID | Category | Severity | Notes --------|----------|----------|-------------------- -AA0001 | SourceGenerator | Error | AA001 \ No newline at end of file +AA0001 | SourceGenerator | Error | AA0001 +AA0002 | SourceGenerator | Info | AA0002 \ No newline at end of file diff --git a/src/AsyncAPI.Saunter.Generator.SourceGenerator/SpecFirstCodeGenerator.cs b/src/AsyncAPI.Saunter.Generator.SourceGenerator/SpecFirstCodeGenerator.cs index 6a07bac..2848f54 100644 --- a/src/AsyncAPI.Saunter.Generator.SourceGenerator/SpecFirstCodeGenerator.cs +++ b/src/AsyncAPI.Saunter.Generator.SourceGenerator/SpecFirstCodeGenerator.cs @@ -39,6 +39,7 @@ private static async void GenerateCode(SourceProductionContext context, (Analyze foreach (var (spec, contents) in output) { + context.ReportDiagnostic(Diagnostic.Create(SourceGenerated, null, spec.SpecFileName)); context.AddSource($"{spec.SpecFileName}.g.cs", contents); } } @@ -50,4 +51,12 @@ private static async void GenerateCode(SourceProductionContext context, (Analyze "SourceGenerator", DiagnosticSeverity.Error, true); + + public static readonly DiagnosticDescriptor SourceGenerated = new( + "AA0002", + "Successfully generated code for AsyncAPI spec", + "Code generated for {0}", + "SourceGenerator", + DiagnosticSeverity.Info, + true); } diff --git a/src/AsyncAPI.Saunter.Generator.SourceGenerator/readme.md b/src/AsyncAPI.Saunter.Generator.SourceGenerator/readme.md index 60b2614..81e4cbf 100644 --- a/src/AsyncAPI.Saunter.Generator.SourceGenerator/readme.md +++ b/src/AsyncAPI.Saunter.Generator.SourceGenerator/readme.md @@ -1,30 +1,48 @@ # AsyncApi Generator.SourceGenerator Nuget Package -A nuget package to generate AsyncAPI specification files at build time, based on code-first attributes. This nuget package requires .NET8.0 runtime in order to work. The consuming csproj doesn't need to target .NET8.0. +A nuget package to generate data classes and AsyncAPI interface(s) from AsyncAPI spec file(s). Add ```AdditionalFiles``` to your csproj-file +to specify for which AsyncAPI specification file(s) source code needs to be generated and in which namespace. -This nuget packages can help to better control API changes by commiting the AsyncAPI spec to source control. By always generating spec files at build, it will be clear when the api changes. +## Configuration +After adding the nuget package reference, the AsyncAPI code generation needs to be configured in the csproj-file: +``` + + + + + +``` -# Customization Properties -The AsyncAPI spec generation can be configured through project properties in the csproj-file (or included via [.props files](https://learn.microsoft.com/en-us/visualstudio/msbuild/customize-your-build)): +## Debugging options +Configure rosyln to emit generated source code files on disk. Default location: +```/obj/Debug//generated/AsyncAPI.Saunter.Generator.SourceGenerator/AsyncAPI.Saunter.Generator.SourceGenerator.SpecFirstCodeGenerator``` ``` - - - - - - + net8.0 + false + + true ``` -Defaults are the same as the underlying [Generator.Cli tool](https://www.nuget.org/packages/AsyncAPI.Saunter.Generator.Cli). - -If the ```AsyncAPI.Saunter.Generator.Build``` Nuget package is referenced, the default is to generate AsyncAPI spec files at build time. +Configure roslyn to emit generated source code in a custom location: +``` + + true + Generated + +``` -- _AsyncAPIGenerateDocumentsOnBuild_: Whether to actually generate AsyncAPI spec files on build (true or false, default: true) -- _AsyncAPIDocumentFormats_: the output formats to generate, can be a combination of json, yml and/or yaml. -- _AsyncAPIDocumentOutputPath_: relative path where the AsyncAPI will be output (default is the csproj root path: ./) -- _AsyncAPIDocumentNames_: The AsyncAPI documents to generate. (default: generate all known documents) -- _AsyncAPIDocumentFilename_: the template for the outputted file names. Default: "{document}_asyncapi.{extension}" -- _AsyncAPIDocumentEnvVars_: define environment variable(s) for the application. Formatted as a comma separated list of _key=value_ pairs, example: ```ASPNETCORE_ENVIRONMENT=AsyncAPI,CONNECT_TO_DATABASE=false```. +These files will not show up in Visual Studio by default, but these can be added: +``` + + + + + +``` -None of these properties are mandatory. Only referencing the [AsyncAPI.Saunter.Generator.Build](https://www.nuget.org/packages/AsyncAPI.Saunter.Generator.Build) Nuget package will generate a json AsyncAPI spec file for all AsyncAPI documents. \ No newline at end of file +Since these file are created on disk, most likely within a directory under git source control, these generated files +can be excluded from git by adding this line to .gitignore file: +``` +*g.cs +``` \ No newline at end of file diff --git a/src/AsyncAPI.Saunter.Generator/FromSpec/CodeGenerator.cs b/src/AsyncAPI.Saunter.Generator/FromSpec/CodeGenerator.cs index 30a337b..77a6525 100644 --- a/src/AsyncAPI.Saunter.Generator/FromSpec/CodeGenerator.cs +++ b/src/AsyncAPI.Saunter.Generator/FromSpec/CodeGenerator.cs @@ -10,7 +10,7 @@ public interface IAsyncApiCodeGenerator Task> FromSpecs(IEnumerable specsToGenerate) where TSpecToGenerate : SpecToGenerate; } -internal class CodeGenerator(ILogger logger, IAsyncApiGenerator asyncApiGenerator, IDataTypesGenerator dataTypesGenerator) : IAsyncApiCodeGenerator +internal class CodeGenerator(IAsyncApiGenerator asyncApiGenerator, IDataTypesGenerator dataTypesGenerator) : IAsyncApiCodeGenerator { public async Task> FromSpecs(IEnumerable specsToGenerate) where TSpecToGenerate : SpecToGenerate {