Router: allow breaks in any double-quote strings

Previously, we would only allow that in triple-quote strings. However, for classic/keep try to avoid break if one wasn't present.
scalameta · Sep 12, 2024 · 8bcdf70 · 8bcdf70
1 parent 6d840ad
commit 8bcdf70
Show file tree

Hide file tree

Showing 7 changed files with 58 additions and 22 deletions.
diff --git a/scalafmt-core/shared/src/main/scala/org/scalafmt/internal/Router.scala b/scalafmt-core/shared/src/main/scala/org/scalafmt/internal/Router.scala
@@ -77,10 +77,18 @@ class Router(formatOps: FormatOps) {
       case FormatToken(_: T.Shebang, _, _) => Seq(Split(Newline2x(ft), 0))
       case FormatToken(start: T.Interpolation.Start, _, m) =>
         val end = matching(start)
-        val okNewlines = style.newlines.inInterpolation
-          .ne(Newlines.InInterpolation.avoid) && isTripleQuote(m.left.text)
-        def policy = PenalizeAllNewlines(end, BreakSingleLineInterpolatedString)
-        val split = Split(NoSplit, 0).withPolicy(policy, okNewlines)
+        val policy = {
+          val penalty = BreakSingleLineInterpolatedString
+          if (style.newlines.inInterpolation eq Newlines.InInterpolation.avoid)
+            PenalizeAllNewlines(end, penalty)
+          else Policy ?
+            (style.newlines.sourceIgnored || isTripleQuote(m.left.text)) ||
+            Policy.on(end, "INTERP-KEEP-NONL") {
+              case Decision(x, ss) if x.noBreak =>
+                ss.map(s => if (s.isNL) s.withPenalty(penalty) else s)
+            }
+        }
+        val split = Split(NoSplit, 0, policy = policy)
         val alignIndents =
           if (style.align.stripMargin) findInterpolate(leftOwner)
             .flatMap { ti =>

diff --git a/scalafmt-tests/src/test/resources/newlines/source.source b/scalafmt-tests/src/test/resources/newlines/source.source
@@ -14,7 +14,10 @@ package a.b.c
 import a.b.c
 object a {
   val a =
-    s"${a.b.c.d}"
+    s"${a
+        .b
+        .c
+        .d}"
   val b =
     foo[
       a.b.c.d.e

diff --git a/scalafmt-tests/src/test/resources/newlines/source_classic.stat b/scalafmt-tests/src/test/resources/newlines/source_classic.stat
@@ -9092,7 +9092,10 @@ object a {
   logWarning(
     log"Session plan cache is disabled due to non-positive cache size." +
       log" Current value of " +
-      log"'${MDC(LogKeys.CONFIG, Connect.CONNECT_SESSION_PLAN_CACHE_SIZE.key)}' is ${MDC(LogKeys.CACHE_SIZE, SparkEnv.get.conf.get(Connect.CONNECT_SESSION_PLAN_CACHE_SIZE))}"
+      log"'${MDC(LogKeys.CONFIG, Connect.CONNECT_SESSION_PLAN_CACHE_SIZE.key)}' is ${MDC(
+          LogKeys.CACHE_SIZE,
+          SparkEnv.get.conf.get(Connect.CONNECT_SESSION_PLAN_CACHE_SIZE)
+        )}"
   )
 }
 <<< #4187 !dangling
@@ -9110,9 +9113,12 @@ object a {
 }
 >>>
 object a {
-  logWarning(log"Session plan cache is disabled due to non-positive cache size." +
-    log" Current value of " +
-    log"'${MDC(LogKeys.CONFIG, Connect.CONNECT_SESSION_PLAN_CACHE_SIZE.key)}' is ${MDC(LogKeys.CACHE_SIZE, SparkEnv.get.conf.get(Connect.CONNECT_SESSION_PLAN_CACHE_SIZE))}")
+  logWarning(
+    log"Session plan cache is disabled due to non-positive cache size." +
+      log" Current value of " +
+      log"'${MDC(LogKeys.CONFIG, Connect.CONNECT_SESSION_PLAN_CACHE_SIZE.key)}' is ${MDC(
+          LogKeys.CACHE_SIZE,
+          SparkEnv.get.conf.get(Connect.CONNECT_SESSION_PLAN_CACHE_SIZE))}")
 }
 <<< #4133 overflow select within interpolate
 object a {

diff --git a/scalafmt-tests/src/test/resources/newlines/source_fold.stat b/scalafmt-tests/src/test/resources/newlines/source_fold.stat
@@ -8466,8 +8466,13 @@ object a {
 object a {
   logWarning(
     log"Session plan cache is disabled due to non-positive cache size." +
-      log" Current value of " +
-      log"'${MDC(LogKeys.CONFIG, Connect.CONNECT_SESSION_PLAN_CACHE_SIZE.key)}' is ${MDC(LogKeys.CACHE_SIZE, SparkEnv.get.conf.get(Connect.CONNECT_SESSION_PLAN_CACHE_SIZE))}"
+      log" Current value of " + log"'${MDC(
+          LogKeys.CONFIG,
+          Connect.CONNECT_SESSION_PLAN_CACHE_SIZE.key
+        )}' is ${MDC(
+          LogKeys.CACHE_SIZE,
+          SparkEnv.get.conf.get(Connect.CONNECT_SESSION_PLAN_CACHE_SIZE)
+        )}"
   )
 }
 <<< #4187 !dangling
