feat(graphql_formatter): implement BracketSpacing option (#3310)

Co-authored-by: Ze-Zheng Wu <zezhengwu@proton.me>
biomejs · Jun 30, 2024 · f741a13 · f741a13
1 parent c671252
commit f741a13
Show file tree

Hide file tree

Showing 67 changed files with 696 additions and 223 deletions.
diff --git a/crates/biome_cli/src/commands/rage.rs b/crates/biome_cli/src/commands/rage.rs
@@ -217,6 +217,7 @@ impl Display for RageConfiguration<'_, '_> {
                             {KeyValuePair("Line ending", markup!({DebugDisplay(formatter_configuration.line_ending)}))}
                             {KeyValuePair("Line width", markup!({DebugDisplay(formatter_configuration.line_width.value())}))}
                             {KeyValuePair("Attribute position", markup!({DebugDisplay(formatter_configuration.attribute_position)}))}
+                            {KeyValuePair("Bracket spacing", markup!({DebugDisplay(formatter_configuration.bracket_spacing)}))}
                             {KeyValuePair("Ignore", markup!({DebugDisplay(formatter_configuration.ignore.iter().collect::<Vec<_>>())}))}
                             {KeyValuePair("Include", markup!({DebugDisplay(formatter_configuration.include.iter().collect::<Vec<_>>())}))}
                         ).fmt(fmt)?;
@@ -231,14 +232,14 @@ impl Display for RageConfiguration<'_, '_> {
                             {KeyValuePair("Trailing commas", markup!({DebugDisplay(javascript_formatter_configuration.trailing_commas)}))}
                             {KeyValuePair("Semicolons", markup!({DebugDisplay(javascript_formatter_configuration.semicolons)}))}
                             {KeyValuePair("Arrow parentheses", markup!({DebugDisplay(javascript_formatter_configuration.arrow_parentheses)}))}
-                            {KeyValuePair("Bracket spacing", markup!({DebugDisplay(javascript_formatter_configuration.bracket_spacing)}))}
+                            {KeyValuePair("Bracket spacing", markup!({DebugDisplayOption(javascript_formatter_configuration.bracket_spacing)}))}
                             {KeyValuePair("Bracket same line", markup!({DebugDisplay(javascript_formatter_configuration.bracket_same_line)}))}
                             {KeyValuePair("Quote style", markup!({DebugDisplay(javascript_formatter_configuration.quote_style)}))}
                             {KeyValuePair("Indent style", markup!({DebugDisplayOption(javascript_formatter_configuration.indent_style)}))}
                             {KeyValuePair("Indent width", markup!({DebugDisplayOption(javascript_formatter_configuration.indent_width)}))}
                             {KeyValuePair("Line ending", markup!({DebugDisplayOption(javascript_formatter_configuration.line_ending)}))}
                             {KeyValuePair("Line width", markup!({DebugDisplayOption(javascript_formatter_configuration.line_width.map(|lw| lw.value()))}))}
-                            {KeyValuePair("Attribute position", markup!({DebugDisplay(javascript_formatter_configuration.attribute_position)}))}
+                            {KeyValuePair("Attribute position", markup!({DebugDisplayOption(javascript_formatter_configuration.attribute_position)}))}
                         )
                         .fmt(fmt)?;
 
@@ -275,7 +276,8 @@ impl Display for RageConfiguration<'_, '_> {
                             {KeyValuePair("Indent width", markup!({DebugDisplayOption(graphql_formatter_configuration.indent_width)}))}
                             {KeyValuePair("Line ending", markup!({DebugDisplayOption(graphql_formatter_configuration.line_ending)}))}
                             {KeyValuePair("Line width", markup!({DebugDisplayOption(graphql_formatter_configuration.line_width)}))}
-                            {KeyValuePair("Quote style", markup!({DebugDisplay(graphql_formatter_configuration.quote_style)}))}
+                            {KeyValuePair("Bracket spacing", markup!({DebugDisplayOption(graphql_formatter_configuration.bracket_spacing)}))}
+                            {KeyValuePair("Quote style", markup!({DebugDisplayOption(graphql_formatter_configuration.quote_style)}))}
                         ).fmt(fmt)?;
                     }
 

