TypeUtilities 0.0.1-beta01

TypeUtilities

Type Utilities provides a source generators to create/transform one type into another.

This project was inspired by the TypeScript Utility Types and was ment to bring similar functionality to the C# via source generators

Installation

To use the the TypeUtilities, install the TypeUtilities package into your project.

To install the packages, add the references to your csproj file, for example by running

dotnet add package TypeUtilities --prerelease

This adds a <PackageReference> to your project.

Usage

TypeUtilities provides several attributes:

Map

Map Attribute simply maps memebers of the source type to the target type using specified format.

using TypeUtilities;
using TypeUtilities.Abstractions;

public class SourceType
{
    public Guid Id { get; }
    public int Value { get; set; }
    public DateTime Created { get; set; }
}

[Map(typeof(SourceType))]
public partial class SimpleMap
{
}

// Generated result
//----- SimpleMap.map.SourceType.g.cs
public partial class SimpleMap
{
    public System.Guid Id { get; }
    public int Value { get; set; }
    public System.DateTime Created { get; set; }
}
// --------------------

[Map(typeof(SourceType),
      MemberDeclarationFormat = $"{Tokens.Accessibility} string Mapped{Tokens.Name}{Tokens.Accessors}",
      MemberKindSelection = MemberKindFlags.ReadonlyProperty
    )]
public partial class AdvancedMap
{
}

// Generated result
//----- AdvancedMap.map.SourceType.g.cs
public partial class AdvancedMap
{
    public string MappedId { get; }
}
// --------------------

More detailed description for Map is provided here

Omit

Omit Attribute is similar to Map but also accepts an explicit list of members that should be exluded

using TypeUtilities;

public class SourceType
{
    public Guid Id { get; }
    public int Value { get; set; }
    public DateTime Created { get; set; }
}

[Omit(typeof(SourceType), "Value")]
public partial class TargetType
{
  public int MyValue { get; set; }
}

// Generated result
//----- TargetType.omit.SourceType.g.cs
public partial class TargetType
{
    public Guid Id { get; }
    public DateTime Created { get; set; }
}

Pick

Pick Attribute is similar to Map but also requires to explicitly specify all members that should be included

using TypeUtilities;

public class SourceType
{
    public Guid Id { get; }
    public int Value { get; set; }
    public DateTime Created { get; set; }
}

[Pick(typeof(SourceType), "Id", nameof(SourceType.Value))]
public partial class TargetType
{
}

// Generated result
//----- TargetType.omit.SourceType.g.cs
public partial class TargetType
{
    public Guid Id { get; }
    public int Value { get; set; }
}