LSL.YamlDotNet.VariableReplacement 2.0.5

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

Build status Coveralls branch NuGet

LSL.YamlDotNet.VariableReplacement

A YamlDotNet parser to replace variables in all Scalar values of a YAML document as it is being parsed.

NOTE: This example uses the variable replacement package found here.

Quick Start

NOTE: Version 2.0.0 and higher removes the dependency on LSL.VariableReplacer and changes the constructor to rely on a delegate that receive a string and returns a string

The following example shows variable replacement in action on a YAML file:

// Necessary usings:
using LSL.VariableReplacement;
using LSL.YamlDotNet.VariableReplacement;

...

var replacer = new VariableReplacerFactory()
    .Build(c => c.AddVariables(new Dictionary<string, object>
    {
        ["FirstName"] = "Al",
        ["LastName"] = "Jones",
        ["FieldName"] = "Name",
        ["FullName"] = "$(FirstName) $(LastName)"
    }));

var deserialiser = new DeserializerBuilder()
    .Build();

var result = deserialiser.Deserialize<MyTest>(
    new VariableReplacerParser(replacer.ReplaceVariables, new Parser(new StringReader(
    // Note the use of variables in keys as well as values
    """
    $(FieldName): $(FullName)
    Actual$(FieldName): $(FullName)
    Other: $(FullName)
    """
    )))
);

// result will have:
// result.Name == "Al Jones"
// result.ActualName == "Al Jones"
// result.Other == "Al Jones"
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. 
.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
2.0.5 155 4/4/2025
1.0.3 139 4/1/2025
1.0.2 141 4/1/2025