package doctor
- Alphabetic
- Public
- Protected
Type Members
- case class BuildTarget(name: String) extends ErrorReportsGroup with Product with Serializable
- case class DeprecatedRemovedSbtVersion(sbtVersion: String, scalaVersion: String) extends ScalaProblem with Product with Serializable
- case class DeprecatedRemovedScalaVersion(version: String) extends ScalaProblem with Product with Serializable
- case class DeprecatedSbtVersion(sbtVersion: String, scalaVersion: String) extends ScalaProblem with Product with Serializable
- case class DeprecatedScalaVersion(version: String) extends ScalaProblem with Product with Serializable
- final class Doctor extends AnyRef
Helps the user figure out what is mis-configured in the build through the "Run doctor" command.
Helps the user figure out what is mis-configured in the build through the "Run doctor" command.
At the moment, the doctor only validates that SemanticDB is enabled for all projects.
- sealed trait DoctorExplanation extends AnyRef
Various explanations to help explain the various sections of a Build Target in the Doctor.
- final case class DoctorFolderHeader(projectsJavaInfo: Option[String], buildTool: Option[String], buildServer: String, importBuildStatus: Option[String], isBuildServerResponsive: Option[Boolean]) extends Product with Serializable
- projectsJavaInfo
information about java used for project
- buildTool
if Metals detected multiple build tools, this specifies the one the user has chosen
- buildServer
the build server that is being used
- importBuildStatus
if the user has turned the import prompt off, this will include a message on how to get it back.
- final case class DoctorFolderResults(folder: String, header: DoctorFolderHeader, messages: Option[List[DoctorMessage]], targets: Option[Seq[DoctorTargetInfo]], explanations: List[Obj], errorReports: List[ErrorReportInfo]) extends Product with Serializable
- final case class DoctorHeader(jdkInfo: Option[String], serverInfo: String, buildTargetDescription: String) extends Product with Serializable
- jdkInfo
java version and location information
- serverInfo
the version of the server that is being used
- buildTargetDescription
small description on what a build target is
- final case class DoctorMessage(title: String, recommendations: List[String]) extends Product with Serializable
- final case class DoctorResults(title: String, header: DoctorHeader, folders: List[DoctorFolderResults]) extends Product with Serializable
- sealed case class DoctorStatus(explanation: String, isCorrect: Boolean) extends Product with Serializable
- final case class DoctorTargetInfo(name: String, gotoCommand: String, dataKind: String, baseDirectory: Option[String], targetType: String, compilationStatus: DoctorStatus, diagnosticsStatus: DoctorStatus, interactiveStatus: DoctorStatus, indexesStatus: DoctorStatus, debuggingStatus: DoctorStatus, javaStatus: DoctorStatus, recommenedFix: String) extends Product with Serializable
- case class DoctorVisibilityDidChangeParams(visible: Boolean) extends Product with Serializable
- final case class ErrorReportInfo(name: String, timestamp: Long, uri: String, buildTarget: Option[String], shortSummary: String, errorReportType: String) extends Product with Serializable
Information about an error report.
Information about an error report.
- name
display name of the error
- timestamp
date and time timestamp of the report
- uri
error report file uri
- buildTarget
optional build target that error is associated with
- shortSummary
short error summary
- errorReportType
one of "metals", "metals-full", "bloop"
- sealed trait ErrorReportsGroup extends AnyRef
- case class FutureScalaVersion(version: String) extends ScalaProblem with Product with Serializable
- class HeadDoctor extends AnyRef
- sealed abstract class JavaProblem extends AnyRef
Class describing different issues that a build target can have that might influence features available to a user.
Class describing different issues that a build target can have that might influence features available to a user. For example without the semanticdb option "find references" feature will not work. Those problems will be reported to a user with an explanation on how to fix it.
- case class JavaSemanticDBDisabled(bloopVersion: String, unsupportedBloopVersion: Boolean) extends JavaProblem with Product with Serializable
- case class MissingJavaSourceRoot(sourcerootOption: String) extends JavaProblem with Product with Serializable
- case class MissingJavaTargetRoot(targetrootOption: String) extends JavaProblem with Product with Serializable
- case class MissingJdkSources(candidates: List[io.AbsolutePath]) extends ScalaProblem with Product with Serializable
- case class MissingSourceRoot(sourcerootOption: String) extends ScalaProblem with Product with Serializable
- class ProblemResolver extends AnyRef
- sealed abstract class ScalaProblem extends AnyRef
Class describing different issues that a build target can have that might influence features available to a user.
Class describing different issues that a build target can have that might influence features available to a user. For example without the semanticdb option "find references" feature will not work. Those problems will be reported to a user with an explanation on how to fix it.
- case class SemanticDBDisabled(scalaVersion: String, bloopVersion: String, unsupportedBloopVersion: Boolean) extends ScalaProblem with Product with Serializable
- case class UnsupportedScalaVersion(version: String) extends ScalaProblem with Product with Serializable
- case class WrongJavaReleaseVersion(current: String, needed: String) extends JavaProblem with Product with Serializable
Value Members
- case object Bloop extends ErrorReportsGroup with Product with Serializable
- object Doctor
- object DoctorExplanation
- object DoctorResults extends java.io.Serializable
- object DoctorStatus extends java.io.Serializable
- object ErrorReportsGroup
- case object FutureSbtVersion extends ScalaProblem with Product with Serializable
- case object Other extends ErrorReportsGroup with Product with Serializable
- case object OutdatedJunitInterfaceVersion extends ScalaProblem with Product with Serializable
- case object OutdatedMunitInterfaceVersion extends ScalaProblem with Product with Serializable
- case object UnsupportedSbtVersion extends ScalaProblem with Product with Serializable