diff --git a/crates/biome_cli/src/execute/migrate/prettier.rs b/crates/biome_cli/src/execute/migrate/prettier.rs
@@ -5,7 +5,8 @@ use biome_deserialize::{json::deserialize_from_json_str, StringSet};
 use biome_deserialize_macros::Deserializable;
 use biome_diagnostics::{DiagnosticExt, PrintDiagnostic};
 use biome_formatter::{
-    AttributePosition, IndentWidth, LineEnding, LineWidth, ParseFormatNumberError, QuoteStyle,
+    AttributePosition, BracketSpacing, IndentWidth, LineEnding, LineWidth, ParseFormatNumberError,
+    QuoteStyle,
 };
 use biome_fs::{FileSystem, OpenOptions};
 use biome_js_formatter::context::{ArrowParentheses, QuoteProperties, Semicolons, TrailingCommas};
@@ -210,6 +211,7 @@ impl TryFrom<PrettierConfiguration> for biome_configuration::PartialConfiguratio
             enabled: Some(true),
             // deprecated
             indent_size: None,
+            bracket_spacing: Some(BracketSpacing::default()),
         };
         result.formatter = Some(formatter);
 
@@ -246,7 +248,7 @@ impl TryFrom<PrettierConfiguration> for biome_configuration::PartialConfiguratio
             trailing_comma: None,
             quote_style: Some(quote_style),
             quote_properties: Some(value.quote_props.into()),
-            bracket_spacing: Some(value.bracket_spacing),
+            bracket_spacing: Some(value.bracket_spacing.into()),
             jsx_quote_style: Some(jsx_quote_style),
             attribute_position: Some(AttributePosition::default()),
         };
@@ -349,7 +351,6 @@ impl TryFrom<Override> for biome_configuration::OverridePattern {
                 .map(|trailing_comma| trailing_comma.into()),
             quote_style,
             quote_properties: options.quote_props.map(|quote_props| quote_props.into()),
-            bracket_spacing: options.bracket_spacing,
             jsx_quote_style,
             ..Default::default()
         };

diff --git a/crates/biome_cli/tests/commands/format.rs b/crates/biome_cli/tests/commands/format.rs
@@ -121,6 +121,17 @@ let foo = {a, b};
 const {a, b} = foo;
 "#;
 
+const APPLY_BRACKET_SPACING_BEFORE_GRAPHQL: &str = r#"{
+	field_value(
+		object_value: {key: "value"}
+	)
+}"#;
+
+const APPLY_BRACKET_SPACING_AFTER_GRAPHQL: &str = r#"{
+	field_value(object_value: {key: "value"})
+}
+"#;
+
 const APPLY_BRACKET_SAME_LINE_BEFORE: &str = r#"<Foo
 	className={style}
 	reallyLongAttributeName1={longComplexValue}
@@ -3768,3 +3779,42 @@ fn should_error_if_unchanged_files_only_with_changed_flag() {
         result,
     ));
 }
+
+#[test]
+fn applies_custom_bracket_spacing_for_graphql() {
+    let mut fs = MemoryFileSystem::default();
+    let mut console = BufferConsole::default();
+
+    let file_path = Path::new("file.graphql");
+    fs.insert(
+        file_path.into(),
+        APPLY_BRACKET_SPACING_BEFORE_GRAPHQL.as_bytes(),
+    );
+
+    let result = run_cli(
+        DynRef::Borrowed(&mut fs),
+        &mut console,
+        Args::from(
+            [
+                ("format"),
+                ("--bracket-spacing"),
+                ("false"),
+                ("--write"),
+                file_path.as_os_str().to_str().unwrap(),
+            ]
+            .as_slice(),
+        ),
+    );
+
+    assert!(result.is_ok(), "run_cli returned {result:?}");
+
+    assert_file_contents(&fs, file_path, APPLY_BRACKET_SPACING_AFTER_GRAPHQL);
+
+    assert_cli_snapshot(SnapshotPayload::new(
+        module_path!(),
+        "applies_custom_bracket_spacing_graphql",
+        fs,
+        console,
+        result,
+    ));
+}
diff --git a/crates/biome_cli/tests/snapshots/main_commands_check/check_help.snap b/crates/biome_cli/tests/snapshots/main_commands_check/check_help.snap
@@ -31,6 +31,8 @@ The configuration that is contained inside the file `biome.json`
         --line-width=NUMBER   What's the max width of a line. Defaults to 80.
         --attribute-position=<multiline|auto>  The attribute position style in HTMLish languages. By
                               default auto.
