scalafix.interfaces

Interface Scalafix

public interface Scalafix

Public API for reflectively invoking Scalafix from a build tool or IDE integration.

To obtain an instance of Scalafix, use one of the static factory methods.

Method Summary

Modifier and Type	Method and Description
static Scalafix	classloadInstance(java.lang.ClassLoader classLoader) JVM runtime reflection method helper to classload an instance of Scalafix.
static Scalafix	fetchAndClassloadInstance(java.lang.String scalaBinaryVersion) Fetch JARs containing an implementation of Scalafix using Coursier and classload an instance of it via runtime reflection.
static Scalafix	fetchAndClassloadInstance(java.lang.String requestedScalaVersion, java.util.List<coursierapi.Repository> repositories) Fetch JARs containing an implementation of Scalafix from the provided repositories using Coursier and classload an instance of it via runtime reflection.
java.lang.String	mainHelp(int screenWidth) Get --help message for running the Scalafix command-line interface.
ScalafixArguments	newArguments()
java.lang.String	scala211() Deprecated.
java.lang.String	scala212() The Scala 2.12 version in supportedScalaVersions()
java.lang.String	scala213() The Scala 2.13 version in supportedScalaVersions()
java.lang.String	scala3LTS() The Scala 3 LTS version in supportedScalaVersions()
java.lang.String	scala3Next() The Scala 3 Next version in supportedScalaVersions()
java.lang.String	scalafixVersion() The release version of the current Scalafix API instance.
java.lang.String	scalametaVersion() The recommended Scalameta version to match the current Scalafix API instance.
java.lang.String	scalaVersion() The exact Scala versions used
java.lang.String[]	supportedScalaVersions() The exact Scala versions that are supported

Method Detail

newArguments

ScalafixArguments newArguments()

Returns:

Construct a new instance of ScalafixArguments.

mainHelp

java.lang.String mainHelp(int screenWidth)

Get --help message for running the Scalafix command-line interface.

Parameters:

screenWidth - The width of the screen, used for wrapping long sentences into multiple lines.

Returns:

The help message as a string.

scalaVersion

java.lang.String scalaVersion()

The exact Scala versions used

scalafixVersion

java.lang.String scalafixVersion()

The release version of the current Scalafix API instance.

scalametaVersion

java.lang.String scalametaVersion()

The recommended Scalameta version to match the current Scalafix API instance.

supportedScalaVersions

java.lang.String[] supportedScalaVersions()

The exact Scala versions that are supported

scala211

@Deprecated
java.lang.String scala211()

Deprecated.

scala212

java.lang.String scala212()

The Scala 2.12 version in supportedScalaVersions()

scala213

java.lang.String scala213()

The Scala 2.13 version in supportedScalaVersions()

scala3LTS

java.lang.String scala3LTS()

The Scala 3 LTS version in supportedScalaVersions()

scala3Next

java.lang.String scala3Next()

The Scala 3 Next version in supportedScalaVersions()

fetchAndClassloadInstance

static Scalafix fetchAndClassloadInstance(java.lang.String scalaBinaryVersion)
                                   throws ScalafixException

Fetch JARs containing an implementation of Scalafix using Coursier and classload an instance of it via runtime reflection.

The custom classloader optionally provided with ScalafixArguments.withToolClasspath(java.util.List<java.net.URL>) to compile and classload external rules must have the classloader of the returned instance as ancestor to share a common loaded instance of `scalafix-core`, and therefore have been compiled against the requested Scala binary version.

Parameters:

requestedScalaVersion - The Scala version ("3.3.4" for example) available in the classloader of the returned instance. To be able to run advanced semantic rules using the Scala Presentation Compiler such as ExplicitResultTypes, this must match the version that the target classpath was built with, as provided with ScalafixArguments.withScalaVersion(java.lang.String).

Returns:

An implementation of the Scalafix interface.

Throws:

ScalafixException - in case of errors during artifact resolution/fetching.

fetchAndClassloadInstance

static Scalafix fetchAndClassloadInstance(java.lang.String requestedScalaVersion,
                                          java.util.List<coursierapi.Repository> repositories)
                                   throws ScalafixException

Fetch JARs containing an implementation of Scalafix from the provided repositories using Coursier and classload an instance of it via runtime reflection.

The custom classloader optionally provided with ScalafixArguments.withToolClasspath(java.util.List<java.net.URL>) to compile and classload external rules must have the classloader of the returned instance as ancestor to share a common loaded instance of `scalafix-core`, and therefore have been compiled against the requested Scala binary version.

Parameters:

requestedScalaVersion - The Scala version ("3.3.4" for example) available in the classloader of the returned instance. To be able to run advanced semantic rules using the Scala Presentation Compiler such as ExplicitResultTypes, this must match the version that the target classpath was built with, as provided with ScalafixArguments.withScalaVersion(java.lang.String).

repositories - Maven/Ivy repositories to fetch the JARs from.

Returns:

An implementation of the Scalafix interface.

Throws:

ScalafixException - in case of errors during artifact resolution/fetching.

classloadInstance

static Scalafix classloadInstance(java.lang.ClassLoader classLoader)
                           throws ScalafixException

JVM runtime reflection method helper to classload an instance of Scalafix.

The custom classloader optionally provided with ScalafixArguments.withToolClasspath(java.util.List<java.net.URL>) to compile and classload external rules must have the provided classloader as ancestor to share a common loaded instance of `scalafix-core`, and therefore must have been compiled against the same Scala binary version as the one in the classLoader provided here.

Unless you have an advanced use-case, prefer the high-level overloads that cannot cause runtime errors due to an invalid classloader hierarchy.

Parameters:

classLoader - Classloader containing the full Scalafix classpath, including the scalafix-cli module. To be able to run advanced semantic rules using the Scala Presentation Compiler such as ExplicitResultTypes, this Scala binary version in that classloader should match the one that the target classpath was built with, as provided with ScalafixArguments.withScalaVersion(java.lang.String).

Returns:

An implementation of the Scalafix interface.

Throws:

ScalafixException - in case of errors during classloading, most likely caused by an incorrect classloader argument.