Capture StartEndRange information in SynExpr.AnonRecd to fix #2566

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 ### Fixed
 * Idempotency problem with `struct end`. [#2592](https://github.com/fsprojects/fantomas/issues/2592)
+* Idempotency problem when having a comment in an anonymous record and Stroustrup formatting. [#2566](https://github.com/fsprojects/fantomas/issues/2566)
 
 ## [5.1.0-beta-001] - 2022-10-19
 

src/Fantomas.Core.Tests/MultilineBlockBracketsOnSameColumnRecordTests.fs

@@ -1395,3 +1395,60 @@ let f
     =
     x
 """
+
+[<Test>]
+let ``comment in bracket ranges of anonymous type, 2566`` () =
+    formatSourceString
+        false
+        """
+let x = {| // test1
+    Y = 42
+    Z = "string"
+    Foo = "Bar"
+    // test2
+    |}
+
+let y = {|
+    Y = 42
+    // test
+|}
+
+let z = {|
+    Y = 42
+|}
+
+let a = {| // test1
+    foo with
+    Level = 7
+    Square = 9
+    // test2
+|}
+"""
+        config
+    |> prepend newline
+    |> should
+        equal
+        """
+let x =
+    {| // test1
+        Y = 42
+        Z = "string"
+        Foo = "Bar"
+    // test2
+    |}
+
+let y =
+    {|
+        Y = 42
+    // test
+    |}
+
+let z = {| Y = 42 |}
+
+let a =
+    {| foo with// test1
+        Level = 7
+        Square = 9
+    // test2
+    |}
+"""

src/Fantomas.Core.Tests/RecordTests.fs

@@ -2179,3 +2179,59 @@ type ExprFolder<'State> =
             -> Exp
             -> 'State |}
 """
+
+[<Test>]
+let ``comment in bracket ranges of anonymous type`` () =
+    formatSourceString
+        false
+        """
+let x = {| // test1
+    Y = 42
+    Z = "string"
+    Foo = "Bar"
+    // test2
+    |}
+
+let y = {|
+    Y = 42
+    // test
+|}
+
+let z = {|
+    Y = 42
+|}
+
+let a = {| // test1
+    foo with
+    Level = 7
+    Square = 9
+    // test2
+|}
+"""
+        config
+    |> prepend newline
+    |> should
+        equal
+        """
+let x =
+    {| Y = // test1
+        42
+       Z = "string"
+       Foo = "Bar"
+    // test2
+     |}
+
+let y =
+    {| Y = 42
+    // test
+     |}
+
+let z = {| Y = 42 |}
+
+let a =
+    {| foo with// test1
+        Level = 7
+        Square = 9
+    // test2
+     |}
+"""

src/Fantomas.Core/AstTransformer.fs

@@ -231,12 +231,15 @@ and visitSynExpr (synExpr: SynExpr) : TriviaNode list =
                        yield mkNode SynExpr_Record_ClosingBrace closingBrace |])
             |> List.singleton
             |> finalContinuation
-        | SynExpr.AnonRecd (_, _, recordFields, range) ->
+        | SynExpr.AnonRecd (_, _, recordFields, StartEndRange 2 (openingBrace, range, closingBrace)) ->
             mkSynExprNode
                 SynExpr_AnonRecd
                 synExpr
                 range
-                (sortChildren [| yield! List.map visitAnonRecordField recordFields |])
+                (sortChildren
+                    [| yield mkNode SynExpr_AnonRecd_OpeningBrace openingBrace
+                       yield! List.map visitAnonRecordField recordFields
+                       yield mkNode SynExpr_AnonRecd_ClosingBrace closingBrace |])
             |> List.singleton
             |> finalContinuation
         | SynExpr.New (_, typeName, expr, range) ->

src/Fantomas.Core/CodePrinter.fs

@@ -915,18 +915,18 @@ and genExpr synExpr ctx =
                 let size = getRecordSize ctx xs
                 isSmallExpression size smallRecordExpr multilineRecordExpr ctx
 
-        | AnonRecord (isStruct, fields, copyInfo) ->
+        | AnonRecord (openingBrace, isStruct, fields, copyInfo, closingBrace) ->
             let smallExpression =
                 onlyIf isStruct !- "struct "
-                +> sepOpenAnonRecd
+                +> genTriviaFor SynExpr_AnonRecd_OpeningBrace openingBrace sepOpenAnonRecd
                 +> optSingle (fun e -> genExpr e +> !- " with ") copyInfo
                 +> col sepSemi fields genAnonRecordFieldName
-                +> sepCloseAnonRecd
+                +> genTriviaFor SynExpr_AnonRecd_ClosingBrace closingBrace sepCloseAnonRecd
 
             let longExpression =
                 ifAlignBrackets
-                    (genMultilineAnonRecordAlignBrackets isStruct fields copyInfo)
-                    (genMultilineAnonRecord isStruct fields copyInfo)
+                    (genMultilineAnonRecordAlignBrackets openingBrace isStruct fields copyInfo closingBrace)
+                    (genMultilineAnonRecord openingBrace isStruct fields copyInfo closingBrace)
 
             fun (ctx: Context) ->
                 let size = getRecordSize ctx fields
