Repository navigation
Newline inconsistency in object expression #2990
Copy link
Copy link
Closed
Description
Issue created from fantomas-online
Code
let helpers =
{ new IDecoderHelpers<JToken> with
member _.isString jsonValue =
not (isNull jsonValue) && jsonValue.Type = JTokenType.String
member _.asFloat jsonValue = jsonValue.Value<float>()
member _.asInt jsonValue = jsonValue.Value<int>()
member _.getObjectKeys jsonValue =
jsonValue.Value<JObject>().Properties()
|> Seq.map (fun prop -> prop.Name)
member _.getField(fieldName: string, jsonValue: JToken) = jsonValue[fieldName]
}
let helpers2 =
{ new IDecoderHelpers<JToken> with
member _.anyToString jsonValue =
if isNull jsonValue then
"null"
else
use stream = new StringWriter(NewLine = "\n")
stream.ToString()
}Result
let helpers =
{ new IDecoderHelpers<JToken> with
member _.isString jsonValue =
not (isNull jsonValue) && jsonValue.Type = JTokenType.String
member _.asFloat jsonValue = jsonValue.Value<float>()
member _.asInt jsonValue = jsonValue.Value<int>()
member _.getObjectKeys jsonValue =
jsonValue.Value<JObject>().Properties() |> Seq.map (fun prop -> prop.Name)
member _.getField(fieldName: string, jsonValue: JToken) = jsonValue[fieldName]
}
let helpers2 =
{ new IDecoderHelpers<JToken> with
member _.anyToString jsonValue =
if isNull jsonValue then
"null"
else
use stream = new StringWriter(NewLine = "\n")
stream.ToString() }
Problem description
I believe it would be better if there was a new line between each member, this would make the code more consistent. I think that if all the member are single line then not having a new line is fine.
Also, the placement of the trailing } is not always placed on a new line. I don't know what triggers that because in my project, I have a similar code as the member _.anyToString jsonValue = method and the } is placed on a new line and indented under the leading {.
Extra information
- The formatted result breaks my code.
- The formatted result gives compiler warnings.
- I or my company would be willing to help fix this.
- I would like a release if this problem is solved.
Options
Fantomas main branch at 1/1/1990
{ config with
AlternativeLongMemberDefinitions = true
MultiLineLambdaClosingNewline = true }Did you know that you can ignore files when formatting by using a .fantomasignore file?
PS: It's unlikely that someone else will solve your specific issue, as it's something that you have a personal stake in.
Reactions are currently unavailable
Activity
nojaf commentedon Nov 18, 2023
Hi there,
This is a topic for the style guide.
In
helpers,}is placed on a new line because it had a blank line before it. That was preserved from the original code. This works as expected.MangelMaxime commentedon Nov 18, 2023
You say that
}is placed on a new line because there is blank line before however the following snippet results in the same formatting:Result
In both cases the
}is pushed to a new line under the leading{.Options
nojaf commentedon Nov 18, 2023
Oh, I see. Your original report did not mention
fsharp_multiline_bracket_style = stroustrup.Stroustrup cannot be applied in absolutely every situation. I was convinced that
was invalid code. (Producing an offset error).
In certain situations it can lead to invalid code.
This does not seem the case.
I am pretty sure we decided against this for object expressions.
@josh-degraw does this ring a bell?
So, we could double-check whether is indeed possible for object expressions.
If so, someone adds support for it. If not, we document that stroustrup cannot be used absolutely everywhere.
josh-degraw commentedon Nov 18, 2023
Yeah that's sounds correct to me as far as what we did. However, wouldn't something like this be valid if we wanted to more strictly apply Stroustrup here?
This would be how I would expect Stroustrup style to be applied here.
nojaf commentedon Nov 18, 2023
If it always leads to valid code, I'd be ok with this.
It really rings a bell that this wasn't the case.
Can't immediately find any prior art though.
nojaf commentedon Nov 18, 2023
It is mentioned in the style guide. Guess this is possible.
MangelMaxime commentedon Nov 18, 2023
Ah yes sorry, I have a hard time finding which settings I have setup locally and not in the online tool.
github-actions commentedon Apr 1, 2026
🤖 This is an automated response from Repo Assist.
I tested the examples from this issue against the current
mainbranch withfsharp_multiline_bracket_style = stroustrup.Closing
}placement — the inconsistency reported here appears to be fixed. Bothhelpers(multiline body ending cleanly) andhelpers2(multiline body withuse/let-in tail) now consistently place}on its own line:Blank lines between adjacent single-line members — as noted by
@nojafabove, the question of blank lines between interface members is a style-guide question. The current behaviour is:asFloatandasInt)This matches the Microsoft F# formatting guide for object expressions, which does not prescribe blank lines between single-line members.
If you are still seeing
}on the wrong line, or another inconsistency, with a current Fantomas version, please share a minimal repro and the Fantomas version number — I would be happy to investigate further. Otherwise this issue may be safe to close or moved todiscussionif you'd like to pursue the blank-line-between-all-members behaviour upstream.Bump the dotnet-sidecars group with 6 updates (#257)
Bump the packages group with 5 updates (#106)
Bump the packages group with 6 updates (#84)
Bump the packages group with 10 updates (#280)