+        --bracket-spacing=<true|false>  Whether to insert spaces around brackets in object literals.
+                              Defaults to true.
         --jsx-quote-style=<double|single>  The type of quotes used in JSX. Defaults to double.
         --quote-properties=<preserve|as-needed>  When properties in objects are quoted. Defaults to asNeeded.
         --trailing-comma=<all|es5|none>  Print trailing commas wherever possible in multi-line comma-separated
@@ -41,8 +43,6 @@ The configuration that is contained inside the file `biome.json`
                               only in for statements where it is necessary because of ASI.
         --arrow-parentheses=<always|as-needed>  Whether to add non-necessary parentheses to arrow functions.
                               Defaults to "always".
-        --bracket-spacing=<true|false>  Whether to insert spaces around brackets in object literals.
-                              Defaults to true.
         --bracket-same-line=<true|false>  Whether to hug the closing bracket of multiline HTML/JSX tags
                               to the end of the last line, rather than being alone on the following line.
                               Defaults to false.

diff --git a/crates/biome_cli/tests/snapshots/main_commands_ci/ci_help.snap b/crates/biome_cli/tests/snapshots/main_commands_ci/ci_help.snap
@@ -33,6 +33,8 @@ The configuration that is contained inside the file `biome.json`
         --line-width=NUMBER   What's the max width of a line. Defaults to 80.
         --attribute-position=<multiline|auto>  The attribute position style in HTMLish languages. By
                               default auto.
+        --bracket-spacing=<true|false>  Whether to insert spaces around brackets in object literals.
+                              Defaults to true.
         --jsx-quote-style=<double|single>  The type of quotes used in JSX. Defaults to double.
         --quote-properties=<preserve|as-needed>  When properties in objects are quoted. Defaults to asNeeded.
         --trailing-comma=<all|es5|none>  Print trailing commas wherever possible in multi-line comma-separated
@@ -43,8 +45,6 @@ The configuration that is contained inside the file `biome.json`
                               only in for statements where it is necessary because of ASI.
         --arrow-parentheses=<always|as-needed>  Whether to add non-necessary parentheses to arrow functions.
                               Defaults to "always".
-        --bracket-spacing=<true|false>  Whether to insert spaces around brackets in object literals.
-                              Defaults to true.
         --bracket-same-line=<true|false>  Whether to hug the closing bracket of multiline HTML/JSX tags
                               to the end of the last line, rather than being alone on the following line.
                               Defaults to false.

diff --git a/...iome_cli/tests/snapshots/main_commands_format/applies_custom_bracket_spacing_graphql.snap b/...iome_cli/tests/snapshots/main_commands_format/applies_custom_bracket_spacing_graphql.snap
@@ -0,0 +1,18 @@
+---
+source: crates/biome_cli/tests/snap_test.rs
+expression: content
+---
+## `file.graphql`
+
+```graphql
+{
+	field_value(object_value: {key: "value"})
+}
+
+```
+
+# Emitted Messages
+
+```block
+Formatted 1 file in <TIME>. Fixed 1 file.
+```
diff --git a/crates/biome_cli/tests/snapshots/main_commands_format/format_help.snap b/crates/biome_cli/tests/snapshots/main_commands_format/format_help.snap
@@ -17,6 +17,8 @@ Generic options applied to all files
         --line-width=NUMBER   What's the max width of a line. Defaults to 80.
         --attribute-position=<multiline|auto>  The attribute position style in HTMLish languages. By
                               default auto.
+        --bracket-spacing=<true|false>  Whether to insert spaces around brackets in object literals.
+                              Defaults to true.
 
 Formatting options specific to the JavaScript files
         --jsx-quote-style=<double|single>  The type of quotes used in JSX. Defaults to double.
