ContractCompatibility 0.0.6

.NET 10.0 This package targets .NET 10.0. The package is compatible with this framework or higher. 
dotnet add package ContractCompatibility --version 0.0.6
                    


                    

                
NuGet\Install-Package ContractCompatibility -Version 0.0.6
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="ContractCompatibility" Version="0.0.6" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="ContractCompatibility" Version="0.0.6" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="ContractCompatibility" />
                    


                            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 ContractCompatibility --version 0.0.6
                    


                    

                
#r "nuget: ContractCompatibility, 0.0.6"
#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 ContractCompatibility@0.0.6
#: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=ContractCompatibility&version=0.0.6
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=ContractCompatibility&version=0.0.6
                    


                            Install as a Cake Tool

ContractCompatibilty

The purpose of this project is to provide a library to compare contracts. Such comparison is intended to provide help in managing contracts evolution by helping you identify breaking changes.

For now, I'm focusing on handling .proto contract which are primarily used to represent ProtoBuf serialization schema. The library is currently tested only on proto syntax 2, but I'm clearly open to support more recent versions of the syntax

Sample Usage:

The entrypoint of the library is the ContractComparer class. It works on 2 IStoreContractSchema, one containing the contract consumer's contract schemas and the other containing the contract producer's contract schemas. Then you call either the CompareMessage or CompareService method with the fully qualified name of the contracts to compare in each store:

var comparer = new ContractComparer(consumerContractSchemaStore, producerContractSchemaStore);
var comparison = comparer.CompareMessage(".SearchQuery", ".SearchQuery");

The library provide a basic implementation of IStoreContractSchema called SingleFileContractSchemaStore. It is a simple implementation that contains a single ProtoFile provided to it's contractor:

var protoFile = new ProtoFile(
    "path/to/the_proto_file.proto",
    @"syntax = ""proto2"";

message SearchRequest {
  optional string query = 1;
  optional int32 page_number = 2;
  optional int32 results_per_page = 3;
}
");

var contractSchemaStore = new SingleFileContractSchemaStore(protoFile);

NOTE: If you provide invalid proto schema files to the ContractComparer it won t throw anything, however you will be able to retrieve potential parsing errors using the comparer.GetParsingErrors() method.

Product Compatible and additional computed target framework versions.
.NET net10.0 is compatible.  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.6 69 8/2/2026
0.0.5 71 4/20/2026
0.0.4 76 3/1/2026
0.0.3 114 9/5/2025
0.0.2 198 4/13/2025
0.0.1 172 3/17/2025