Skip to main content

Decoration Protocol v0.2.0

Metals implements a Language Server Protocol extension called the "Decoration Protocol" to display non-editable text in the text editor.

Base data structures#

The Decoration Protocol has several base data structures that are mostly derived from the VS Code API.

Decoration#

A "decoration" represents non-editable code that is displayed in the text editor alongside editable code. The GIF below demonstrates an example of green decorations that are formatted as comments, which contain the evaluated code.

Example decoration

Although decorations appear as text inside the editor, they can't be edited by the user. In the GIF above, observe that the decoration can optionally include a message that's displayed on mouse hover.

DecorationOptions#

export interface DecorationOptions {
/**
* The range position to place the decoration.
* The Range data structure is defined in the Language Server Protocol.
*/
range: Range;
/**
* The text to display when the mouse hovers over the decoration.
* The MarkupContent data structure is defined in the LanguageServerProtocol
*/
hoverMessage?: MarkupContent;
/** The URI of the text document to place text decorations */
renderOptions: ThemableDecorationInstanceRenderOption;
}

ThemableDecorationInstanceRenderOption#

export interface ThemableDecorationInstanceRenderOption {
/** The decoration to display next to the given range. */
after?: ThemableDecorationAttachmentRenderOptions;
}

ThemableDecorationAttachmentRenderOptions#

export interface ThemableDecorationAttachmentRenderOptions {
/** The text to display in the decoration */
contentText?: string;
/** The color of `contentText`. More colors may be added in the future. */
color?: "green";
/** The font style to use for displaying `contentText. More styles may be added in the future. */
fontStyle?: "italic";
}

Endpoints#

The Decoration Protocol is embedded inside the Language Server Protocol and consists of a single JSON-RPC notification.

initialize#

The Decoration Protocol is only enabled when client declares support for the protocol by adding an decorationProvider: true field to the initializationOptions during the initialize request.

Depending on your editor, it may also allow for inline decorations. This is used for features like showing implicit arguments and inferred types, both which are user configuration settings that a user can toggle. However, in order for those features to use decorations rather than just extra information in your hover, your client also needs to declare that it's an inlineDecorationsProvider.

"initializationOptions": {
"decorationProvider": true,
"inlineDecorationProvider": true
}

metals/publishDecorations#

The decoration ranges did change notification is sent from the server to the client to notify that decorations have changes for a given text document.

Notification:

  • method: metals/publishDecorations
  • params: PublishDecorationsParams as defined below:
export interface PublishDecorationsParams {
/** The URI of the text document to place text decorations */
uri: string;
/**
* The ranges to publish for this given document.
* Use empty list to clear all decorations.
*/
options: DecorationOptions[];
}

Changelog#

  • v0.1.0: First release with basic support for worksheets.
  • v0.2.0: MarkedString in DecorationOptions changed to MarkupContent to align with LSP 3.15