Scalafmt: fix usages to pass the filename properly

Create a new, package-private method .formatCode with the implementation based on the existing .format. Make sure not to modify the existing interfaces of .format overloads, as they are externally expected (via reflection). Fixes scalameta#1628.
kitbellew · Jan 28, 2020 · e67c95a · e67c95a
1 parent acd6f44
commit e67c95a
Show file tree

Hide file tree

Showing 10 changed files with 49 additions and 25 deletions.
diff --git a/scalafmt-benchmarks/src/main/scala-2.12/benchmarks/MacroBenchmark.scala b/scalafmt-benchmarks/src/main/scala-2.12/benchmarks/MacroBenchmark.scala
@@ -57,7 +57,7 @@ abstract class MacroBenchmark(parallel: Boolean, maxFiles: Int)
   @Benchmark
   def scalafmt(): Unit = {
     files.foreach { file =>
-      Try(Scalafmt.format(file))
+      Try(Scalafmt.formatCode(file))
     }
   }
 

diff --git a/scalafmt-benchmarks/src/main/scala/org/scalafmt/benchmarks/FormatBenchmark.scala b/scalafmt-benchmarks/src/main/scala/org/scalafmt/benchmarks/FormatBenchmark.scala
@@ -7,7 +7,7 @@ import org.scalafmt.rewrite.{RedundantBraces, SortImports}
 trait FormatBenchmark {
   def formatRewrite(code: String): String = {
     Scalafmt
-      .format(
+      .formatCode(
         code,
         style = ScalafmtConfig.default.copy(
           rewrite = RewriteSettings(

diff --git a/scalafmt-benchmarks/src/main/scala/org/scalafmt/benchmarks/MicroBenchmark.scala b/scalafmt-benchmarks/src/main/scala/org/scalafmt/benchmarks/MicroBenchmark.scala
@@ -46,7 +46,7 @@ abstract class MicroBenchmark(path: String*) extends FormatBenchmark {
 
   @Benchmark
   def scalafmt(): String = {
-    Scalafmt.format(code).get
+    Scalafmt.formatCode(code).get
   }
 
   @Benchmark

diff --git a/scalafmt-cli/src/main/scala/org/scalafmt/cli/Scalafmt210.scala b/scalafmt-cli/src/main/scala/org/scalafmt/cli/Scalafmt210.scala
@@ -51,7 +51,7 @@ class Scalafmt210 {
       if (filename.endsWith(".sbt")) SRunner.sbt
       else SRunner.default
     val style = scalafmtStyle.copy(runner = runner)
-    Scalafmt.format(code, style) match {
+    Scalafmt.formatCode(code, style, filename = filename) match {
       case Formatted.Success(formattedCode) => formattedCode
       case error =>
         error match {

diff --git a/scalafmt-cli/src/main/scala/org/scalafmt/cli/ScalafmtCoreRunner.scala b/scalafmt-cli/src/main/scala/org/scalafmt/cli/ScalafmtCoreRunner.scala
@@ -80,7 +80,7 @@ object ScalafmtCoreRunner extends ScalafmtRunner {
     val scalafmtConfig =
       if (inputMethod.isSbt || inputMethod.isSc) config.forSbt
       else config
-    val formatResult = Scalafmt.format(
+    val formatResult = Scalafmt.formatCode(
       input,
       scalafmtConfig,
       options.range,

diff --git a/scalafmt-core/shared/src/main/scala/org/scalafmt/Scalafmt.scala b/scalafmt-core/shared/src/main/scala/org/scalafmt/Scalafmt.scala
@@ -24,6 +24,7 @@ object Scalafmt {
   private val WindowsLineEnding = "\r\n"
   private val UnixLineEnding = "\n"
 
+  // XXX: don't modify signature, scalafmt-dynamic expects it via reflection
   /**
     * Format Scala code using scalafmt.
     *
@@ -43,6 +44,15 @@ object Scalafmt {
       style: ScalafmtConfig,
       range: Set[Range],
       filename: String
+  ): Formatted = {
+    formatCode(code, style, range, filename)
+  }
+
+  private[scalafmt] def formatCode(
+      code: String,
+      style: ScalafmtConfig = ScalafmtConfig.default,
+      range: Set[Range] = Set.empty,
+      filename: String = "<input>"
   ): Formatted = {
     try {
       val runner = style.runner
@@ -82,12 +92,13 @@ object Scalafmt {
     }
   }
 
+  // XXX: don't modify signature, scalafmt-dynamic expects it via reflection
   def format(
       code: String,
       style: ScalafmtConfig = ScalafmtConfig.default,
       range: Set[Range] = Set.empty[Range]
   ): Formatted = {
-    format(code, style, range, "<input>")
+    formatCode(code, style, range)
   }
 
   def parseHoconConfig(configString: String): Configured[ScalafmtConfig] =

diff --git a/scalafmt-core/shared/src/test/scala/org/scalafmt/ScalafmtTest.scala b/scalafmt-core/shared/src/test/scala/org/scalafmt/ScalafmtTest.scala
@@ -10,7 +10,7 @@ class ScalafmtTest extends scalatest.funsuite.AnyFunSuite {
       config: ScalafmtConfig = ScalafmtConfig.default
   ): Unit = {
     test(logger.revealWhitespace(original).take(30)) {
-      val obtained = Scalafmt.format(original, config).get
+      val obtained = Scalafmt.formatCode(original, config).get
       if (obtained != expected) logger.elem(obtained)
       assert(obtained == expected)
     }

diff --git a/scalafmt-tests/src/test/scala/org/scalafmt/FidelityTest.scala b/scalafmt-tests/src/test/scala/org/scalafmt/FidelityTest.scala
@@ -43,7 +43,7 @@ class FidelityTest extends AnyFunSuite with FormatAssertions {
   examples.foreach { example =>
     test(example.filename) {
       val formatted =
-        Scalafmt.format(example.code, ScalafmtConfig.default).get
+        Scalafmt.formatCode(example.code, filename = example.filename).get
       assertFormatPreservesAst(example.code, formatted)(
         scala.meta.parsers.Parse.parseSource,
         Scala211

diff --git a/scalafmt-tests/src/test/scala/org/scalafmt/FormatTests.scala b/scalafmt-tests/src/test/scala/org/scalafmt/FormatTests.scala
@@ -52,19 +52,22 @@ class FormatTests
 
   def run(t: DiffTest, parse: Parse[_ <: Tree]): Unit = {
     val runner = scalafmtRunner(t.style.runner).copy(parser = parse)
-    val obtained =
-      Scalafmt.format(t.original, t.style.copy(runner = runner)) match {
-        case Formatted.Failure(e)
-            if t.style.onTestFailure.nonEmpty && e.getMessage.contains(
-              e.getMessage
-            ) =>
-          t.expected
-        case Formatted.Failure(e: Incomplete) => e.formattedCode
-        case Formatted.Failure(e: SearchStateExploded) =>
-          logger.elem(e)
-          e.partialOutput
-        case x => x.get
-      }
+    val obtained = Scalafmt.formatCode(
+      t.original,
+      t.style.copy(runner = runner),
+      filename = t.filename
+    ) match {
+      case Formatted.Failure(e)
+          if t.style.onTestFailure.nonEmpty && e.getMessage.contains(
+            e.getMessage
+          ) =>
+        t.expected
+      case Formatted.Failure(e: Incomplete) => e.formattedCode
+      case Formatted.Failure(e: SearchStateExploded) =>
+        logger.elem(e)
+        e.partialOutput
+      case x => x.get
+    }
     debugResults += saveResult(t, obtained, onlyOne)
     if (t.style.rewrite.rules.isEmpty &&
       !t.style.assumeStandardLibraryStripMargin &&
@@ -74,8 +77,13 @@ class FormatTests
         t.style.runner.dialect
       )
     }
-    val formattedAgain =
-      Scalafmt.format(obtained, t.style.copy(runner = runner)).get
+    val formattedAgain = Scalafmt
+      .format(
+        obtained,
+        t.style.copy(runner = runner),
+        filename = t.filename
+      )
+      .get
 //          getFormatOutput(t.style, true) // uncomment to debug
     assertNoDiff(formattedAgain, obtained, "Idempotency violated")
     if (!onlyManual) {

diff --git a/scalafmt-tests/src/test/scala/org/scalafmt/util/HasTests.scala b/scalafmt-tests/src/test/scala/org/scalafmt/util/HasTests.scala
@@ -192,8 +192,13 @@ trait HasTests extends AnyFunSuiteLike with FormatAssertions {
 
   def defaultRun(t: DiffTest, parse: Parse[_ <: Tree]): Unit = {
     val runner = scalafmtRunner(t.style.runner).copy(parser = parse)
-    val obtained =
-      Scalafmt.format(t.original, t.style.copy(runner = runner)).get
+    val obtained = Scalafmt
+      .formatCode(
+        t.original,
+        t.style.copy(runner = runner),
+        filename = t.filename
+      )
+      .get
     if (t.style.rewrite.rules.isEmpty) {
       assertFormatPreservesAst(t.original, obtained)(
         parse,