Improve AA formatting

fix #143, fix Pure-D/code-d#188

README.md

@@ -49,6 +49,7 @@ found in .editorconfig files.
 * **--selective_import_space**: See **dfmt_selective_import_space** below
 * **--compact_labeled_statements**: See **dfmt_compact_labeled_statements** below
 * **--template_constraint_style**: See **dfmt_template_constraint_style** below
+* **--space_before_aa_colon**: See **dfmt_space_before_aa_colon** below
 
 ### Example
 ```
@@ -107,6 +108,7 @@ dfmt_selective_import_space | `true`, `false` | `true` | Insert space after the
 dfmt_compact_labeled_statements | `true`, `false` | `true` | Place labels on the same line as the labeled `switch`, `for`, `foreach`, or `while` statement.
 dfmt_template_constraint_style | `conditional_newline_indent` `conditional_newline` `always_newline` `always_newline_indent` | `conditional_newline_indent` | Control the formatting of template constraints.
 dfmt_single_template_constraint_indent | `true`, `false` | `false` | Set if the constraints are indented by a single tab instead of two. Has only an effect for if indentation style if set to `always_newline_indent` or `conditional_newline_indent`.
+dfmt_space_before_aa_colon | `true`, `false` | `false` | Adds a space after an associative array key before the `:` like in older dfmt versions.
 
 ## Terminology
 * Braces - `{` and `}`

src/dfmt/config.d

@@ -55,6 +55,8 @@ struct Config
     TemplateConstraintStyle dfmt_template_constraint_style;
     ///
     OptionalBoolean dfmt_single_template_constraint_indent;
+    ///
+    OptionalBoolean dfmt_space_before_aa_colon;
 
     mixin StandardEditorConfigFields;
 
@@ -82,6 +84,7 @@ struct Config
         dfmt_compact_labeled_statements = OptionalBoolean.t;
         dfmt_template_constraint_style = TemplateConstraintStyle.conditional_newline_indent;
         dfmt_single_template_constraint_indent = OptionalBoolean.f;
+        dfmt_space_before_aa_colon = OptionalBoolean.f;
     }
 
     /**

src/dfmt/formatter.d

@@ -576,12 +576,28 @@ private:
             // Use the close bracket as the indent token to distinguish
             // the array initialiazer from an array index in the newline
             // handling code
-            pushWrapIndent(tok!"]");
+            IndentStack.Details detail;
+            detail.wrap = false;
+            detail.temp = true;
+            detail.isAA = astInformation.assocArrayStartLocations.canFindIndex(tokens[index - 1].index);
+            pushWrapIndent(tok!"]", detail);
+
             newline();
             immutable size_t j = expressionEndIndex(index);
             linebreakHints = chooseLineBreakTokens(index, tokens[index .. j],
                     depths[index .. j], config, currentLineLength, indentLevel);
         }
+        else if (arrayInitializerStart)
+        {
+            // This is a short (non-breaking) AA value
+            IndentStack.Details detail;
+            detail.wrap = false;
+            detail.temp = true;
+            detail.isAA = true;
+            detail.mini = true;
+
+            pushWrapIndent(tok!"]", detail);
+        }
         else if (!currentIs(tok!")") && !currentIs(tok!"]")
                 && (linebreakHints.canFindIndex(index - 1) || (linebreakHints.length == 0
                     && currentLineLength > config.max_line_length)))
@@ -700,6 +716,11 @@ private:
             }
             else
             {
+                const inAA = indents.topIs(tok!"]") && indents.topDetails.isAA;
+
+                if (inAA && !config.dfmt_space_before_aa_colon)
+                    write(": ");
+                else
                     write(" : ");
                 index++;
             }
@@ -1368,6 +1389,11 @@ private:
             writeToken();
             newline();
         }
+        else if (indents.topIsTemp(tok!"]") && indents.topDetails.isAA && !indents.topDetails.mini)
+        {
+            writeToken();
+            newline();
+        }
         else if (!peekIs(tok!"}") && (linebreakHints.canFind(index)
                 || (linebreakHints.length == 0 && currentLineLength > config.max_line_length)))
         {

src/dfmt/main.d

@@ -89,6 +89,9 @@ else
             case "single_template_constraint_indent":
                 optConfig.dfmt_single_template_constraint_indent = optVal;
                 break;
+            case "space_before_aa_colon":
+                optConfig.dfmt_space_before_aa_colon = optVal;
+                break;
             default:
                 assert(false, "Invalid command-line switch");
             }
@@ -116,6 +119,7 @@ else
                 "split_operator_at_line_end", &handleBooleans,
                 "compact_labeled_statements", &handleBooleans,
                 "single_template_constraint_indent", &handleBooleans,
+                "space_before_aa_colon", &handleBooleans,
                 "tab_width", &optConfig.tab_width,
                 "template_constraint_style", &optConfig.dfmt_template_constraint_style);
             // dfmt on
@@ -314,6 +318,7 @@ Formatting Options:
     --split_operator_at_line_end
     --compact_labeled_statements
     --template_constraint_style
+    --space_before_aa_colon
         `,
             optionsToString!(typeof(Config.dfmt_template_constraint_style)));
 }

