fsharp-idiom-review
Skill23 starsChanged 32 days agoMITView on GitHub
Review an F# change for C#-shaped code before you finish it. Use when writing, porting from C#, or reviewing F# that returns tuples, uses out parameters or bool * value pairs, chains if/elif on discrete values, uses let mutable with loops, indexes lists by position, makes several passes over one collection, or builds code text by string concatenation.
In this repository16 other files it gives its agents.
- AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- fsharp-async-compositionSkill
- fsharp-binary-compatibilitySkill
- fsharp-env-capabilitiesSkill
- fsharp-failure-pathsSkill
- fsharp-iwsam-errorsSkill
- fsharp-library-api-designSkill
- fsharp-native-aotSkill
- fsharp-nullness-interopSkill
- fsharp-performance-typesSkill
- fsharp-serializationSkill
- fsharp-signature-filesSkill
- fsharp-verify-apiSkill
- optimize-fsharp-typecheck-graphSkill
- parse-dont-validateSkill
The file
We split this skill into the rules it gives an agent
4 rules. About 0 are common, 2 are distinctive, and 2 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈2
Distinctive · estimate
This author's own choices. Worth a look.
2
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 41
match, notif/elif, for discrete values: Use match for string literals, union cases, enum values, and tuples. - Very specific: line 53
Expression, not
let mutablewith a loop or branches: Use List.sumBy, List.fold, or List.map for accumulators. - Distinctive: line 131
Run the code and its tests again.
- Distinctive: line 135
Run the proof script from the skill root:
≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
F# idiom review
The compiler accepts C#-shaped F#. Human reviewers then ask for a different shape. Review evidence ranks idiomatic readability and collection efficiency among the strongest categories of human comments on agent F# code. Codex and opencode sessions also hold 5 user corrections on this subject, for example: "can use a match statement instead of a mutable".
Apply this checklist to your own diff before you finish. It is most important when you port C# code, because a line-by-line port keeps the C# shape. For domain modeling (constrained types, private constructors, unions for states), use parse-dont-validate. This skill does not repeat it.
Checklist
Each item shows the shape to find and the shape to use. references/EXAMPLES.md has longer examples and the exceptions.
Record, not tuple, for named results. A function that returns or stores three or more values, or two values of the same type, returns a record.
// Before let computeTotals order : decimal * decimal * int = (subtotal, discount, itemCount) // After type Totals = { Subtotal: decimal; Discount: decimal; ItemCount: int } let computeTotals order = { Subtotal = subtotal; Discount = discount; ItemCount = itemCount }Option, not out parameter or
bool * value. Port a C#TryX(..., out T value)method to a function that returnsT option.// Before let tryGetRate code : bool * decimal = if code = "SAVE10" then (true, 0.10m) else (false, 0m) // After let tryGetRate code = match code with "SAVE10" -> Some 0.10m | _ -> NoneAt a call to a .NET
TryParsemethod, match the tuple once and return an option:match Int32.TryParse s with | true, v -> Some v | _ -> None.match, notif/elif, for discrete values. Usematchfor string literals, union cases, enum values, and tuples. Keepif/eliffor ordered numeric ranges such asif total >= 1000m.// Before if code = "SAVE10" then Some 0.10m elif code = "SAVE25" then Some 0.25m else None // After match code with | "SAVE10" -> Some 0.10m | "SAVE25" -> Some 0.25m | _ -> NoneExpression, not
let mutablewith a loop or branches. UseList.sumBy,List.fold, orList.mapfor accumulators. Bind the result of amatchorifinstead of assigning in each branch.// Before let mutable subtotal = 0m for line in lines do subtotal <- subtotal + line.Price let mutable discount = 0m if ok then discount <- subtotal * rate // After let subtotal = lines |> List.sumBy _.Price let discount = match rate with Some r -> subtotal * r | None -> 0mList.tryFind, not a loop with an early exit. F# has noreturn. A port offoreach ... if (...) return x;usestryFind,tryPick,exists, orforall, not a mutable flag.// Before let mutable found = None for l in lines do if found.IsNone && not l.InStock then found <- Some l // After let found = lines |> List.tryFind (fun l -> not l.InStock)No position index on an F# list.
xs.[i]andList.item iwalk the list from the head, so a loop over0 .. xs.Length - 1is quadratic. UseList.mapi,List.iteri, orList.indexed. Use an array when you need random access.// Before for i in 0 .. lines.Length - 1 do printfn "%d. %s" (i + 1) lines.[i].Sku // After lines |> List.iteri (fun i l -> printfn "%d. %s" (i + 1) l.Sku)One pass where one pass is enough. Use
List.sumByforList.map >> List.sum,List.tryFindforList.filter >> List.tryHead, andList.existsforList.filter >> List.isEmpty >> not. Do not enumerate aseqtwice: aseqfrom a query or a file runs its work again. Materialize it once withList.ofSeq, or compute the aggregates in onefold.// Before let total = lines |> List.map (fun l -> l.Price) |> List.sum // After let total = lines |> List.sumBy _.Pricematch!, notlet!and thenmatch. Intask,async, and other computation expressions, match the awaited value directly.// Before let! user = loadUser id match user with | Some u -> return u.Name | None -> return "unknown" // After match! loadUser id with | Some u -> return u.Name | None -> return "unknown"static member valfor a value computed once.static member X = expris a property. It runsexpron each access. Usestatic member val X = expr, or a module-levellet, for a shared value.// Before: a new options object on each access static member Options = JsonSerializerOptions(PropertyNameCaseInsensitive = true) // After static member val Options = JsonSerializerOptions(PropertyNameCaseInsensitive = true)A syntax API, not string concatenation, to make code or markup. When the target format has a builder (Fantomas
OakandAst, RoslynSyntaxFactory,XElement,Utf8JsonWriter), use it. Concatenated text breaks on quotes, escapes, and indentation.// Before let xml = "<item sku=\"" + sku + "\"/>" // After let xml = XElement(XName.Get "item", XAttribute(XName.Get "sku", sku)).ToString()
Steps
- List each tuple return,
bool * valuepair, out parameter,if/elifchain,let mutable,fororwhileloop, list index, chained collection pass,let!followed bymatch,static memberwith a computed value, and string-built code in your diff. Done when each item is on the list. - For each item, apply the checklist entry, or keep it and state the reason. Valid reasons: a measured hot path, a .NET API that requires the shape, or an ordered numeric range for
if/elif. - Run the code and its tests again. The public behavior must not change.
Verify
Run the proof script from the skill root:
pwsh ./scripts/run.ps1The script runs each before form and each after form and checks that they give the same result.
It also shows that static member X = expr runs expr on each access and static member val runs it once.
It fails when an expected result does not occur.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

