sbt.internal.bsp

Members list

Packages

Type members

Classlikes

final class BspCompileResult extends Serializable

Compile Response

Compile Response

Value parameters

originId

An optional request id to know the origin of this report.

statusCode

A status code for the execution.

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class BspConnectionDetails extends Serializable

https://build-server-protocol.github.io/docs/server-discovery.html

Value parameters

argv

Command arguments runnable via system processes to start a BSP server

bspVersion

The bsp version of the build tool

languages

A collection of languages supported by this BSP server

name

The name of the build tool

version

The version of the build tool

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class BuildClientCapabilities extends Serializable

Value parameters

languageIds

The languages that this client supports. The ID strings for each language is defined in the LSP. The server must never respond with build targets for other languages than those that appear in this list.

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class BuildServerCapabilities extends Serializable

Value parameters

canReload

Reloading the workspace state through workspace/reload is supported

compileProvider

The languages the server supports compilation via method buildTarget/compile.

dependencySourcesProvider

The server provides sources for library dependencies via method buildTarget/dependencySources

testProvider

The languages the server supports test execution via method buildTarget/test

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
final class BuildTarget extends Serializable

Build target

Build target

Value parameters

baseDirectory

The directory where this target belongs to. Multiple build targets are allowed to map to the same base directory, and a build target is not required to have a base directory. A base directory does not determine the sources of a target, see buildTarget/sources.

capabilities

The capabilities of this build target.

data

Language-specific metadata about this target. See ScalaBuildTarget as an example.

dataKind

Kind of data to expect in the data field. If this field is not set, the kind of data is not specified.

dependencies

The direct upstream build target dependencies of this build target

displayName

A human readable name for this target. May be presented in the user interface. Should be unique if possible. The id.uri is used if None.

id

The target’s unique identifier

languageIds

The set of languages that this target contains. The ID string for each language is defined in the LSP.

tags

Free-form string tags to categorize or label this build target. For example, can be used by the client to: - customize how the target should be translated into the client's project model. - group together different but related targets in the user interface. - display icons or colors in the user interface. Pre-defined tags are listed in BuildTargetTag but clients and servers are free to define new tags for custom purposes.

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any
object BuildTarget

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class BuildTargetCapabilities extends Serializable

Value parameters

canCompile

This target can be compiled by the BSP server.

canDebug

This target can be debugged by the BSP server.

canRun

This target can be run by the BSP server.

canTest

This target can be tested by the BSP server.

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class BuildTargetIdentifier extends Serializable

Build Target Identifier

Build Target Identifier

Value parameters

uri

The target's Uri

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
final class CleanCacheParams extends Serializable

Clean Cache Request

Clean Cache Request

Value parameters

targets

A sequence of build targets to clean

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class CleanCacheResult extends Serializable

Clean Cache Response

Clean Cache Response

Value parameters

cleaned

Indicates whether the clean cache request was performed or not

message

Optional message to display to the user

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class CompileParams extends Serializable

Compile Request

Compile Request

Value parameters

arguments

Optional arguments to the compilation process

originId

An optional unique identifier generated by the client to identify this request. The server may include this id in triggered notifications or response.

targets

A sequence of build targets to compile

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any
object CompileParams

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class CompileProvider extends Serializable

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class CompileReport extends Serializable

Value parameters

errors

The total number of reported errors compiling this target.

noOp

The compilation was a noOp compilation.

originId

An optional request id to know the origin of this report

target

The build target that was compiled

time

The total number of milliseconds it took to compile the target.

warnings

The total number of reported warnings compiling the target.

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any
object CompileReport

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class CompileTask extends Serializable

Compile Notifications

Compile Notifications

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any
object CompileTask

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class DebugProvider extends Serializable

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any
object DebugProvider

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class DebugSessionAddress extends Serializable

Value parameters

uri

The target's Uri

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class DebugSessionParams extends Serializable

Value parameters

data

