Yash 1.0.0

dotnet add package Yash --version 1.0.0
                    
NuGet\Install-Package Yash -Version 1.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="Yash" Version="1.0.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Yash" Version="1.0.0" />
                    
Directory.Packages.props
<PackageReference Include="Yash" />
                    
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 Yash --version 1.0.0
                    
#r "nuget: Yash, 1.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.
#:package Yash@1.0.0
                    
#: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=Yash&version=1.0.0
                    
Install as a Cake Addin
#tool nuget:?package=Yash&version=1.0.0
                    
Install as a Cake Tool

Yash

A C# source generator to generate builder classes for your types.

Getting started

Reference the Yash NuGet package - that's it.

Prerequisites

The Yash package targets .NET Standard 2.0 for host flexibility. Note that Yash looks for, and generates, code that targets .NET 7.

Usage

Assuming you have the following types in your project:

public record Artifact(string Name, ArtifactItem Item);
public record ArtifactItem(int Value);

To generate a builder class for the Artifact, you can create a partial class, apply the [Yash<Artifact>] attribute, and implement the BuildInternal() method in your project:

[Yash<Artifact>]
public partial class ArtifactBuilder {
    protected override DefaultValuesRecord DefaultValues => new("aName", new ArtifactItem(1));

    private Artifact BuildInternal(string name, ArtifactItem item) => new Artifact(name, item);
}

Based on the Buildinternal() method, Yash will generate all the required build methods and forces you to override the DefaultValues property.<br/> The Builder can then be used like this:

var artifact = new ArtifactBuilder()
    .SetName("anotherName")
    .SetItem(new ArtifactItem(12))
    .Build();

License

Yash is licensed under the MIT license. See LICENSE for details.

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.  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. 
.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.

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.0.0 314 5/19/2023