Prefer hanging table field value over expanding (#553)

* Hang table field value instead of expanding it

* Changelog

* Snapshot

* Rethink strategy to hang table field value

Author: JohnnyMorganz

CHANGELOG.md

@@ -18,6 +18,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Fixed call chain with a small prefix not being kept inlined causing unstable formatting ([#514](https://github.com/JohnnyMorganz/StyLua/issues/514))
 - Fixed shape computation for table fields causing unnecessary expansion ([#551](https://github.com/JohnnyMorganz/StyLua/issues/551))
 - Fixed hanging the prefix string in `("str"):call` unnecessarily when it provides no benefit ([#508](https://github.com/JohnnyMorganz/StyLua/issues/508))
+- Fixed table field value being expanded when it could be hanged instead ([#541](https://github.com/JohnnyMorganz/StyLua/issues/541))
 
 ## [0.14.2] - 2022-07-27
 

src/formatters/table.rs

@@ -40,17 +40,30 @@ fn format_field_expression_value(
     expression: &Expression,
     shape: Shape,
 ) -> Expression {
-    let singleline_value = format_expression(ctx, expression, shape)
-        .update_trailing_trivia(FormatTriviaType::Replace(vec![])); // We will remove all the trivia from this value, and place it after the comma
-
-    if trivia_util::can_hang_expression(expression)
-        && shape.take_first_line(&singleline_value).over_budget()
-        || trivia_util::expression_contains_inline_comments(expression)
-    {
-        hang_expression(ctx, expression, shape, Some(1))
-            .update_trailing_trivia(FormatTriviaType::Replace(vec![]))
+    // Remove all trivia from the output expression as it will be moved after the comma
+
+    if trivia_util::can_hang_expression(expression) {
+        if trivia_util::expression_contains_inline_comments(expression) {
+            hang_expression(ctx, expression, shape, Some(1))
+                .update_trailing_trivia(FormatTriviaType::Replace(vec![]))
+        } else {
+            let singleline_value = format_expression(ctx, expression, shape)
+                .update_trailing_trivia(FormatTriviaType::Replace(vec![]));
+            let hanging_value = hang_expression(ctx, expression, shape, Some(1))
+                .update_trailing_trivia(FormatTriviaType::Replace(vec![]));
+
+            if shape.test_over_budget(&singleline_value)
+                || format!("{}", hanging_value).lines().count()
+                    < format!("{}", singleline_value).lines().count()
+            {
+                hanging_value
+            } else {
+                singleline_value
+            }
+        }
     } else {
-        singleline_value
+        format_expression(ctx, expression, shape)
+            .update_trailing_trivia(FormatTriviaType::Replace(vec![]))
     }
 }
 

tests/snapshots/tests__standard@table-field-hanging-1.lua.snap

@@ -5,8 +5,7 @@ expression: format(&contents)
 -- https://github.com/JohnnyMorganz/StyLua/issues/542
 -- https://github.com/JohnnyMorganz/StyLua/issues/541
 local thisIsATable = {
-	CreateAnElementFromThisTable = SomethingIsSelected and getTheSelectedThing(TheSelectedItem) or getTheSelectedThing(
-		NoItemSelected
-	),
+	CreateAnElementFromThisTable = SomethingIsSelected and getTheSelectedThing(TheSelectedItem)
+		or getTheSelectedThing(NoItemSelected),
 }