← All languages

wildling

F# library and CLI for pattern-based string generation. Zero NuGet dependencies (.NET BCL only). Targets .NET 8.

Example

Install

From this repository:

cd fsharp
./build.sh
./bin/wildling "Year 19##"

From a release tag:

git clone --branch v2.0.7 --depth 1 https://github.com/dotmonk/wildling.git
cd wildling
./build.sh fsharp

Registry (CLI): NuGet package DotMonk.Wildling.FSharp is a .NET tool (PackAsTool), not a library PackageReference:

dotnet tool install -g DotMonk.Wildling.FSharp
wildling-fs "Year 19##"

Library: reference the project from a clone (or the built dist/ assembly).

open WildlingLib

let wildling = Wildling.Create([ "Year 19##" ])
let mutable value = wildling.Next()
while not (match value with :? bool as b -> b = false | _ -> false) do
    printfn "%O" value
    value <- wildling.Next()

Produces dist/wildling.dll when built from this tree. Requires the .NET 8 runtime, or Docker (the launcher falls back to the runtime image if dotnet is not on PATH).

CLI

./bin/wildling "Year 19##"
./bin/wildling --dictionary planets:../dictionaries/planets.txt "%{'planets'}"
./bin/wildling --template ./config.json

Help text and --check output follow docs/cli.md / docs/help.txt.

Build

./build.sh   # Docker (dotnet SDK 8): publish to dist/, copies help.txt

Project tests live in ../tests/ and are run with ../test.sh.