WoofWare.Myriad.Plugins
1.0.5
See the version list below for details.
dotnet add package WoofWare.Myriad.Plugins --version 1.0.5
NuGet\Install-Package WoofWare.Myriad.Plugins -Version 1.0.5
<PackageReference Include="WoofWare.Myriad.Plugins" Version="1.0.5" />
paket add WoofWare.Myriad.Plugins --version 1.0.5
#r "nuget: WoofWare.Myriad.Plugins, 1.0.5"
// Install WoofWare.Myriad.Plugins as a Cake Addin #addin nuget:?package=WoofWare.Myriad.Plugins&version=1.0.5 // Install WoofWare.Myriad.Plugins as a Cake Tool #tool nuget:?package=WoofWare.Myriad.Plugins&version=1.0.5
WoofWare.Myriad.Plugins
Some helpers in Myriad which might be useful.
These are currently somewhat experimental, and I personally am their primary customer.
The RemoveOptions
generator in particular is extremely half-baked.
Currently implemented:
JsonParse
(to stamp outjsonParse : JsonNode -> 'T
methods);RemoveOptions
(to stripoption
modifiers from a type).
JsonParse
Takes records like this:
[<MyriadPlugin.JsonParse>]
type InnerType =
{
[<JsonPropertyName "something">]
Thing : string
}
/// My whatnot
[<MyriadPlugin.JsonParse>]
type JsonRecordType =
{
/// A thing!
A : int
/// Another thing!
B : string
[<System.Text.Json.Serialization.JsonPropertyName "hi">]
C : int list
D : InnerType
}
and stamps out parsing methods like this:
/// Module containing JSON parsing methods for the InnerType type
[<RequireQualifiedAccess>]
[<CompilationRepresentation(CompilationRepresentationFlags.ModuleSuffix)>]
module InnerType =
/// Parse from a JSON node.
let jsonParse (node: System.Text.Json.Nodes.JsonNode) : InnerType =
let Thing = node.["something"].AsValue().GetValue<string>()
{ Thing = Thing }
namespace UsePlugin
/// Module containing JSON parsing methods for the JsonRecordType type
[<RequireQualifiedAccess>]
[<CompilationRepresentation(CompilationRepresentationFlags.ModuleSuffix)>]
module JsonRecordType =
/// Parse from a JSON node.
let jsonParse (node: System.Text.Json.Nodes.JsonNode) : JsonRecordType =
let D = InnerType.jsonParse node.["d"]
let C =
node.["hi"].AsArray() |> Seq.map (fun elt -> elt.GetValue<int>()) |> List.ofSeq
let B = node.["b"].AsValue().GetValue<string>()
let A = node.["a"].AsValue().GetValue<int>()
{ A = A; B = B; C = C; D = D }
What's the point?
System.Text.Json
, in a PublishAot
context, relies on C# source generators.
The default reflection-heavy implementations have the necessary code trimmed away, and result in a runtime exception.
But C# source generators are entirely unsupported in F#.
This Myriad generator expects you to use System.Text.Json
to construct a JsonNode
, and then the generator takes over to construct a strongly-typed object.
Limitations
This source generator is enough for what I first wanted to use it for. However, there is far more that could be done.
- Make it possible to give an exact format and cultural info in date and time parsing.
- Make it possible to reject parsing if extra fields are present.
- Rather than just throwing
NullReferenceException
, print out the field name that failed. - Generally support all the
System.Text.Json
attributes.
RemoveOptions
Takes a record like this:
type Foo =
{
A : int option
B : string
C : float list
}
and stamps out a record like this:
[<RequireQualifiedAccess>]
module Foo =
type Short =
{
A : int
B : string
C : float list
}
What's the point?
The motivating example is argument parsing. An argument parser naturally wants to express "the user did not supply this, so I will provide a default". But it's not a very ergonomic experience for the programmer to deal with all these options, so this Myriad generator stamps out a type without any options, and also stamps out an appropriate constructor function.
Limitations
This generator is far from where I want it, because I haven't really spent any time on it.
- It really wants to be able to recurse into the types within the record, to strip options from them.
- It needs some sort of attribute to mark a field as not receiving this treatment.
- What do we do about discriminated unions?
Detailed examples
See the tests. For example, PureGymDto.fs is a real-world set of DTOs.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net6.0 is compatible. 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. |
-
net6.0
- FSharp.Core (>= 6.0.1)
- Myriad.Core (>= 0.8.3)
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 |
---|---|---|
4.0.7 | 146 | 10/21/2024 |
4.0.6 | 308 | 10/14/2024 |
4.0.5 | 131 | 10/7/2024 |
4.0.4 | 83 | 10/6/2024 |
4.0.3 | 69 | 10/6/2024 |
4.0.2 | 69 | 10/6/2024 |
4.0.1 | 68 | 10/6/2024 |
3.1.4 | 78 | 10/3/2024 |
3.1.3 | 80 | 10/2/2024 |
3.1.2 | 73 | 10/2/2024 |
3.1.1 | 329 | 9/19/2024 |
3.0.2 | 83 | 9/19/2024 |
3.0.1 | 187 | 9/15/2024 |
2.3.10 | 114 | 9/15/2024 |
2.3.9 | 115 | 9/15/2024 |
2.3.8 | 116 | 9/14/2024 |
2.3.7 | 110 | 9/13/2024 |
2.3.6 | 129 | 9/12/2024 |
2.3.5 | 99 | 9/11/2024 |
2.3.4 | 125 | 9/10/2024 |
2.3.3 | 100 | 9/7/2024 |
2.3.2 | 115 | 9/5/2024 |
2.3.1 | 117 | 9/4/2024 |
2.2.7 | 109 | 9/4/2024 |
2.2.6 | 111 | 9/4/2024 |
2.2.5 | 110 | 9/4/2024 |
2.2.4 | 117 | 9/4/2024 |
2.2.3 | 117 | 9/3/2024 |
2.2.2 | 99 | 9/2/2024 |
2.2.1 | 386 | 8/26/2024 |
2.1.58 | 134 | 8/25/2024 |
2.1.57 | 229 | 8/13/2024 |
2.1.56 | 201 | 8/12/2024 |
2.1.55 | 89 | 8/4/2024 |
2.1.54 | 83 | 8/4/2024 |
2.1.53 | 324 | 7/8/2024 |
2.1.52 | 330 | 7/1/2024 |
2.1.51 | 127 | 7/1/2024 |
2.1.50 | 109 | 7/1/2024 |
2.1.49 | 122 | 6/27/2024 |
2.1.48 | 107 | 6/27/2024 |
2.1.47 | 121 | 6/24/2024 |
2.1.46 | 116 | 6/24/2024 |
2.1.45 | 497 | 6/17/2024 |
2.1.44 | 407 | 6/15/2024 |
2.1.43 | 98 | 6/10/2024 |
2.1.42 | 251 | 6/10/2024 |
2.1.41 | 97 | 6/9/2024 |
2.1.40 | 454 | 6/4/2024 |
2.1.39 | 100 | 6/3/2024 |
2.1.38 | 112 | 6/1/2024 |
2.1.37 | 86 | 5/31/2024 |
2.1.36 | 97 | 5/31/2024 |
2.1.35 | 101 | 5/31/2024 |
2.1.34 | 109 | 5/30/2024 |
2.1.33 | 105 | 5/30/2024 |
2.1.32 | 104 | 5/30/2024 |
2.1.31 | 115 | 5/30/2024 |
2.1.30 | 102 | 5/30/2024 |
2.1.29 | 105 | 5/28/2024 |
2.1.28 | 97 | 5/27/2024 |
2.1.27 | 98 | 5/24/2024 |
2.1.26 | 100 | 5/24/2024 |
2.1.25 | 97 | 5/24/2024 |
2.1.24 | 113 | 5/20/2024 |
2.1.23 | 99 | 5/20/2024 |
2.1.22 | 129 | 5/6/2024 |
2.1.21 | 104 | 4/30/2024 |
2.1.20 | 115 | 4/29/2024 |
2.1.19 | 104 | 4/29/2024 |
2.1.18 | 108 | 4/22/2024 |
2.1.17 | 105 | 4/17/2024 |
2.1.16 | 104 | 4/16/2024 |
2.1.15 | 110 | 4/16/2024 |
2.1.14 | 110 | 4/15/2024 |
2.1.13 | 126 | 3/19/2024 |
2.1.12 | 115 | 3/11/2024 |
2.1.11 | 109 | 3/4/2024 |
2.1.10 | 130 | 2/26/2024 |
2.1.9 | 124 | 2/26/2024 |
2.1.8 | 116 | 2/25/2024 |
2.1.7 | 120 | 2/25/2024 |
2.1.6 | 112 | 2/25/2024 |
2.1.5 | 106 | 2/19/2024 |
2.1.4 | 110 | 2/19/2024 |
2.1.3 | 102 | 2/18/2024 |
2.1.2 | 98 | 2/18/2024 |
2.1.1 | 107 | 2/17/2024 |
2.0.9 | 105 | 2/14/2024 |
2.0.8 | 119 | 2/13/2024 |
2.0.7 | 106 | 2/13/2024 |
2.0.6 | 106 | 2/13/2024 |
2.0.5 | 124 | 2/12/2024 |
2.0.4 | 110 | 2/7/2024 |
2.0.3 | 95 | 2/7/2024 |
2.0.2 | 97 | 2/7/2024 |
2.0.1 | 116 | 2/7/2024 |
1.4.15 | 117 | 2/6/2024 |
1.4.14 | 115 | 2/6/2024 |
1.4.13 | 97 | 2/6/2024 |
1.4.12 | 102 | 2/6/2024 |
1.4.11 | 121 | 2/6/2024 |
1.4.10 | 97 | 2/5/2024 |
1.4.9 | 107 | 1/30/2024 |
1.4.8 | 118 | 1/29/2024 |
1.4.7 | 99 | 1/29/2024 |
1.4.6 | 101 | 1/29/2024 |
1.4.5 | 103 | 1/28/2024 |
1.4.4 | 89 | 1/28/2024 |
1.4.3 | 107 | 1/26/2024 |
1.4.2 | 105 | 1/26/2024 |
1.4.1 | 87 | 1/26/2024 |
1.3.5 | 91 | 1/25/2024 |
1.3.4 | 120 | 1/15/2024 |
1.3.3 | 112 | 1/15/2024 |
1.3.2 | 126 | 1/8/2024 |
1.3.1 | 122 | 1/8/2024 |
1.2.3 | 122 | 1/3/2024 |
1.2.2 | 124 | 12/31/2023 |
1.2.1 | 129 | 12/30/2023 |
1.1.15 | 137 | 12/30/2023 |
1.1.14 | 136 | 12/30/2023 |
1.1.13 | 134 | 12/30/2023 |
1.1.12 | 130 | 12/30/2023 |
1.1.11 | 115 | 12/30/2023 |
1.1.10 | 138 | 12/29/2023 |
1.1.9 | 131 | 12/29/2023 |
1.1.8 | 130 | 12/29/2023 |
1.1.7 | 137 | 12/29/2023 |
1.1.6 | 142 | 12/29/2023 |
1.1.5 | 136 | 12/29/2023 |
1.1.4 | 130 | 12/29/2023 |
1.1.3 | 118 | 12/29/2023 |
1.1.2 | 122 | 12/28/2023 |
1.1.1 | 122 | 12/28/2023 |
1.0.6 | 124 | 12/28/2023 |
1.0.5 | 123 | 12/28/2023 |
1.0.4 | 126 | 12/27/2023 |