tests/allman/associative_array.d.ref

@@ -0,0 +1,26 @@
+unittest
+{
+    Bson base = Bson([
+            "maps": Bson([
+                Bson(["id": Bson(4), "comment": Bson("hello")]),
+                Bson(["id": Bson(49), "comment": Bson(null)])
+            ]),
+            "short": Bson(["a": "b", "c": "d"]),
+            "numbers": Bson([
+                1, 2, 3, 4, 5, 6, 7, 8, 9, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 0,
+                1, 2, 3, 4, 5, 6, 7, 8, 9, 0
+            ]),
+            "shuffleOnReset": serializeToBson([
+                "all": false,
+                "selected": true,
+                "maybe": false
+            ]),
+            "resetOnEmpty": Bson(false),
+            "applyMods": Bson(true),
+            "sendComments": Bson(true)
+            ]);
+    int[] x = [
+        1, 2, 3, 4, 5, 6, 7, 8, 9, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 0, 1, 2, 3,
+        4, 5, 6, 7, 8, 9, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 0
+    ];
+}

tests/associative_array.d

@@ -0,0 +1,26 @@
+unittest
+{
+	Bson base = Bson([
+		"maps": Bson([
+			Bson([
+				"id": Bson(4),
+				"comment": Bson("hello")
+			]),
+			Bson([
+				"id": Bson(49),
+				"comment": Bson(null)
+			])
+		]),
+		"short": Bson(["a": "b", "c": "d"]),
+		"numbers": Bson([1, 2, 3, 4, 5, 6, 7, 8, 9, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 0]),
+		"shuffleOnReset": serializeToBson([
+			"all": false,
+			"selected": true,
+			"maybe": false
+		]),
+		"resetOnEmpty": Bson(false),
+		"applyMods": Bson(true),
+		"sendComments": Bson(true)
+	]);
+	int[] x = [1, 2, 3, 4, 5, 6, 7, 8, 9, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 0];
+}

tests/issue0128.args

@@ -0,0 +1 @@
+--space_before_aa_colon=true

tests/otbs/associative_array.d.ref

@@ -0,0 +1,25 @@
+unittest {
+    Bson base = Bson([
+            "maps": Bson([
+                Bson(["id": Bson(4), "comment": Bson("hello")]),
+                Bson(["id": Bson(49), "comment": Bson(null)])
+            ]),
+            "short": Bson(["a": "b", "c": "d"]),
+            "numbers": Bson([
+                1, 2, 3, 4, 5, 6, 7, 8, 9, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 0,
+                1, 2, 3, 4, 5, 6, 7, 8, 9, 0
+            ]),
+            "shuffleOnReset": serializeToBson([
+                "all": false,
+                "selected": true,
+                "maybe": false
+            ]),
+            "resetOnEmpty": Bson(false),
+            "applyMods": Bson(true),
+            "sendComments": Bson(true)
+            ]);
+    int[] x = [
+        1, 2, 3, 4, 5, 6, 7, 8, 9, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 0, 1, 2, 3,
+        4, 5, 6, 7, 8, 9, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 0
+    ];
+}