@@ -2363,23 +2363,23 @@ and genInheritConstructor (inheritCtor: SynType * SynExpr) =
         +> expressionFitsOnRestOfLine (genExpr px) (genMultilineFunctionApplicationArguments px)
     | OtherInheritConstructor (t, e) -> genType t +> sepSpaceOrIndentAndNlnIfExpressionExceedsPageWidth (genExpr e)
 
-and genMultilineAnonRecord (isStruct: bool) fields copyInfo =
+and genMultilineAnonRecord openingBrace (isStruct: bool) fields copyInfo closingBrace =
     let recordExpr =
         match copyInfo with
         | Some e ->
-            sepOpenAnonRecd
+            genTriviaFor SynExpr_AnonRecd_OpeningBrace openingBrace sepOpenAnonRecd
             +> atCurrentColumn (
                 genExpr e
                 +> (!- " with" +> indentSepNlnUnindent (col sepNln fields genAnonRecordFieldName))
             )
-            +> sepCloseAnonRecd
+            +> genTriviaFor SynExpr_AnonRecd_ClosingBrace closingBrace sepCloseAnonRecd
         | None ->
             fun ctx ->
                 // position after `{| ` or `{|`
                 let targetColumn = ctx.Column + (if ctx.Config.SpaceAroundDelimiter then 3 else 2)
 
                 atCurrentColumn
-                    (sepOpenAnonRecd
+                    (genTriviaFor SynExpr_AnonRecd_OpeningBrace openingBrace sepOpenAnonRecdFixed
                      +> col sepNln fields (fun (AnonRecordFieldName (ident, eq, e, range)) ->
                          let expr =
                              if ctx.Config.IndentSize < 3 then
@@ -2394,12 +2394,12 @@ and genMultilineAnonRecord (isStruct: bool) fields copyInfo =
                          +> genEq SynExpr_AnonRecd_Field_Equals eq
                          +> expr
                          +> leaveNodeFor SynExpr_AnonRecd_Field range)
-                     +> sepCloseAnonRecd)
+                     +> genTriviaFor SynExpr_AnonRecd_ClosingBrace closingBrace sepCloseAnonRecd)
                     ctx
 
     onlyIf isStruct !- "struct " +> recordExpr
 
-and genMultilineAnonRecordAlignBrackets (isStruct: bool) fields copyInfo =
+and genMultilineAnonRecordAlignBrackets openingBrace (isStruct: bool) fields copyInfo closingBrace =
     let fieldsExpr = col sepNln fields genAnonRecordFieldName
 
     let copyExpr fieldsExpr e =
@@ -2414,12 +2414,16 @@ and genMultilineAnonRecordAlignBrackets (isStruct: bool) fields copyInfo =
 
     let genAnonRecord =
         match copyInfo with
-        | Some ci -> sepOpenAnonRecd +> copyExpr fieldsExpr ci +> sepNln +> sepCloseAnonRecdFixed
+        | Some ci ->
+            genTriviaFor SynExpr_AnonRecd_OpeningBrace openingBrace sepOpenAnonRecd
+            +> copyExpr fieldsExpr ci
+            +> sepNln
+            +> genTriviaFor SynExpr_AnonRecd_ClosingBrace closingBrace sepCloseAnonRecdFixed
         | None ->
-            sepOpenAnonRecdFixed
+            genTriviaFor SynExpr_AnonRecd_OpeningBrace openingBrace sepOpenAnonRecd
             +> indentSepNlnUnindent fieldsExpr
             +> sepNln
-            +> sepCloseAnonRecdFixed
+            +> genTriviaFor SynExpr_AnonRecd_ClosingBrace closingBrace sepCloseAnonRecdFixed
 
     ifElse isStruct !- "struct " sepNone +> genAnonRecord
 

src/Fantomas.Core/SourceParser.fs

@@ -1071,7 +1071,8 @@ let (|Record|_|) =
 
 let (|AnonRecord|_|) =
     function
-    | SynExpr.AnonRecd (isStruct, copyInfo, fields, _) -> Some(isStruct, fields, Option.map fst copyInfo)
+    | SynExpr.AnonRecd (isStruct, copyInfo, fields, StartEndRange 2 (openingBrace, _, closingBrace)) ->
+        Some(openingBrace, isStruct, fields, Option.map fst copyInfo, closingBrace)
     | _ -> None
 
 let (|ObjExpr|_|) =

src/Fantomas.Core/TriviaTypes.fs

@@ -75,6 +75,8 @@ type FsAstType =
     | SynExpr_Record_OpeningBrace
     | SynExpr_Record_ClosingBrace
     | SynExpr_AnonRecd
+    | SynExpr_AnonRecd_OpeningBrace
+    | SynExpr_AnonRecd_ClosingBrace
     | SynExpr_AnonRecd_Field
     | SynExpr_AnonRecd_Field_Equals
     | SynExpr_New