Riok.Mapperly 4.0.0

Prefix Reserved
.NET Standard 2.0 This package targets .NET Standard 2.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package Riok.Mapperly --version 4.0.0                

                    
                

            
NuGet\Install-Package Riok.Mapperly -Version 4.0.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="Riok.Mapperly" Version="4.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add Riok.Mapperly --version 4.0.0                

                    
                

            
#r "nuget: Riok.Mapperly, 4.0.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 Riok.Mapperly as a Cake Addin
#addin nuget:?package=Riok.Mapperly&version=4.0.0

// Install Riok.Mapperly as a Cake Tool
#tool nuget:?package=Riok.Mapperly&version=4.0.0

Mapperly

Nuget Nuget Preview License Downloads GitHub Sponsors GitHub

Mapperly is a .NET source generator for generating object mappings.

Because Mapperly creates the mapping code at build time, there is minimal overhead at runtime. Even better, the generated code is perfectly readable, allowing you to verify the generated mapping code easily.

Documentation

The documentation is available here.

Quickstart

Installation

Add the NuGet Package to your project:

dotnet add package Riok.Mapperly

Create your first mapper

Create a mapper declaration as a partial class and apply the Riok.Mapperly.Abstractions.MapperAttribute attribute. Mapperly generates mapping method implementations for the defined mapping methods in the mapper.

// Mapper declaration
[Mapper]
public partial class CarMapper
{
    public partial CarDto CarToCarDto(Car car);
}

// Mapper usage
var mapper = new CarMapper();
var car = new Car { NumberOfSeats = 10, ... };
var dto = mapper.CarToCarDto(car);
dto.NumberOfSeats.Should().Be(10);

Read the docs for any further information.

Upgrading

Find a list of breaking changes for each major version and upgrade guides here.

How To Contribute

We would love for you to contribute to Mapperly and help make it even better than it is today! Find information on how to contribute in the docs.

License

Mapperly is Apache 2.0 licensed.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  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 was computed.  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.

NuGet packages (16)

Showing the top 5 NuGet packages that depend on Riok.Mapperly:

Package Downloads
Rocket.Surgery.LaunchPad.Mapping

Package Description
Indice.Hive.Core

Package Description
Fanzoo.Kernel

An opinionated framework for building scalable web applications.
Eternet.AspNetCore.DocumentDb.Crud

AspNet Core DocumentDb CRUD framework using Marten for Document DB and Events Store
BeamOS.Tests.Common

Package Description

GitHub repositories (13)

Showing the top 5 popular GitHub repositories that depend on Riok.Mapperly:

