Introduce StringFormatted Refaster rule (#1961)

Author: timtebeek

documentation-support/src/main/java/tech/picnic/errorprone/documentation/DocumentationGenerator.java

@@ -50,7 +50,7 @@ static Path getOutputPath(String pathArg) {
     try {
       return Path.of(path);
     } catch (InvalidPathException e) {
-      throw new IllegalArgumentException(String.format("Invalid path '%s'", path), e);
+      throw new IllegalArgumentException("Invalid path '%s'".formatted(path), e);
     }
   }
 }

documentation-support/src/main/java/tech/picnic/errorprone/documentation/DocumentationGeneratorTaskListener.java

@@ -81,12 +81,12 @@ private void createDocsDirectory() {
       Files.createDirectories(docsPath);
     } catch (IOException e) {
       throw new IllegalStateException(
-          String.format("Error while creating directory with path '%s'", docsPath), e);
+          "Error while creating directory with path '%s'".formatted(docsPath), e);
     }
   }
 
   private <T> void writeToFile(String identifier, String className, T data) {
-    Json.write(docsPath.resolve(String.format("%s-%s.json", identifier, className)), data);
+    Json.write(docsPath.resolve("%s-%s.json".formatted(identifier, className)), data);
   }
 
   private static String getSimpleClassName(URI path) {

documentation-support/src/main/java/tech/picnic/errorprone/documentation/Json.java

@@ -40,6 +40,6 @@ static <T> void write(Path path, T object) {
 
   @FormatMethod
   private static UncheckedIOException failure(IOException cause, String format, Object... args) {
-    return new UncheckedIOException(String.format(format, args), cause);
+    return new UncheckedIOException(format.formatted(args), cause);
   }
 }

documentation-support/src/main/java/tech/picnic/errorprone/documentation/RefasterRuleCollectionTestExtractor.java

@@ -136,7 +136,7 @@ private static Optional<String> tryExtractPatternGroup(String input, Pattern pat
 
   @FormatMethod
   private static Supplier<VerifyException> violation(String format, Object... args) {
-    return () -> new VerifyException(String.format(format, args));
+    return () -> new VerifyException(format.formatted(args));
   }
 
   record RefasterTestCases(

documentation-support/src/test/java/tech/picnic/errorprone/documentation/BugPatternExtractorTest.java

@@ -135,7 +135,7 @@ void undocumentedSuppressionBugPattern(@TempDir Path outputDirectory) {
 
   private static void verifyGeneratedFileContent(
       Path outputDirectory, String testClass, BugPatternDocumentation expected) {
-    assertThat(outputDirectory.resolve(String.format("bugpattern-%s.json", testClass)))
+    assertThat(outputDirectory.resolve("bugpattern-%s.json".formatted(testClass)))
         .exists()
         .returns(expected, path -> Json.read(path, BugPatternDocumentation.class));
   }

documentation-support/src/test/java/tech/picnic/errorprone/documentation/BugPatternTestExtractorTest.java

@@ -551,7 +551,7 @@ void compilationAndBugCheckerRefactoringTestHelpersWithCustomCheckerPackageAndNa
 
   private static void verifyGeneratedFileContent(
       Path outputDirectory, String testClass, BugPatternTestCases expected) {
-    assertThat(outputDirectory.resolve(String.format("bugpattern-test-%s.json", testClass)))
+    assertThat(outputDirectory.resolve("bugpattern-test-%s.json".formatted(testClass)))
         .exists()
         .returns(expected, path -> Json.read(path, BugPatternTestCases.class));
   }

documentation-support/src/test/java/tech/picnic/errorprone/documentation/RefasterRuleCollectionTestExtractorTest.java

@@ -159,7 +159,7 @@ private static void verifyGeneratedFileContent(
       Path outputDirectory, String testIdentifier, RefasterTestCases expected) {
     assertThat(
             outputDirectory.resolve(
-                String.format("refaster-rule-collection-test-%s.json", testIdentifier)))
+                "refaster-rule-collection-test-%s.json".formatted(testIdentifier)))
         .exists()
         .returns(expected, path -> Json.read(path, RefasterTestCases.class));
   }

error-prone-contrib/src/main/java/tech/picnic/errorprone/bugpatterns/CollectorMutability.java

@@ -101,7 +101,7 @@ private Description suggestToCollectionAlternatives(
         .addFix(replaceMethodInvocation(tree, immutableReplacement, state))
         .addFix(
             mutableFix
-                .replace(tree, String.format("%s(%s::new)", toCollectionSelect, mutableCollection))
+                .replace(tree, "%s(%s::new)".formatted(toCollectionSelect, mutableCollection))
                 .build())
         .build();
   }
@@ -125,7 +125,7 @@ private Description suggestToMapAlternatives(MethodInvocationTree tree, VisitorS
                 .postfixWith(
                     tree.getArguments().get(argCount - 1),
                     (argCount == 2 ? ", (a, b) -> { throw new IllegalStateException(); }" : "")
-                        + String.format(", %s::new", hashMap))
+                        + ", %s::new".formatted(hashMap))
                 .build())
         .build();
   }

error-prone-contrib/src/main/java/tech/picnic/errorprone/bugpatterns/DirectReturn.java

@@ -98,7 +98,7 @@ public Description matchBlock(BlockTree tree, VisitorState state) {
                     SuggestedFix.builder()
                         .replace(
                             precedingStatement,
-                            String.format("return %s;", SourceCode.treeToString(resultExpr, state)))
+                            "return %s;".formatted(SourceCode.treeToString(resultExpr, state)))
                         .delete(finalStatement)
                         .build()))
         .orElse(Description.NO_MATCH);

error-prone-contrib/src/main/java/tech/picnic/errorprone/bugpatterns/EagerStringFormatting.java

@@ -230,10 +230,9 @@ private SuggestedFix suggestFlattening(String newPlaceholder, VisitorState state
 
     private String deriveFormatStringExpression(String newPlaceholder, VisitorState state) {
       String derivative =
-          String.format(
-              simplifiableFormatString()
-                  .orElseThrow(() -> new VerifyException("Format string cannot be simplified")),
-              Collections.nCopies(arguments().size(), newPlaceholder).toArray());
+          simplifiableFormatString()
+              .orElseThrow(() -> new VerifyException("Format string cannot be simplified"))
+              .formatted(Collections.nCopies(arguments().size(), newPlaceholder).toArray());
 
       /*
        * If the suggested replacement format string is the same as the original, then use the