Feature: Align brackets

.github/workflows/main.yml

@@ -14,8 +14,7 @@ jobs:
     steps:
     - uses: actions/checkout@v1
     - name: Setup .NET Core
-      # Fix for https://github.com/actions/setup-dotnet/issues/29#issuecomment-548740241
-      uses: actions/setup-dotnet@bb95ce727fd49ec1a65933419cc7c91747785302
+      uses: actions/[email protected]
       with:
         dotnet-version: ${{ matrix.dotnet }}
     - name: Install local tools

.github/workflows/myget.yml

@@ -24,8 +24,7 @@ jobs:
       run: echo Build number is $BUILD_NUMBER
     - uses: actions/checkout@v1
     - name: Setup .NET Core
-      # Fix for https://github.com/actions/setup-dotnet/issues/29#issuecomment-548740241
-      uses: actions/setup-dotnet@bb95ce727fd49ec1a65933419cc7c91747785302
+      uses: actions/[email protected]
       with:
         dotnet-version: ${{ matrix.dotnet }}
     - name: Install local tools

docs/Documentation.md

@@ -286,6 +286,65 @@ That said, most of the preferences are very simple.
 But they demonstrate the flexibility of Fantomas on a set of configurations. 
 More preferences will be added depending on use cases.
 
+##### "AlignBrackets"
+
+Alternative style to format records, arrays and lists.
+If enabled, this will align the brackets (`{`, `{|`, `[`, `[|`) and (`}`, `|}`, `]`, `|]`) on the same line.
+
+```fsharp
+let myRecord = { Square = 9; Level = "Hard" }
+
+let arr = [|(1, 1, 1); (1, 2, 2); (1, 3, 3); (2, 1, 2); (2, 2, 4); (2, 3, 6); (3, 1, 3);
+  (3, 2, 6); (3, 3, 9)|]
+
+let anonRecord =
+    {| A = {| A1 = "string";A2LongerIdentifier = "foo" |};
+       B = {| B1 = 7 |}
+       C= { C1 = "foo"; C2LongerIdentifier = "bar"}
+       D = { D1 = "bar" } |}
+```
+
+becomes
+
+```fsharp
+let myRecord =
+    {
+        Square = 9
+        Level = "Hard"
+    }
+
+let arr =
+    [|
+        (1, 1, 1)
+        (1, 2, 2)
+        (1, 3, 3)
+        (2, 1, 2)
+        (2, 2, 4)
+        (2, 3, 6)
+        (3, 1, 3)
+        (3, 2, 6)
+        (3, 3, 9)
+    |]
+
+let anonRecord =
+    {|
+        A =
+            {|
+                A1 = "string"
+                A2LongerIdentifier = "foo"
+            |}
+        B = {| B1 = 7 |}
+        C =
+            {
+                C1 = "foo"
+                C2LongerIdentifier = "bar"
+            }
+        D = { D1 = "bar" }
+    |}
+```
+
+Only available from via `fantomas-config.json` config file.
+
 ##### `--config <Path to file or folder>`
 
 Use a JSON configuration file based on a [schema](../src/Fantomas/schema.json) to set the formatting options.
@@ -306,6 +365,7 @@ A default configuration file would look like
   "SpaceAroundDelimiter":true ,
   "KeepNewlineAfter":false,
   "MaxIfThenElseShortWidth":40,