A language-agnostic JSON object interpreted by the server.

dataKind

The kind of data to expect in the data field.

targets

A sequence of build targets affected by the debugging action.

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class DependencySourcesItem extends Serializable

Value parameters

sources

List of resources containing source files of the target's dependencies. Can be source files, jar files, zip files, or directories

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class DependencySourcesParams extends Serializable

Dependency Sources Request

Dependency Sources Request

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class DependencySourcesResult extends Serializable

Dependency Sources Result

Dependency Sources Result

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class Diagnostic extends Serializable

Represents a diagnostic, such as a compiler error or warning. Diagnostic objects are only valid in the scope of a resource.

Represents a diagnostic, such as a compiler error or warning. Diagnostic objects are only valid in the scope of a resource.

Value parameters

code

The diagnostic's code. Can be omitted.

data

A data entry field.

dataKind

Kind of data to expect in the data field. If this field is not set, the kind of data is not specified.

message

The diagnostic's message.

range

The range at which the message applies.

relatedInformation

A list of related diagnostic information, e.g. when symbol-names within a scope collide all definitions can be marked via this property.

severity

The diagnostic's severity. Can be omitted. If omitted it is up to the client to interpret diagnostics as error, warning, info or hint.

source

A human-readable string describing the source of this diagnostic, e.g. 'typescript' or 'super lint'.

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any
object Diagnostic

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
Diagnostic.type
final class DiagnosticRelatedInformation extends Serializable

Represents a related message and source code location for a diagnostic. This should be used to point to code locations that cause or are related to a diagnostics, e.g when duplicating a symbol in a scope.

Represents a related message and source code location for a diagnostic. This should be used to point to code locations that cause or are related to a diagnostics, e.g when duplicating a symbol in a scope.

Value parameters

location

The location of this related diagnostic information.

message

The message of this related diagnostic information.

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
final class InitializeBuildParams extends Serializable

Initialize Build Request

Initialize Build Request

Value parameters

bspVersion

The BSP version that the client speaks

capabilities

The capabilities of the client

data

Additional metadata about the client

displayName

Name of the client

rootUri

The rootUri of the workspace

version

The version of the client

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class InitializeBuildResult extends Serializable

Value parameters

bspVersion

The BSP version that the server speaks

capabilities

The capabilities of the build server

data

Additional metadata about the server

displayName

Name of the server

version

The version of the server

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class JavacOptionsItem extends Serializable

Value parameters

classDirectory

The output directory for classfiles produced by this target

classpath

The dependency classpath for this target, must be identical to what is passed as arguments to the -classpath flag in the command line interface of scalac.

options

Additional arguments to the compiler. For example, -deprecation.

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class JavacOptionsParams extends Serializable

Javac options The build target javac options request is sent from the client to the server to query for the list of compiler options necessary to compile in a given list of targets.

Javac options The build target javac options request is sent from the client to the server to query for the list of compiler options necessary to compile in a given list of targets.

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class JavacOptionsResult extends Serializable

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class JvmEnvironmentItem extends Serializable

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class JvmRunEnvironmentParams extends Serializable

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class JvmRunEnvironmentResult extends Serializable

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class JvmTestEnvironmentParams extends Serializable

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class JvmTestEnvironmentResult extends Serializable

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class Location extends Serializable

Represents a location inside a resource, such as a line inside a text file.

Represents a location inside a resource, such as a line inside a text file.

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any
object Location

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
Location.type
final class MetalsMetadata extends Serializable

Metals metadata in the initialization request

Metals metadata in the initialization request

Value parameters

semanticdbVersion

The semanticdb plugin version that should be enabled for Metals code navigation

supportedScalaVersions

The list of scala versions that are supported by Metals

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class OutputPathItem extends Serializable

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
final class OutputPathsItem extends Serializable

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class OutputPathsParams extends Serializable

Build Target OutputPaths Request