@@ -29,8 +31,6 @@ Formatting options specific to the JavaScript files
                               only in for statements where it is necessary because of ASI.
         --arrow-parentheses=<always|as-needed>  Whether to add non-necessary parentheses to arrow functions.
                               Defaults to "always".
-        --bracket-spacing=<true|false>  Whether to insert spaces around brackets in object literals.
-                              Defaults to true.
         --bracket-same-line=<true|false>  Whether to hug the closing bracket of multiline HTML/JSX tags
                               to the end of the last line, rather than being alone on the following line.
                               Defaults to false.
@@ -49,6 +49,8 @@ Formatting options specific to the JavaScript files
         --quote-style=<double|single>  The type of quotes used in JavaScript code. Defaults to double.
         --javascript-attribute-position=<multiline|auto>  The attribute position style in jsx elements.
                               Defaults to auto.
+        --bracket-spacing=<true|false>  Whether to insert spaces around brackets in object literals.
+                              Defaults to true.
 
 Set of properties to integrate Biome with a VCS software.
         --vcs-client-kind=<git>  The kind of client.

diff --git a/crates/biome_cli/tests/snapshots/main_commands_migrate_prettier/prettier_migrate.snap b/crates/biome_cli/tests/snapshots/main_commands_migrate_prettier/prettier_migrate.snap
@@ -30,24 +30,25 @@ biome.json migrate ━━━━━━━━━━━━━━━━━━━━
        6 │ + → → "indentWidth":·2,
        7 │ + → → "lineEnding":·"lf",
        8 │ + → → "lineWidth":·80,
-       9 │ + → → "attributePosition":·"auto"
-      10 │ + → },
-      11 │ + → "linter":·{·"enabled":·true·},
-      12 │ + → "javascript":·{
-      13 │ + → → "formatter":·{
-      14 │ + → → → "jsxQuoteStyle":·"double",
-      15 │ + → → → "quoteProperties":·"asNeeded",
-      16 │ + → → → "trailingCommas":·"all",
-      17 │ + → → → "semicolons":·"always",
-      18 │ + → → → "arrowParentheses":·"always",
-      19 │ + → → → "bracketSpacing":·true,
+       9 │ + → → "attributePosition":·"auto",
+      10 │ + → → "bracketSpacing":·true
+      11 │ + → },
+      12 │ + → "linter":·{·"enabled":·true·},
+      13 │ + → "javascript":·{
+      14 │ + → → "formatter":·{
+      15 │ + → → → "jsxQuoteStyle":·"double",
+      16 │ + → → → "quoteProperties":·"asNeeded",
+      17 │ + → → → "trailingCommas":·"all",
+      18 │ + → → → "semicolons":·"always",
+      19 │ + → → → "arrowParentheses":·"always",
       20 │ + → → → "bracketSameLine":·false,
       21 │ + → → → "quoteStyle":·"single",
-      22 │ + → → → "attributePosition":·"auto"
-      23 │ + → → }
-      24 │ + → }
-      25 │ + }
-      26 │ + 
+      22 │ + → → → "attributePosition":·"auto",
+      23 │ + → → → "bracketSpacing":·true
+      24 │ + → → }
+      25 │ + → }
+      26 │ + }
+      27 │ + 
   
 
 ```

diff --git a/...iome_cli/tests/snapshots/main_commands_migrate_prettier/prettier_migrate_end_of_line.snap b/...iome_cli/tests/snapshots/main_commands_migrate_prettier/prettier_migrate_end_of_line.snap
@@ -34,23 +34,24 @@ biome.json migrate ━━━━━━━━━━━━━━━━━━━━
        6 │ + → → "indentWidth":·2,
        7 │ + → → "lineEnding":·"lf",
        8 │ + → → "lineWidth":·80,
-       9 │ + → → "attributePosition":·"auto"
-      10 │ + → },
-      11 │ + → "javascript":·{
-      12 │ + → → "formatter":·{
-      13 │ + → → → "jsxQuoteStyle":·"double",
-      14 │ + → → → "quoteProperties":·"asNeeded",
-      15 │ + → → → "trailingCommas":·"all",
-      16 │ + → → → "semicolons":·"asNeeded",
-      17 │ + → → → "arrowParentheses":·"always",
-      18 │ + → → → "bracketSpacing":·true,
+       9 │ + → → "attributePosition":·"auto",
+      10 │ + → → "bracketSpacing":·true
+      11 │ + → },
+      12 │ + → "javascript":·{
+      13 │ + → → "formatter":·{
+      14 │ + → → → "jsxQuoteStyle":·"double",
+      15 │ + → → → "quoteProperties":·"asNeeded",
+      16 │ + → → → "trailingCommas":·"all",
+      17 │ + → → → "semicolons":·"asNeeded",
+      18 │ + → → → "arrowParentheses":·"always",
       19 │ + → → → "bracketSameLine":·false,
       20 │ + → → → "quoteStyle":·"single",
-      21 │ + → → → "attributePosition":·"auto"
-      22 │ + → → }
-      23 │ + → }
-      24 │ + }
-      25 │ + 
+      21 │ + → → → "attributePosition":·"auto",
+      22 │ + → → → "bracketSpacing":·true
+      23 │ + → → }
+      24 │ + → }
+      25 │ + }
+      26 │ + 
   
 
 ```