+  "AlignBrackets": false,
   "StrictMode":false
 }
 ```

src/Fantomas.Tests/AlignBracketsArrayOrListTests.fs

@@ -0,0 +1,183 @@
+module Fantomas.Tests.AlignBracketsArrayOrListTests
+
+open NUnit.Framework
+open FsUnit
+open Fantomas.Tests.TestHelper
+
+let config = ({ config with
+                    AlignBrackets = true
+                    SpaceBeforeColon = true
+                    SpaceBeforeSemicolon = true })
+
+[<Test>]
+let ``array values``() =
+    formatSourceString false """
+let arr = [|(1, 1, 1); (1, 2, 2); (1, 3, 3); (2, 1, 2); (2, 2, 4); (2, 3, 6); (3, 1, 3);
+  (3, 2, 6); (3, 3, 9)|]
+    """ config
+    |> prepend newline
+    |> should equal """
+let arr =
+    [|
+        (1, 1, 1)
+        (1, 2, 2)
+        (1, 3, 3)
+        (2, 1, 2)
+        (2, 2, 4)
+        (2, 3, 6)
+        (3, 1, 3)
+        (3, 2, 6)
+        (3, 3, 9)
+    |]
+"""
+
+[<Test>]
+let ``list values``() =
+    formatSourceString false """
+let arr = [(1, 1, 1); (1, 2, 2); (1, 3, 3); (2, 1, 2); (2, 2, 4); (2, 3, 6); (3, 1, 3);
+  (3, 2, 6); (3, 3, 9)]
+    """ config
+    |> prepend newline
+    |> should equal """
+let arr =
+    [
+        (1, 1, 1)
+        (1, 2, 2)
+        (1, 3, 3)
+        (2, 1, 2)
+        (2, 2, 4)
+        (2, 3, 6)
+        (3, 1, 3)
+        (3, 2, 6)
+        (3, 3, 9)
+    ]
+"""
+
+[<Test>]
+let ``short list remains on one line`` () =
+    formatSourceString false """let defines = ["FOO";"BAR"]""" config
+    |> prepend newline
+    |> should equal """
+let defines = [ "FOO" ; "BAR" ]
+"""
+
+[<Test>]
+let ``array patterns``() =
+    formatSourceString false """
+let vectorLength vec =
+    match vec with
+    | [| var1 |] -> var1
+    | [| var1; var2 |] -> sqrt (var1*var1 + var2*var2)
+    | [| var1; var2; var3 |] -> sqrt (var1*var1 + var2*var2 + var3*var3)
+    | _ -> failwith "vectorLength called with an unsupported array size of %d." (vec.Length)""" config
+    |> prepend newline
+    |> should equal """
+let vectorLength vec =
+    match vec with
+    | [| var1 |] -> var1
+    | [| var1 ; var2 |] -> sqrt (var1 * var1 + var2 * var2)
+    | [| var1 ; var2 ; var3 |] -> sqrt (var1 * var1 + var2 * var2 + var3 * var3)
+    | _ -> failwith "vectorLength called with an unsupported array size of %d." (vec.Length)
+"""
+
+[<Test; Ignore("Awaiting feedback")>]
+let ``array comprehensions``() =
+    formatSourceString false """
+let a1 = [| for i in 1 .. 10 -> i * i |]
+let a2 = [| 0 .. 99 |]
+let a3 = [| for n in 1 .. 100 do if isPrime n then yield n |]""" config
+    |> prepend newline
+    |> should equal """
+let a1 =
+    [| for i in 1 .. 10 -> i * i |]
+
+let a2 = [| 0 .. 99 |]
+
+let a3 =
+    [|
+        for n in 1 .. 100 do
+            if isPrime n then yield n
+    |]
+"""
+
+[<Test>]
+let ``line comment after opening bracket list`` () =
+    formatSourceString false """let a = [ // some line comment
+    (1,2,3); (4,5,6); (7,8,9) ]
+"""  config
+    |> prepend newline
+    |> should equal """
+let a =
+    [ // some line comment
+        (1, 2, 3)
+        (4, 5, 6)
+        (7, 8, 9)
+    ]
+"""
+
+[<Test>]
+let ``line comment after opening bracket in short list`` () =
+    formatSourceString false """let a = [ // some line comment
+    a;b ]
+let bb = b
+"""  config
+    |> prepend newline
+    |> should equal """
+let a =
+    [ // some line comment
+        a
+        b
+    ]
+let bb = b
+"""
+
+[<Test>]
+let ``line comment after opening bracket array`` () =
+    formatSourceString false """let a = [| // some line comment
+    (1,2,3); (4,5,6); (7,8,9) |]
+"""  config
+    |> prepend newline
+    |> should equal """
+let a =
+    [| // some line comment
+        (1, 2, 3)
+        (4, 5, 6)
+        (7, 8, 9)
+    |]
+"""
+
+[<Test>]
+let ``line comment before closing bracket list`` () =
+    formatSourceString false """let a = [
+    (1,2,3); (4,5,6); (7,8,9)
+    // some line comment
+    ]
+"""  config
+    |> prepend newline
+    |> should equal """
+let a =
+    [
+        (1, 2, 3)
+        (4, 5, 6)
+        (7, 8, 9)
+    // some line comment
+    ]
+"""
+
+[<Test>]
+let ``line comment before closing bracket array`` () =
+    formatSourceString false """let a = [|
+    (1,2,3); (4,5,6); (7,8,9)
+    // some line comment
+    |]
+"""  config
+    |> prepend newline
+    |> should equal """
+let a =
+    [|
+        (1, 2, 3)
+        (4, 5, 6)
+        (7, 8, 9)
+    // some line comment
+    |]
+"""