Do not match String.format(Locale, String, Object...) and maintain original argument prefixes

Author: Tim te Beek

src/main/java/org/openrewrite/java/migrate/lang/StringFormatted.java

@@ -27,12 +27,11 @@
 import org.openrewrite.java.tree.J;
 
 import java.time.Duration;
-import java.util.Collections;
 import java.util.List;
 
 public class StringFormatted extends Recipe {
 
-    private static final MethodMatcher STRING_FORMAT = new MethodMatcher("java.lang.String format(..)");
+    private static final MethodMatcher STRING_FORMAT = new MethodMatcher("java.lang.String format(String, ..)");
 
     @Override
     public String getDisplayName() {
@@ -66,7 +65,7 @@ public J visitMethodInvocation(J.MethodInvocation method, ExecutionContext p) {
             String template = String.format(wrapperNotNeeded(arguments.get(0))
                     ? "#{any(java.lang.String)}.formatted(%s)"
                     : "(#{any(java.lang.String)}).formatted(%s)",
-                    String.join(", ", Collections.nCopies(arguments.size() - 1, "#{any()}")));
+                    varargsTemplateWithOriginalWhitespace(arguments));
             maybeRemoveImport("java.lang.String.format");
             return mi.withTemplate(
                     JavaTemplate.builder(this::getCursor, template)
@@ -81,6 +80,14 @@ private static boolean wrapperNotNeeded(Expression expression) {
                     || expression instanceof J.Literal
                     || expression instanceof J.MethodInvocation;
         }
+
+        private static String varargsTemplateWithOriginalWhitespace(List<Expression> arguments) {
+            StringBuilder stringBuilder = new StringBuilder();
+            for (Expression expression : arguments.subList(1, arguments.size())) {
+                stringBuilder.append(expression.getPrefix().format("#{any()},"));
+            }
+            return stringBuilder.toString();
+        }
     }
 
     @Override

src/test/kotlin/org/openrewrite/java/migrate/lang/StringFormattedTest.kt

@@ -193,4 +193,55 @@ class StringFormattedTest : RewriteTest {
         """)
     )
 
+    @Test
+    @Issue("https://github.com/openrewrite/rewrite-migrate-java/issues/122")
+    fun doNotMatchLocale() = rewriteRun(
+        java("""
+            import java.util.Locale;
+            class A {
+                String str = String.format(Locale.US, "foo %s", "a");
+            }
+        """)
+    )
+
+    @Test
+    @Issue("https://github.com/openrewrite/rewrite-migrate-java/issues/122")
+    fun doNotChangeLackOfWhitespace() = rewriteRun(
+        java("""
+            class A {
+                String str = String.format("foo %s","a","b");
+            }
+        """,
+        """
+            class A {
+                String str = "foo %s".formatted("a","b");
+            }
+        """)
+    )
+
+    @Test
+    @Issue("https://github.com/openrewrite/rewrite-migrate-java/issues/122")
+    fun doNotChangeWhitespaceWithNewlines() = rewriteRun(
+        java("""
+            class A {
+                String str = String.format("foo %s",
+                    "a",
+                    "b");
+            }
+        """)
+    )
+
+    @Test
+    @Issue("https://github.com/openrewrite/rewrite-migrate-java/issues/122")
+    fun doNotChangeWhitespaceWithNewlinesAndComments() = rewriteRun(
+        java("""
+            class A {
+                String str = String.format("foo %s",
+                    "a",
+                    // B
+                    "b");
+            }
+        """)
+    )
+
 }