diff --git a/crates/biome_cli/tests/snapshots/main_commands_migrate_prettier/prettier_migrate_fix.snap b/crates/biome_cli/tests/snapshots/main_commands_migrate_prettier/prettier_migrate_fix.snap
@@ -13,7 +13,8 @@ expression: content
     "indentWidth": 2,
     "lineEnding": "lf",
     "lineWidth": 80,
-    "attributePosition": "auto"
+    "attributePosition": "auto",
+    "bracketSpacing": true
   },
   "linter": { "enabled": true },
   "javascript": {
@@ -23,10 +24,10 @@ expression: content
       "trailingCommas": "all",
       "semicolons": "always",
       "arrowParentheses": "always",
-      "bracketSpacing": true,
       "bracketSameLine": false,
       "quoteStyle": "single",
-      "attributePosition": "auto"
+      "attributePosition": "auto",
+      "bracketSpacing": true
     }
   }
 }

diff --git a/crates/biome_cli/tests/snapshots/main_commands_migrate_prettier/prettier_migrate_jsonc.snap b/crates/biome_cli/tests/snapshots/main_commands_migrate_prettier/prettier_migrate_jsonc.snap
@@ -30,24 +30,25 @@ biome.jsonc migrate ━━━━━━━━━━━━━━━━━━━━
        6 │ + → → "indentWidth":·2,
        7 │ + → → "lineEnding":·"lf",
        8 │ + → → "lineWidth":·80,
-       9 │ + → → "attributePosition":·"auto"
-      10 │ + → },
-      11 │ + → "linter":·{·"enabled":·true·},
-      12 │ + → "javascript":·{
-      13 │ + → → "formatter":·{
-      14 │ + → → → "jsxQuoteStyle":·"double",
-      15 │ + → → → "quoteProperties":·"asNeeded",
-      16 │ + → → → "trailingCommas":·"all",
-      17 │ + → → → "semicolons":·"always",
-      18 │ + → → → "arrowParentheses":·"always",
-      19 │ + → → → "bracketSpacing":·true,
+       9 │ + → → "attributePosition":·"auto",
+      10 │ + → → "bracketSpacing":·true
+      11 │ + → },
+      12 │ + → "linter":·{·"enabled":·true·},
+      13 │ + → "javascript":·{
+      14 │ + → → "formatter":·{
+      15 │ + → → → "jsxQuoteStyle":·"double",
+      16 │ + → → → "quoteProperties":·"asNeeded",
+      17 │ + → → → "trailingCommas":·"all",
+      18 │ + → → → "semicolons":·"always",
+      19 │ + → → → "arrowParentheses":·"always",
       20 │ + → → → "bracketSameLine":·false,
       21 │ + → → → "quoteStyle":·"single",
-      22 │ + → → → "attributePosition":·"auto"
-      23 │ + → → }
-      24 │ + → }
-      25 │ + }
-      26 │ + 
+      22 │ + → → → "attributePosition":·"auto",
+      23 │ + → → → "bracketSpacing":·true
+      24 │ + → → }
+      25 │ + → }
+      26 │ + }
+      27 │ + 
   
 
 ```