Interface Formatter

Language specific service for handling formatting related LSP requests.

interface Formatter {
    get formatOnTypeOptions(): undefined | DocumentOnTypeFormattingOptions;
    formatDocument(document: LangiumDocument<AstNode>, params: DocumentFormattingParams, cancelToken?: CancellationToken): MaybePromise<TextEdit[]>;
    formatDocumentOnType(document: LangiumDocument<AstNode>, params: DocumentOnTypeFormattingParams, cancelToken?: CancellationToken): MaybePromise<TextEdit[]>;
    formatDocumentRange(document: LangiumDocument<AstNode>, params: DocumentRangeFormattingParams, cancelToken?: CancellationToken): MaybePromise<TextEdit[]>;
}

Implemented by

AbstractFormatter

Index

Accessors

formatOnTypeOptions

Methods

formatDocument formatDocumentOnType formatDocumentRange

Accessors

formatOnTypeOptions

get formatOnTypeOptions(): undefined | DocumentOnTypeFormattingOptions
Options that determine when the formatDocumentOnType method should be invoked by the language client. When undefined is returned, document format on type will be disabled.

Returns undefined | DocumentOnTypeFormattingOptions
- Defined in packages/langium/src/lsp/formatter.ts:39

Methods

formatDocument

formatDocument(document, params, cancelToken?): MaybePromise<TextEdit[]>
Handles full document formatting.
Parameters
- document: LangiumDocument<AstNode>
- params: DocumentFormattingParams
- OptionalcancelToken: CancellationToken
Returns MaybePromise<TextEdit[]>
- Defined in packages/langium/src/lsp/formatter.ts:26

formatDocumentOnType

formatDocumentOnType(document, params, cancelToken?): MaybePromise<TextEdit[]>
Handles document formatting while typing. Only formats the current line.
Parameters
- document: LangiumDocument<AstNode>
- params: DocumentOnTypeFormattingParams
- OptionalcancelToken: CancellationToken
Returns MaybePromise<TextEdit[]>
- Defined in packages/langium/src/lsp/formatter.ts:34

formatDocumentRange

formatDocumentRange(document, params, cancelToken?): MaybePromise<TextEdit[]>
Handles partial document formatting. Only parts of the document within the params.range property are formatted.
Parameters
- document: LangiumDocument<AstNode>
- params: DocumentRangeFormattingParams
- OptionalcancelToken: CancellationToken
Returns MaybePromise<TextEdit[]>
- Defined in packages/langium/src/lsp/formatter.ts:30