Equatable.Generator 1.1.0

dotnet add package Equatable.Generator --version 1.1.0                
NuGet\Install-Package Equatable.Generator -Version 1.1.0                
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="Equatable.Generator" Version="1.1.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Equatable.Generator --version 1.1.0                
#r "nuget: Equatable.Generator, 1.1.0"                
#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.
// Install Equatable.Generator as a Cake Addin
#addin nuget:?package=Equatable.Generator&version=1.1.0

// Install Equatable.Generator as a Cake Tool
#tool nuget:?package=Equatable.Generator&version=1.1.0                

Equatable.Generator

Source generator for Equals and GetHashCode

Build Project

Coverage Status

Equatable.Generator

Features

  • Override Equals and GetHashCode
  • Implement IEquatable<T>
  • Support class, record and struct types
  • Support EqualityComparer per property
  • Comparers supported: String, Sequence, Dictionary, HashSet, Reference, and Custom
  • No dependencies

Usage

Add package

Add the nuget package to your projects.

dotnet add package Equatable.Generator

Prevent including Equatable.Generator as a dependency

<PackageReference Include="Equatable.Generator" PrivateAssets="all" />

Requirements

This library requires:

  • Target framework .NET Standard 2.0 or greater
  • Project C# LangVersion 8.0 or higher

Equatable Attributes

Place equatable attribute on a class, record or struct. The source generator will create a partial with overrides for Equals and GetHashCode.

  • [Equatable] Marks the class to generate overrides for Equals and GetHashCode

The default comparer used in the implementation of Equals and GetHashCode is EqualityComparer<T>.Default. Customize the comparer used with the following attributes.

  • [IgnoreEquality] Ignore property in Equals and GetHashCode implementations
  • [StringEquality] Use specified StringComparer when comparing strings
  • [SequenceEquality] Use Enumerable.SequenceEqual to determine whether enumerables are equal
  • [DictionaryEquality] Use to determine if dictionaries are equal
  • [HashSetEquality] Use ISet<T>.SetEquals to determine whether enumerables are equal
  • [ReferenceEquality] Use Object.ReferenceEquals to determines whether instances are the same instance
  • [EqualityComparer] Use the specified EqualityComparer

Example Usage

Example of using the attributes to customize the source generation of Equals and GetHashCode

[Equatable]
public partial class UserImport
{
    [StringEquality(StringComparison.OrdinalIgnoreCase)]
    public string EmailAddress { get; set; } = null!;

    public string? DisplayName { get; set; }

    public string? FirstName { get; set; }

    public string? LastName { get; set; }

    public DateTimeOffset? LockoutEnd { get; set; }

    public DateTimeOffset? LastLogin { get; set; }

    [IgnoreEquality]
    public string FullName => $"{FirstName} {LastName}";

    [HashSetEquality]
    public HashSet<string>? Roles { get; set; }

    [DictionaryEquality]
    public Dictionary<string, int>? Permissions { get; set; }

    [SequenceEquality]
    public List<DateTimeOffset>? History { get; set; }
}
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  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. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • .NETStandard 2.0

    • No dependencies.
  • net6.0

    • No dependencies.
  • net8.0

    • No dependencies.

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
1.1.0 261 9/7/2024
1.1.0-beta.1 41 9/7/2024
1.0.0 139 9/5/2024
1.0.0-beta.3 47 9/5/2024
1.0.0-beta.2 45 9/5/2024
1.0.0-beta.1 53 9/5/2024
1.0.0-alpha.2 46 9/4/2024
1.0.0-alpha.1 39 9/4/2024