Build Target OutputPaths Request

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class OutputPathsResult extends Serializable

Build Target OutputPaths response

Build Target OutputPaths response

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class Position extends Serializable

Position in a text document expressed as zero-based line and zero-based character offset. A position is between two characters like an 'insert' cursor in a editor.

Position in a text document expressed as zero-based line and zero-based character offset. A position is between two characters like an 'insert' cursor in a editor.

Value parameters

character

Character offset on a line in a document (zero-based).

line

Line position in a document (zero-based).

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any
object Position

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
Position.type
final class PublishDiagnosticsParams extends Serializable

Publish Diagnostics

Publish Diagnostics

Value parameters

buildTarget

The build target where the diagnostics origin. It is valid for one text to belong to multiple build targets, for example sources that are compiled against multiple platforms (JVM, JavaScript).

diagnostics

The diagnostics to be published by the client

originId

The request id that originated this notification

reset

Whether the client should clear the previous diagnostics mapped to the same textDocument and buildTarget

textDocument

The document where the diagnostics are published.

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class Range extends Serializable

A range in a text document expressed as (zero-based) start and end positions. A range is comparable to a selection in an editor. Therefore the end position is exclusive.

A range in a text document expressed as (zero-based) start and end positions. A range is comparable to a selection in an editor. Therefore the end position is exclusive.

Value parameters

end

The range's end position.

start

The range's start position.

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any
object Range

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
Range.type
final class ResourcesItem extends Serializable

Value parameters

resources

List of resource files.

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any
object ResourcesItem

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class ResourcesParams extends Serializable

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class ResourcesResult extends Serializable

Build Target Resources response

Build Target Resources response

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class RunParams extends Serializable

Run Request The run request is sent from the client to the server to run a build target. The server communicates during the initialize handshake whether this method is supported or not. An empty run request is valid.

Run Request The run request is sent from the client to the server to run a build target. The server communicates during the initialize handshake whether this method is supported or not. An empty run request is valid.

Value parameters

arguments

Optional arguments to the executed application.

data

Language-specific metadata for this execution.

dataKind

Kind of data to expect in the data field. If this field is not set, the kind of data is not specified.

originId

An option identifier gnerated by the client to identify this request. The server may include this id in triggered notifications or responses.

target

The build target to run.

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any
object RunParams

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
RunParams.type
final class RunProvider extends Serializable

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any
object RunProvider

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class RunResult extends Serializable

Run Result

Run Result

Value parameters

originId

An optional request id to know the origin of this report.

statusCode

A status code for the execution.

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any
object RunResult

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
RunResult.type
final class SbtBuildTarget extends Serializable

Contains sbt-specific metadata for providing editor support for sbt build files. This metadata is embedded in the data: Option[Json] field of the BuildTarget definition when the dataKind field contains "sbt".

Contains sbt-specific metadata for providing editor support for sbt build files. This metadata is embedded in the data: Option[Json] field of the BuildTarget definition when the dataKind field contains "sbt".

Value parameters

autoImports

A sequence of Scala imports that are automatically imported in the sbt build files.

children

The inverse of parent, list of targets that have this build target defined as their parent. It can contain normal project targets or sbt build targets if this target represents an sbt meta-meta build.

parent

An optional parent if the target has an sbt meta project.

sbtVersion

The sbt version. Useful to support version-dependent syntax.

scalaBuildTarget

The Scala build target describing the scala version and scala jars used by this sbt version.

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class ScalaAction extends Serializable

A Scala action represents a change that can be performed in code. See also LSP: Code Action Request (https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_codeAction).

A Scala action represents a change that can be performed in code. See also LSP: Code Action Request (https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_codeAction).

Value parameters

description

A description that may be shown to the user client side to explain the action.

edit

The workspace edit this code action performs.

title

A short, human-readable, title for this code action.

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any
object ScalaAction

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class ScalaBuildTarget extends Serializable

