Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add scalafixCallback setting key to customize diagnostics reporting #384

Merged
merged 3 commits into from
Jan 24, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 4 additions & 2 deletions src/main/scala/scalafix/internal/sbt/ScalafixInterface.scala
Original file line number Diff line number Diff line change
Expand Up @@ -121,11 +121,14 @@ object ScalafixInterface {
ScalafixInterface
] = new BlockingCache

private[scalafix] val defaultLogger: Logger = ConsoleLogger(System.out)

def fromToolClasspath(
scalafixBinaryScalaVersion: String,
scalafixDependencies: Seq[ModuleID],
scalafixCustomResolvers: Seq[Repository],
logger: Logger = ConsoleLogger(System.out)
logger: Logger,
callback: ScalafixMainCallback
): () => ScalafixInterface =
new LazyValue({ () =>
fromToolClasspathMemo.getOrElseUpdate(
Expand All @@ -145,7 +148,6 @@ object ScalafixInterface {
"Scala 2.11 is no longer supported. Please downgrade to the final version supporting " +
"it: sbt-scalafix 0.10.4."
)
val callback = new ScalafixLogger(logger)
val scalafixArguments = ScalafixAPI
.fetchAndClassloadInstance(
scalafixBinaryScalaVersion,
Expand Down
14 changes: 12 additions & 2 deletions src/main/scala/scalafix/sbt/ScalafixPlugin.scala
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import sbt.Keys._
import sbt._
import sbt.internal.sbtscalafix.JLineAccess
import sbt.plugins.JvmPlugin
import scalafix.interfaces.ScalafixError
import scalafix.interfaces.{ScalafixError, ScalafixMainCallback}
import scalafix.internal.sbt.Arg.ToolClasspath
import scalafix.internal.sbt._

Expand Down Expand Up @@ -75,6 +75,13 @@ object ScalafixPlugin extends AutoPlugin {
"Optional location to .scalafix.conf file to specify which scalafix rules should run. " +
"Defaults to the build base directory if a .scalafix.conf file exists."
)

val scalafixCallback: SettingKey[ScalafixMainCallback] =
settingKey[ScalafixMainCallback](
"The handler for the diagnostics emitted during scalafix execution. Can be set in ThisBuild or at project-level. " +
xuwei-k marked this conversation as resolved.
Show resolved Hide resolved
"Defaults to a wrapper around `sbt.Logger`."
)

val scalafixSemanticdb: ModuleID =
scalafixSemanticdb(BuildInfo.scalametaVersion)
def scalafixSemanticdb(scalametaVersion: String): ModuleID =
Expand Down Expand Up @@ -161,7 +168,9 @@ object ScalafixPlugin extends AutoPlugin {
scalafixInterfaceProvider := ScalafixInterface.fromToolClasspath(
scalafixScalaBinaryVersion.value,
scalafixDependencies = scalafixDependencies.value,
scalafixCustomResolvers = scalafixResolvers.value
scalafixCustomResolvers = scalafixResolvers.value,
logger = ScalafixInterface.defaultLogger,
callback = (ThisBuild / scalafixCallback).value
),
update := {
object SemanticdbScalac {
Expand Down Expand Up @@ -199,6 +208,7 @@ object ScalafixPlugin extends AutoPlugin {
)

override lazy val globalSettings: Seq[Def.Setting[_]] = Seq(
scalafixCallback := new ScalafixLogger(ScalafixInterface.defaultLogger),
scalafixConfig := None, // let scalafix-cli try to infer $CWD/.scalafix.conf
scalafixOnCompile := false,
scalafixCaching := true,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,9 @@ class SbtCompletionsSuite extends AnyFunSuite {
MavenRepository.of(
"https://oss.sonatype.org/content/repositories/snapshots"
)
)
),
ScalafixInterface.defaultLogger,
new ScalafixLogger(ScalafixInterface.defaultLogger)
)()
val loadedRules = mainArgs.availableRules.toList

Expand Down
3 changes: 2 additions & 1 deletion src/test/scala/scalafix/internal/sbt/ScalafixAPISuite.scala
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,8 @@ class ScalafixAPISuite extends AnyFunSuite {
"https://oss.sonatype.org/content/repositories/snapshots"
)
),
logger
logger,
new ScalafixLogger(logger)
)()
.withArgs(Arg.PrintStream(new PrintStream(baos)))
val tmp = Files.createTempFile("scalafix", "Tmp.scala")
Expand Down