Repository Stars
riok/mapperly
A .NET source generator for generating object mappings. No runtime reflection.
martinothamar/Mediator
A high performance implementation of Mediator pattern in .NET using source generators.
bitfoundation/bitplatform
Build all of your apps using what you already know and love ❤️
mehdihadeli/food-delivery-microservices
🍔 A practical and imaginary food delivery microservices, built with .Net 8, MassTransit, Domain-Driven Design, CQRS, Vertical Slice Architecture, Event-Driven Architecture, and the latest technologies.
velopack/velopack
Installer and automatic update framework for cross-platform desktop applications
Version Downloads Last updated
4.1.1-next.0 427 11/5/2024
4.1.0 41,027 10/31/2024
4.1.0-next.3 103 10/29/2024
4.1.0-next.2 378 10/25/2024
4.1.0-next.1 555 10/14/2024
4.1.0-next.0 510 10/11/2024
4.0.0 74,186 10/11/2024
4.0.0-next.4 1,339 9/29/2024
4.0.0-next.3 10,678 8/13/2024
4.0.0-next.2 467 8/6/2024
4.0.0-next.1 2,904 6/30/2024
3.6.0 769,989 6/18/2024
3.6.0-next.2 1,589 6/3/2024
3.6.0-next.1 4,547 5/3/2024
3.5.1 389,487 4/23/2024
3.5.1-next.2 1,244 4/15/2024
3.5.1-next.1 224 4/9/2024
3.5.0 222,135 4/5/2024
3.5.0-next.4 1,090 3/27/2024
3.5.0-next.3 8,742 3/18/2024
3.5.0-next.2 13,495 3/11/2024
3.5.0-next.1 622 3/9/2024
3.4.0 353,849 2/23/2024
3.4.0-next.5 1,560 2/20/2024
3.4.0-next.4 879 2/16/2024
3.4.0-next.3 3,868 2/5/2024
3.4.0-next.2 17,913 1/10/2024
3.4.0-next.1 325 1/6/2024
3.3.1-next.1 2,795 12/18/2023
3.3.0 540,023 12/12/2023
3.3.0-next.6 1,005 12/6/2023
3.3.0-next.5 1,363 11/28/2023
3.3.0-next.4 2,299 11/22/2023
3.3.0-next.3 6,910 11/19/2023
3.3.0-next.2 3,322 10/26/2023
3.3.0-next.1 3,668 10/11/2023
3.2.0 620,672 9/18/2023
3.2.0-next.4 1,389 9/12/2023
3.2.0-next.3 458 9/11/2023
3.2.0-next.2 321 9/5/2023
3.2.0-next.1 479 8/29/2023
3.1.0 147,899 8/18/2023
3.1.0-next.2 109 8/18/2023
3.1.0-next.1 4,500 8/8/2023
3.0.0 39,426 8/7/2023
3.0.0-next.1 350 8/2/2023
2.9.0-next.4 6,565 7/26/2023
2.9.0-next.3 700 7/16/2023
2.9.0-next.2 5,059 6/13/2023
2.9.0-next.1 5,560 5/11/2023
2.8.0 532,515 4/27/2023
2.8.0-next.2 520 4/20/2023
2.8.0-next.1 17,071 3/23/2023
2.7.1-next.1 661 3/17/2023
2.7.0 168,605 3/13/2023
2.7.0-next.2 817 1/26/2023
2.7.0-next.1 611 1/23/2023
2.6.0 89,583 1/12/2023
2.6.0-next.4 112 1/11/2023
2.6.0-next.3 170 1/9/2023
2.6.0-next.2 292 12/14/2022
2.6.0-next.1 569 12/12/2022
2.5.0 82,211 10/12/2022
2.5.0-next.2 326 9/28/2022
2.5.0-next.1 228 9/19/2022
2.4.1-next.1 200 9/16/2022
2.4.0 18,388 9/8/2022
2.3.3 3,080 8/10/2022
2.3.2 905 8/9/2022
2.3.1 61,557 5/31/2022
2.3.0 2,408 5/16/2022
2.2.1 3,527 4/6/2022
2.2.0 1,248 3/15/2022
2.1.0 1,061 2/28/2022
2.0.0 1,148 2/21/2022

🚨 Breaking Changes

ignore indexed properties by @latonz in #1351

add enum underlying type conversion by @latonz in #1352

strict mappings by default by @latonz in #1353

support mapping properties of custom collection mappings by @latonz in #1364

improve handling of read-only and immutable types  by @latonz in #1413

improve member matching performance for member names with lots of upper case letters by @latonz in #1447

enum from/to string explicit mappings by @BeeTwin in #1483

🚀 Features

introduce MapValueAttribute to map constant values and method provided values by @latonz in #1335

add MappingTarget attribute to set the mapping target as the first parameter by @latonz in #1376

support additional mapping method parameters by @latonz in #1400

inline methods consisting of a single return statement or local variable declaration expression by @hartmair in #1422

support private constructors by @latonz in #1405

improve handling of read-only and immutable types  by @latonz in #1413

improve constructor mapping readability by @aradalvand in #1448

add support for mappers being nested under interfaces or records by @david-driscoll in #1464

enum from/to string explicit mappings by @BeeTwin in #1483

enum from/to string naming strategies for different letter casings by @BeeTwin in #1486

enum from/to string naming strategies for DescriptionAttribute and EnumMemberAttribute by @latonz in #1507

🐛 Bug Fixes

adjust diagnostic messages to be correct when applied with MapValue by @latonz in #1332

allow same-name members with different casings by @latonz in #1350

replace invalid MapPropertyAttribute constructors with valid versions by @latonz in #1354

failing projection with static mapper from another assembly by @trejjam in #1418

collect EnumerateUnmappedOrConfiguredTargetMembers to prevent collection was modified exception by @trejjam in #1438

support inline expression with casting by @trejjam in #1419

correct map nested interfaced enumerations by @latonz in #1404

only initialize unflattened nullable target members when needed by @latonz in #1408

improve handling of read-only and immutable types  by @latonz in #1413

improve member matching performance for member names with lots of upper case letters by @latonz in #1447

initialize nullable values when assigning null to a child member by @latonz in #1449

report inaccessible constructor instead of mapping could not be created by @latonz in #1462

support inlining of method with generic type arguments by @trejjam in #1498

refactor member matching and member mapping building process by @latonz in #1334

Full Changelog: https://github.com/riok/mapperly/compare/v3.6.0...v4.0.0
Migration guide: https://mapperly.riok.app/docs/breaking-changes/4-0/