Contains scala-specific metadata for compiling a target containing Scala sources. This metadata is embedded in the data: Option[Json] field of the BuildTarget definition, when the dataKind field contains "scala".

Contains scala-specific metadata for compiling a target containing Scala sources. This metadata is embedded in the data: Option[Json] field of the BuildTarget definition, when the dataKind field contains "scala".

Value parameters

jars

A sequence of Scala jars such as scala-library, scala-compiler and scala-reflect.

platform

The target platform for this target

scalaBinaryVersion

The binary version of scalaVersion. For example, 2.12 if scalaVersion is 2.12.4.

scalaOrganization

The Scala organization that is used for a target.

scalaVersion

The scala version to compile this target

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class ScalaDiagnostic extends Serializable

ScalaDiagnostic is a data structure that contains Scala-specific metadata generated by Scala compilation. This metadata is embedded in the data: Option[Json] field of the Diagnostic definition, when the dataKind field contains "scala".

ScalaDiagnostic is a data structure that contains Scala-specific metadata generated by Scala compilation. This metadata is embedded in the data: Option[Json] field of the Diagnostic definition, when the dataKind field contains "scala".

Value parameters

actions

Actions (also known as quick fixes) that are able to either fix or address the issue that is causing this diagnostic.

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class ScalaMainClass extends Serializable

Value parameters

arguments

The user arguments to the main entrypoint.

class

The main class to run.

environmentVariables

Additional environment variables for the application.

jvmOptions

The jvm options for the application.

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class ScalaMainClassesItem extends Serializable

Value parameters

classes

The main class items

target

The build target that contains the test classes.

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class ScalaMainClassesParams extends Serializable

Scala Main Class Request The build target main classes request is sent from the client to the server to query for the list of main classes that can be fed as arguments to buildTarget/run.

Scala Main Class Request The build target main classes request is sent from the client to the server to query for the list of main classes that can be fed as arguments to buildTarget/run.

Value parameters

originId

An optional number uniquely identifying a client request.

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class ScalaMainClassesResult extends Serializable

Value parameters

originId

An optional id of the request that triggered this result.

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
object ScalaPlatform

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
final class ScalaTestClassesItem extends Serializable

Value parameters

classes

The fully qualified names of the test classes in this target

framework

The name of the test framework used in test classes.

target

The build target that contains the test classes.

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class ScalaTestClassesParams extends Serializable

Scala Test Class Request The build target scala test options request is sent from the client to the server to query for the list of fully qualified names of test classes in a given list of targets.

Scala Test Class Request The build target scala test options request is sent from the client to the server to query for the list of fully qualified names of test classes in a given list of targets.

Value parameters

originId

An optional number uniquely identifying a client request.

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class ScalaTestClassesResult extends Serializable

Value parameters

originId

An optional id of the request that triggered this result.

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class ScalaTestParams extends Serializable

Scala Test Params ScalaTestParams contains scala-specific metadata for testing Scala targets. This metadata is embedded in the data field of the buildTarget/test request when the dataKind field contains "scala-test".

Scala Test Params ScalaTestParams contains scala-specific metadata for testing Scala targets. This metadata is embedded in the data field of the buildTarget/test request when the dataKind field contains "scala-test".

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class ScalaTextEdit extends Serializable

A textual edit applicable to a text document.

A textual edit applicable to a text document.

Value parameters

newText

The string to be inserted. For delete operations use an empty string.

range

The range of the text document to be manipulated. To insert text into a document create a range where start === end.

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any
object ScalaTextEdit

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class ScalaWorkspaceEdit extends Serializable

A workspace edit represents changes to many resources managed in the workspace.

A workspace edit represents changes to many resources managed in the workspace.

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class ScalacOptionsItem extends Serializable

Value parameters

classDirectory

The output directory for classfiles produced by this target

classpath

The dependency classpath for this target, must be identical to what is passed as arguments to the -classpath flag in the command line interface of scalac.

options

