case class WorkspaceSettings(javaSemanticDBVersion: Option[String], semanticDBVersion: Option[String], supportedScalaVersions: Option[List[String]], refreshProjectsCommand: Option[List[String]], traceSettings: Option[TraceSettings]) extends Product with Serializable

Defines the settings of a given workspace. A workspace is a URI that has N configuration files associated with it. Typically the workspace is the root directory where all of the projects in the configuration files are defined.

Workspace settings have a special status in bloop as they change the build load semantics. These changes are represented with DetectedChanges handled in the build loader.

Both the user and bloop can write workspace settings to this file so bloop needs to handle that scenario carefully.

Workspace settings can be written to disk when, for example, Metals asks to import a build and Bloop needs to cache the fact that a build needs to enable Metals specific settings based on some inputs from the BSP clients. These keys are usually the fields of the workspace settings.

Another example is when the user manually goes to the file and changes a setting in it.

javaSemanticDBVersion

is the version that should be used to enable the Semanticdb compiler plugin in a Java project.

semanticDBVersion

is the version that should be used to enable the Semanticdb compiler plugin in a Scala project.

refreshProjectsCommand

is the command that should be run in the BSP server before loading the state and presentings projects to the client.

traceSettings

are the settings provided by the user that customize how the bloop server should behave.

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WorkspaceSettings
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new WorkspaceSettings(javaSemanticDBVersion: Option[String], semanticDBVersion: Option[String], supportedScalaVersions: Option[List[String]], refreshProjectsCommand: Option[List[String]], traceSettings: Option[TraceSettings])

    javaSemanticDBVersion

    is the version that should be used to enable the Semanticdb compiler plugin in a Java project.

    semanticDBVersion

    is the version that should be used to enable the Semanticdb compiler plugin in a Scala project.

    refreshProjectsCommand

    is the command that should be run in the BSP server before loading the state and presentings projects to the client.

    traceSettings

    are the settings provided by the user that customize how the bloop server should behave.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  8. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  9. val javaSemanticDBVersion: Option[String]
  10. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  12. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  13. def productElementNames: Iterator[String]
    Definition Classes
    Product
  14. val refreshProjectsCommand: Option[List[String]]
  15. val semanticDBVersion: Option[String]
  16. val supportedScalaVersions: Option[List[String]]
  17. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  18. val traceSettings: Option[TraceSettings]
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  22. def withSemanticdbSettings: Option[(WorkspaceSettings, SemanticdbSettings)]

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped