Getting started

Installing the package

To install the latest version of FSharpWrap using the .NET CLI, use the following:

1: 

dotnet add package FSharpWrap

Using generated code

In order to use the generated code in your project, add the following element to your project file in an <ItemGroup> above all other <Compile> items:

1: 

<Compile Include="$(FSharpWrapOutputFile)" />

Because the generated code is quite large by default, the following should also be added to a .gitignore file:

1: 

*.autogen.fs

Any instance methods, constructors, instance read-only fields, and get-only properties on classes and immutable structs will then have F# functions, active patterns, or computation expressions generated for them.

 1: 
 2: 
 3: 
 4: 
 5: 
 6: 
 7: 
 8: 
 9: 
10: 
11: 
12: 
13: 
14: 
15: 
16: 
17: 
18: 
19: 
20: 
21: 
22: 
23: 
24: 
25: 
26: 
27: 

open System.Collections.Generic
open System.Collections.Immutable

// Constructors
let stack: Stack<_> = [ 1..10 ] |> Stack.ofSeq

// Instance method call
let a: bool = Stack.contains 5 stack

// Get-only properties
let b: int = Stack.count stack
let c: string =
    let nums = stack.ToImmutableList()
    match nums with
    | ImmutableList.IsEmpty -> "read-only"
    | _ -> "not read-only"

// Computation expressions
let d: Stack<_> =
    Stack.expr {
        for num in stack do num
        11;
        12;
        13;
    }

d :> seq<_> |> printfn "d is %A"

d is seq [13; 12; 11; 1; ...]

Filtering generated code

FSharpWrap allows entire assemblies and namespaces to be included or excluded from code generation, which helps reduce compilation times by generating only code that you will use. Note that assemblies can only either be included or excluded, and that namespaces can only either be included or excluded.

To only include certain assemblies in code generation, use the following:

1: 
2: 
3: 
4: 

<ItemGroup>
  <!-- Only assemblies with the following names will be included in code generation -->
  <FSharpWrapIncludeNames Include="System.Collections.Immutable;Expecto" />
</ItemGroup>

To only exclude certain assemblies from code generation, use the following:

1: 
2: 
3: 

<ItemGroup>
  <FSharpWrapExcludeNames Include="System.Reflection.MetadataLoadContext;FSharp.Core" />
</ItemGroup>

Following the inclusion or exclusion of assemblies, FSharpWrap will also include or exclude any specified namespaces. Note that in order to include or exclude any "child" namespaces, their names must be specified as well.

To only include the types in certain namespaces, use the following:

1: 
2: 
3: 

<ItemGroup>
  <FSharpWrapIncludeNamespaces Include="System.Collections.Immutable;System.Collections" />
</ItemGroup>

To only exclude types in certain namespaces, use the following:

1: 
2: 
3: 
4: 

<ItemGroup>
  <!-- Only the types in the System.Reflection, Microsoft.FSharp.Core, or FParsec namespaces are excluded -->
  <FSharpWrapExcludeNamespaces Include="System.Reflection;Microsoft.FSharp.Core;FParsec" />
</ItemGroup>

Code Generation Limitations

Only public members are included in code generation.

Currently, any non-readonly structs (structs not marked IsReadOnly in F#) are excluded from code generation.