@@ -8485,9 +8490,13 @@ object a {
 }
 >>>
 object a {
-  logWarning(log"Session plan cache is disabled due to non-positive cache size." +
-    log" Current value of " +
-    log"'${MDC(LogKeys.CONFIG, Connect.CONNECT_SESSION_PLAN_CACHE_SIZE.key)}' is ${MDC(LogKeys.CACHE_SIZE, SparkEnv.get.conf.get(Connect.CONNECT_SESSION_PLAN_CACHE_SIZE))}")
+  logWarning(
+    log"Session plan cache is disabled due to non-positive cache size." +
+      log" Current value of " + log"'${MDC(
+          LogKeys.CONFIG,
+          Connect.CONNECT_SESSION_PLAN_CACHE_SIZE.key)}' is ${MDC(
+          LogKeys.CACHE_SIZE,
+          SparkEnv.get.conf.get(Connect.CONNECT_SESSION_PLAN_CACHE_SIZE))}")
 }
 <<< #4133 overflow select within interpolate
 object a {
@@ -8503,7 +8512,8 @@ object a {
       canConstrain: Boolean = false,
       isSoft: Boolean = true
   ): Type = /*>|>*/ trace(
-    s"lub(${tp1.show}, ${tp2.show}, canConstrain=$canConstrain, isSoft=$isSoft)",
+    s"lub(${tp1.show}, ${tp2
+        .show}, canConstrain=$canConstrain, isSoft=$isSoft)",
     subtyping,
     show = true
   ) /*<|<*/ {

diff --git a/scalafmt-tests/src/test/resources/newlines/source_unfold.stat b/scalafmt-tests/src/test/resources/newlines/source_unfold.stat
@@ -9179,7 +9179,10 @@ object a {
   logWarning(
     log"Session plan cache is disabled due to non-positive cache size." +
       log" Current value of " +
-      log"'${MDC(LogKeys.CONFIG, Connect.CONNECT_SESSION_PLAN_CACHE_SIZE.key)}' is ${MDC(LogKeys.CACHE_SIZE, SparkEnv.get.conf.get(Connect.CONNECT_SESSION_PLAN_CACHE_SIZE))}"
+      log"'${MDC(LogKeys.CONFIG, Connect.CONNECT_SESSION_PLAN_CACHE_SIZE.key)}' is ${MDC(
+          LogKeys.CACHE_SIZE,
+          SparkEnv.get.conf.get(Connect.CONNECT_SESSION_PLAN_CACHE_SIZE)
+        )}"
   )
 }
 <<< #4187 !dangling
@@ -9197,9 +9200,12 @@ object a {
 }
 >>>
 object a {
-  logWarning(log"Session plan cache is disabled due to non-positive cache size." +
-    log" Current value of " +
-    log"'${MDC(LogKeys.CONFIG, Connect.CONNECT_SESSION_PLAN_CACHE_SIZE.key)}' is ${MDC(LogKeys.CACHE_SIZE, SparkEnv.get.conf.get(Connect.CONNECT_SESSION_PLAN_CACHE_SIZE))}")
+  logWarning(
+    log"Session plan cache is disabled due to non-positive cache size." +
+      log" Current value of " +
+      log"'${MDC(LogKeys.CONFIG, Connect.CONNECT_SESSION_PLAN_CACHE_SIZE.key)}' is ${MDC(
+          LogKeys.CACHE_SIZE,
+          SparkEnv.get.conf.get(Connect.CONNECT_SESSION_PLAN_CACHE_SIZE))}")
 }
 <<< #4133 overflow select within interpolate
 object a {
@@ -9216,7 +9222,8 @@ object a {
       isSoft: Boolean = true
   ): Type = /*>|>*/
     trace(
-      s"lub(${tp1.show}, ${tp2.show}, canConstrain=$canConstrain, isSoft=$isSoft)",
+      s"lub(${tp1.show}, ${tp2
+          .show}, canConstrain=$canConstrain, isSoft=$isSoft)",
       subtyping,
       show = true
     ) /*<|<*/ {

diff --git a/scalafmt-tests/src/test/resources/scala3/OptionalBraces_fold.stat b/scalafmt-tests/src/test/resources/scala3/OptionalBraces_fold.stat
@@ -6984,7 +6984,8 @@ object a:
        canConstrain: Boolean = false,
        isSoft: Boolean = true
    ): Type = /*>|>*/ trace(
-     s"lub(${tp1.show}, ${tp2.show}, canConstrain=$canConstrain, isSoft=$isSoft)",
+     s"lub(${tp1.show}, ${tp2
+         .show}, canConstrain=$canConstrain, isSoft=$isSoft)",
      subtyping,
      show = true
    ) /*<|<*/ {

diff --git a/scalafmt-tests/src/test/resources/scala3/OptionalBraces_unfold.stat b/scalafmt-tests/src/test/resources/scala3/OptionalBraces_unfold.stat
@@ -7522,7 +7522,8 @@ object a:
        isSoft: Boolean = true
    ): Type = /*>|>*/
      trace(
-       s"lub(${tp1.show}, ${tp2.show}, canConstrain=$canConstrain, isSoft=$isSoft)",
+       s"lub(${tp1.show}, ${tp2
+           .show}, canConstrain=$canConstrain, isSoft=$isSoft)",
        subtyping,
        show = true
      ) /*<|<*/ {