RhoMicro.OptionsDocs 0.0.0-rc3

Prefix Reserved
.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher.
This is a prerelease version of RhoMicro.OptionsDocs. 
dotnet add package RhoMicro.OptionsDocs --version 0.0.0-rc3
                    


                    

                
NuGet\Install-Package RhoMicro.OptionsDocs -Version 0.0.0-rc3
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="RhoMicro.OptionsDocs" Version="0.0.0-rc3" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="RhoMicro.OptionsDocs" Version="0.0.0-rc3" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="RhoMicro.OptionsDocs" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add RhoMicro.OptionsDocs --version 0.0.0-rc3
                    


                    

                
#r "nuget: RhoMicro.OptionsDocs, 0.0.0-rc3"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package RhoMicro.OptionsDocs@0.0.0-rc3
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=RhoMicro.OptionsDocs&version=0.0.0-rc3&prerelease
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=RhoMicro.OptionsDocs&version=0.0.0-rc3&prerelease
                    


                            Install as a Cake Tool

OptionsDocs

TODO

  • nuget

  • json schema generator should emit for model instead of root type

  • rider issue with live updating file when dotnet watching from out of process

  • rider issue with meta update handler not being invoked when debugging

  • architecture outline

  • design choices & tradeoffs incurred

  • showcase website

  • fork some popular app repos and integrate to test & show off

  • add unit tests

  • write a user guide for usage & extension

  • cookbook on various usecases

  • in use guides, highlight built in transformations & generators & options

  • add convenience methods for registering and configuring stuff like excluded children etc

Architecture

  • 5 main areas:
    • Services
    • Models
    • Enrichments
    • Transformations
    • Generators

Services

  • responsible for integration of various components and services
  • provides top level integration point into DI via ServiceCollectionExtensions.AddOptionsDocs(this IServiceCollection)

Models

  • models option registrations and their properties
  • create models via:
    • OptionsModel.Create(Type type, EnrichmentFactory enrichmentFactory, OptionsModelCreationOptions options)

Enrichments

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
0.0.0-rc3 133 5/25/2025
0.0.0-rc2 48 5/24/2025
0.0.0-rc1 131 5/22/2025