FSharp.FsxConfig 1.0.2

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

FSharp.FsxConfig

A simple tool that allows using fsx files for configuration.

Note

There is a convention in place for the name of the function that is changing the config in the script file: changeConfiguration

Limitations

Doesn't support saving a new configuration at runtime.

Usage example

You can watch the example in tests\FSharp.FsxConfig.Tests or follow the description below:

dotnet new console -lang F#
dotnet add package FSharp.FsxConfig

Change the content of the program.fs with:

open FSharp.FsxConfig

type MyConfiguration = {
    athing: int
    something: string
}
module MyConfiguration = 
    let internal Default: MyConfiguration = { athing = 1; something = "default value" }

MyConfiguration.Default
|> applyScriptConfiguration "change app configuration.fsx"
|> Result.bind (applyScriptConfiguration "config.fsx")
|> printfn "Hello from F# %A"    

Create some 2 script files (check names from above example, and replace your project build output in the #r include):

#r "bin/Debug/net9.0/REPLACE_ME_WITH_YOUR_PROJECT_NAME.dll"

let changeConfiguration (conf: Program.MyConfiguration) =
    // you can have comments, the tooling will let you know if the typing is out of synch
    { conf with athing = conf.athing + 10 }
dotnet run

Troubleshooting

  • something is wrong with files location, references, etc. you can see the details of errors in console by enabling verbose messages: FSharp.FsxConfig.verbose <- true
Product Compatible and additional computed target framework versions.
.NET 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.  net9.0 is compatible.  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 is compatible.  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. 
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.2 87 9/4/2026
1.0.1 609 6/10/2022
1.0.0 559 6/9/2022

Multi-targets net8.0/net9.0/net10.0 with a matching FSharp.Compiler.Service per target framework to avoid NU1605/NU1608 FSharp.Core warnings.