refactor(formatter): remove spacing options for operators (#315)

Following the simplification work in #310, this PR continues to strengthen Mago's role as an opinionated formatter by removing nearly all options related to spacing around operators.

The configuration surface has been significantly reduced by removing granular settings for spacing around assignment, logical, equality, comparison, and other binary operators.

The formatter now enforces a single, consistent style: **all binary and assignment operators will have spaces around them.** This removes ambiguity and ensures a uniform codebase style.

This change further simplifies the formatter's internal logic, reduces maintenance overhead, and makes the tool easier to configure and use.

Signed-off-by: azjezz <[email protected]>

Author: azjezz

crates/formatter/src/internal/format/assignment.rs

@@ -69,63 +69,57 @@ pub(super) fn print_assignment<'arena>(
     operator: Document<'arena>,
     rhs_expression: &'arena Expression<'arena>,
 ) -> Document<'arena> {
-    let needs_spacing = if matches!(assignment_node, AssignmentLikeNode::AssignmentOperation(_)) {
-        f.settings.space_around_assignment_operators
-    } else {
-        true
-    };
-
     let layout = choose_layout(f, &lhs, &assignment_node, rhs_expression);
     let rhs = rhs_expression.format(f);
 
     match layout {
         Layout::Chain => Document::Array(vec![
             in f.arena;
             Document::Group(Group::new(vec![in f.arena; lhs])),
-            if needs_spacing { Document::space() } else { Document::empty() },
+            Document::space(),
             operator,
-            if needs_spacing { Document::Line(Line::default()) } else { Document::Line(Line::soft()) },
+            Document::Line(Line::default()),
             rhs,
         ]),
         Layout::ChainTailArrowChain => Document::Array(vec![
             in f.arena;
             Document::Group(Group::new(vec![in f.arena; lhs])),
-            if needs_spacing { Document::space() } else { Document::empty() },
+            Document::space(),
             operator,
             rhs,
         ]),
         Layout::ChainTail => Document::Group(Group::new(vec![
             in f.arena;
             lhs,
-            if needs_spacing { Document::space() } else { Document::empty() },
+            Document::space(),
             operator,
             Document::Indent(vec![in f.arena; Document::Line(Line::hard()), rhs]),
         ])),
         Layout::BreakAfterOperator => Document::Group(Group::new(vec![
             in f.arena;
             Document::Group(Group::new(vec![in f.arena; lhs])),
-            if needs_spacing { Document::space() } else { Document::empty() },
+            Document::space(),
             operator,
             Document::Group(Group::new(vec![in f.arena; Document::IndentIfBreak(IndentIfBreak::new(vec![
                 in f.arena;
-                if needs_spacing { Document::Line(Line::default()) } else { Document::Line(Line::soft()) },
+                Document::Line(Line::default()),
                 rhs,
             ]))])),
         ])),
         Layout::NeverBreakAfterOperator => Document::Group(Group::new(vec![
             in f.arena;
             Document::Group(Group::new(vec![in f.arena; lhs])),
-            if needs_spacing { Document::space() } else { Document::empty() },
+            Document::space(),
             operator,
-            if needs_spacing { Document::space() } else { Document::empty() },
+            Document::space(),
             Document::Group(Group::new(vec![in f.arena; rhs])),
         ])),
         Layout::BreakLhs => Document::Group(Group::new(vec![
             in f.arena;
             lhs,
-            if needs_spacing { Document::space() } else { Document::empty() },
+            Document::space(),
             operator,
-            if needs_spacing { Document::space() } else { Document::empty() },
+            Document::space(),
             Document::Group(Group::new(vec![in f.arena; rhs])),
         ])),
         Layout::Fluid => {
@@ -134,15 +128,13 @@ pub(super) fn print_assignment<'arena>(
             Document::Group(Group::new(vec![
                 in f.arena;
                 lhs,
-                if needs_spacing { Document::space() } else { Document::empty() },
+                Document::space(),
                 operator,
                 Document::Group(
-                    Group::new(vec![in f.arena; Document::Indent(vec![in f.arena; if needs_spacing {
-                        Document::Line(Line::default())
-                    } else {
-                        Document::Line(Line::soft())
-                    }])])
-                    .with_id(assignment_id),
+                    Group::new(vec![
+                        in f.arena;
+                        Document::Indent(vec![in f.arena; Document::Line(Line::default())])
+                    ]).with_id(assignment_id),
                 ),
                 Document::IndentIfBreak(IndentIfBreak::new(vec![in f.arena; rhs]).with_id(assignment_id)),
             ]))

crates/formatter/src/internal/format/binaryish.rs

@@ -140,36 +140,8 @@ pub(super) fn print_binaryish_expressions<'arena>(
     let should_inline = should_inline_binary_rhs_expression(right, operator);
 
     let has_space_around = match operator {
-        BinaryOperator::And(_)
-        | BinaryOperator::Or(_)
-        | BinaryOperator::LowAnd(_)
-        | BinaryOperator::LowOr(_)
-        | BinaryOperator::LowXor(_) => f.settings.space_around_logical_binary_operators,
-        BinaryOperator::Equal(_)
-        | BinaryOperator::NotEqual(_)
-        | BinaryOperator::Identical(_)
-        | BinaryOperator::NotIdentical(_)
-        | BinaryOperator::AngledNotEqual(_)
-        | BinaryOperator::Spaceship(_) => f.settings.space_around_equality_binary_operators,
-        BinaryOperator::LessThan(_)
-        | BinaryOperator::LessThanOrEqual(_)
-        | BinaryOperator::GreaterThan(_)
-        | BinaryOperator::GreaterThanOrEqual(_) => f.settings.space_around_comparison_binary_operators,
-        BinaryOperator::BitwiseAnd(_) | BinaryOperator::BitwiseOr(_) | BinaryOperator::BitwiseXor(_) => {
-            f.settings.space_around_bitwise_binary_operators
-        }
-        BinaryOperator::Multiplication(_) | BinaryOperator::Division(_) | BinaryOperator::Modulo(_) => {
-            f.settings.space_around_multiplicative_binary_operators
-        }
-        BinaryOperator::Exponentiation(_) => f.settings.space_around_exponentiation_binary_operators,
-        BinaryOperator::Addition(_) | BinaryOperator::Subtraction(_) => {
-            f.settings.space_around_additive_binary_operators
-        }
-        BinaryOperator::LeftShift(_) | BinaryOperator::RightShift(_) => f.settings.space_around_shift_binary_operators,
         BinaryOperator::StringConcat(_) => f.settings.space_around_concatenation_binary_operator,
-        BinaryOperator::Elvis(_) => f.settings.space_around_elvis_binary_operator,
-        BinaryOperator::NullCoalesce(_) => f.settings.space_around_null_coalescing_binary_operator,
-        BinaryOperator::Instanceof(_) => true,
+        _ => true,
     };
 
     let line_before_operator = f.settings.line_before_binary_operator && !f.has_leading_own_line_comment(right.span());
@@ -178,12 +150,10 @@ pub(super) fn print_binaryish_expressions<'arena>(
         in f.arena;
         if line_before_operator && !should_inline {
             Document::Line(if has_space_around { Line::default() } else { Line::soft() })
-        } else {
-            Document::String(if has_space_around { " " } else { "" })
-        },
+        } else if has_space_around { Document::space() } else { Document::empty() },
         format_token(f, operator.span(), operator.as_str()),
         if line_before_operator || should_inline {
-            Document::String(if has_space_around { " " } else { "" })
+            if has_space_around { Document::space() } else { Document::empty() }
         } else {
             Document::Line(if has_space_around { Line::default() } else { Line::soft() })
         },

crates/formatter/src/settings.rs

@@ -699,87 +699,6 @@ pub struct FormatSettings {
     #[serde(default = "default_false")]
     pub space_after_additive_unary_prefix_operator: bool,
 
-    /// Whether to add spaces around assignment operators.
-    ///
-    /// When enabled: `$a = $b`
-    /// When disabled: `$a=$b`
-    ///
-    /// Default: true
-    #[serde(default = "default_true")]
-    pub space_around_assignment_operators: bool,
-
-    /// Whether to add spaces around logical operators (&&, ||, and, or, xor).
-    ///
-    /// When enabled: `$a && $b`
-    /// When disabled: `$a&&$b`
-    ///
-    /// Default: true
-    #[serde(default = "default_true")]
-    pub space_around_logical_binary_operators: bool,
-
-    /// Whether to add spaces around equality operators (==, ===, !=, !==).
-    ///
-    /// When enabled: `$a === $b`
-    /// When disabled: `$a===$b`
-    ///
-    /// Default: true
-    #[serde(default = "default_true")]
-    pub space_around_equality_binary_operators: bool,
-
-    /// Whether to add spaces around comparison operators (<, >, <=, >=, <=>).
-    ///
-    /// When enabled: `$a < $b`
-    /// When disabled: `$a<$b`
-    ///
-    /// Default: true
-    #[serde(default = "default_true")]
-    pub space_around_comparison_binary_operators: bool,
-
-    /// Whether to add spaces around bitwise operators (&, |, ^).
-    ///
-    /// When enabled: `$a | $b`
-    /// When disabled: `$a|$b`
-    ///
-    /// Default: true
-    #[serde(default = "default_true")]
-    pub space_around_bitwise_binary_operators: bool,
-
-    /// Whether to add spaces around additive operators (+ and -).
-    ///
-    /// When enabled: `$a + $b`
-    /// When disabled: `$a+$b`
-    ///
-    /// Default: true
-    #[serde(default = "default_true")]
-    pub space_around_additive_binary_operators: bool,
-
-    /// Whether to add spaces around multiplicative operators (*, /, %).
-    ///
-    /// When enabled: `$a * $b`
-    /// When disabled: `$a*$b`
-    ///
-    /// Default: true
-    #[serde(default = "default_true")]
-    pub space_around_multiplicative_binary_operators: bool,
-
-    /// Whether to add spaces around exponentiation operator (**).
-    ///
-    /// When enabled: `$a ** $b`
-    /// When disabled: `$a**$b`
-    ///
-    /// Default: true
-    #[serde(default = "default_true")]
-    pub space_around_exponentiation_binary_operators: bool,
-
-    /// Whether to add spaces around shift operators (<<, >>).
-    ///
-    /// When enabled: `$a << $b`
-    /// When disabled: `$a<<$b`
-    ///
-    /// Default: true
-    #[serde(default = "default_true")]
-    pub space_around_shift_binary_operators: bool,
-
     /// Whether to add spaces around the concatenation operator (.)
     ///
     /// When enabled: `$a . $b`
@@ -789,24 +708,6 @@ pub struct FormatSettings {
     #[serde(default = "default_true")]
     pub space_around_concatenation_binary_operator: bool,
 
-    /// Whether to add spaces around the null coalescing operator (??).
-    ///
-    /// When enabled: `$a ?? $b`
-    /// When disabled: `$a??$b`
-    ///
-    /// Default: true
-    #[serde(default = "default_true")]
-    pub space_around_null_coalescing_binary_operator: bool,
-
-    /// Whether to add spaces around the elvis operator (?:).
-    ///
-    /// When enabled: `$a ?: $b`
-    /// When disabled: `$a?:$b`
-    ///
-    /// Default: true
-    #[serde(default = "default_true")]
-    pub space_around_elvis_binary_operator: bool,
-
     /// Whether to add spaces around the assignment in declare statements.
     ///
     /// When enabled: `declare(strict_types = 1)`
@@ -992,18 +893,7 @@ impl Default for FormatSettings {
             space_around_assignment_in_declare: false,
             space_within_grouping_parenthesis: false,
             space_before_hook_parameter_list_parenthesis: false,
-            space_around_assignment_operators: true,
-            space_around_logical_binary_operators: true,
-            space_around_equality_binary_operators: true,
-            space_around_comparison_binary_operators: true,
-            space_around_bitwise_binary_operators: true,
-            space_around_additive_binary_operators: true,
-            space_around_multiplicative_binary_operators: true,
-            space_around_exponentiation_binary_operators: true,
-            space_around_shift_binary_operators: true,
             space_around_concatenation_binary_operator: true,
-            space_around_null_coalescing_binary_operator: true,
-            space_around_elvis_binary_operator: true,
             space_after_cast_unary_prefix_operators: true,
             space_after_reference_unary_prefix_operator: false,
             space_after_error_control_unary_prefix_operator: false,