Additional arguments to the compiler. For example, -deprecation.

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class ScalacOptionsParams extends Serializable

Scalac options The build target scalac options request is sent from the client to the server to query for the list of compiler options necessary to compile in a given list of targets.

Scalac options The build target scalac options request is sent from the client to the server to query for the list of compiler options necessary to compile in a given list of targets.

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class ScalacOptionsResult extends Serializable

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class SourceItem extends Serializable

Value parameters

generated

Indicates if this source is automatically generated by the build and is not intended to be manually edited by the user.

kind

Type of file of the source item, such as whether it is file or directory.

uri

Either a text document or a directory. A directory entry must end with a forward slash "/" and a directory entry implies that every nested text document within the directory belongs to this source item.

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any
object SourceItem

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
SourceItem.type

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
final class SourcesItem extends Serializable

Value parameters

sources

The text documents or and directories that belong to this build target.

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any
object SourcesItem

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class SourcesParams extends Serializable

Build Target Sources Request

Build Target Sources Request

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any
object SourcesParams

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class SourcesResult extends Serializable

Build Target Sources response

Build Target Sources response

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any
object SourcesResult

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
object StatusCode

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
StatusCode.type
final class TaskFinishParams extends Serializable

Value parameters

data

Optional metadata about the task.

dataKind

Kind of data to expect in the data field.

eventTime

Optional timestamp of when the event started in milliseconds since Epoch.

message

Optional message describing the task.

status

Task completion status: 1 -> success, 2 -> error, 3 -> cancelled

taskId

Unique id of the task with optional reference to parent task id.

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class TaskId extends Serializable

Value parameters

id

A unique identifier

parents

The parent task ids, if any. A non-empty parents field means this task is a sub-task of every parent task.

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any
object TaskId

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
TaskId.type
final class TaskProgressParams extends Serializable

Value parameters

data

Optional metadata about the task.

dataKind

Kind of data to expect in the data field.

eventTime

Optional timestamp of when the event started in milliseconds since Epoch.

message

Message describing the task progress.

progress

If known, completed amount of work units in this task.

taskId

Unique id of the task with optional reference to parent task id.

total

If known, total amount of work units in this task.

unit

Name of a work unit. For example, "files" or "tests". May be empty.

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class TaskStartParams extends Serializable

Task Notifications

Task Notifications

Value parameters

data

Optional metadata about the task.

dataKind

Kind of data to expect in the data field.

eventTime

Optional timestamp of when the event started in milliseconds since Epoch.

message

Optional message describing the task.

taskId

Unique id of the task with optional reference to parent task id.

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class TestParams extends Serializable

Test Request The test build target request is sent from the client to the server to test the given list of build targets. The server communicates during the initialize handshake whether this method is supported or not.

Test Request The test build target request is sent from the client to the server to test the given list of build targets. The server communicates during the initialize handshake whether this method is supported or not.

Value parameters

arguments

Optional arguments to the test execution engine.

data

Language-specific metadata for this test execution.

dataKind

Kind of data to expect in the data field. If this field is not set, the kind of data is not specified.

originId

An option identifier generated by the client to identify this request. The server may include this id in triggered notifications or responses.

targets

A sequence of build targets to test.

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any
object TestParams

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
TestParams.type
final class TestProvider extends Serializable

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any
object TestProvider

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class TestResult extends Serializable

Test Result

Test Result

Value parameters

originId

An optional request id to know the origin of this report.

statusCode

A status code for the execution.

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any
object TestResult

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
TestResult.type
final class TextDocumentIdentifier extends Serializable

Value parameters

uri

The file's Uri

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
final class WorkspaceBuildTargetsResult extends Serializable

Workspace Build Targets response

Workspace Build Targets response

Value parameters

targets

The build targets in this workspace that contain sources with the given language ids.

Attributes

Companion
object
Supertypes
trait Serializable
class Object
trait Matchable
class Any

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type