Structs

Build target contains metadata about an artifact (for example library, test, or binary artifact)

BuildTarget Capabilities

The clean cache request is sent from the client to the server to reset any state associated with a given build target. The state can live either in the build tool or in the file system.

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.

Note that an empty run request is valid. Run will be executed in the target as specified in the build tool.

The build target dependency modules request is sent from the client to the server to query for the libraries of build target dependencies that are external to the workspace including meta information about library and their sources. It’s an extended version of buildTarget/sources.

The build target dependency sources request is sent from the client to the server to query for the sources of build target dependencies that are external to the workspace. The dependency sources response must not include source files that belong to a build target within the workspace, see buildTarget/sources. The server communicates during the initialize handshake whether this method is supported or not. This method can for example be used by a language server on textDocument/definition to “Go to definition” from project sources to dependency sources.

The build target changed notification is sent from the server to the client to signal a change in a build target. The server communicates during the initialize handshake whether this method is supported or not.

The build target resources request is sent from the client to the server to query for the list of resources of a given list of build targets.

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.

Note that an empty run request is valid. Run will be executed in the target as specified in the build tool.

The build target sources request is sent from the client to the server to query for the list of text documents and directories that are belong to a build target. The sources response must not include sources that are external to the workspace.

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.

Note that an empty run request is valid. Run will be executed in the target as specified in the build tool.

The debug request is sent from the client to the server to debug build target(s). The server launches a Microsoft DAP server and returns a connection URI for the client to interact with.

Like the language server protocol, the initialize request is sent as the first request from the client to the server. If the server receives a request or notification before the initialize request it should act as follows:

Initialize Build response result

The log message notification is sent from the server to the client to ask the client to log a particular message.

Server Capabilities

The show message notification is sent from a server to a client to ask the client to display a particular message in the user interface.

The Task Id allows clients to uniquely identify a BSP task and establish a client-parent relationship with another task id.

After a taskStart and before taskFinish for a taskId, the server may send any number of progress notifications.

The inverse sources request is sent from the client to the server to query for the list of build targets containing a text document. The server communicates during the initialize handshake whether this method is supported or not. This request can be viewed as the inverse of buildTarget/sources, except it only works for text documents and not directories.

A parsed URL record.

The workspace build targets request is sent from the client to the server to ask for the list of all available build targets in the workspace.

Enums

Free-form string tags to categorize or label this build target. For example, can be used by the client to:

Traits

Type Definitions

preserved for later