The document formatting provider interface defines the contract between extensions and the formatting-feature.
The document formatting provider interface defines the contract between extensions and the formatting-feature.
(provide-document-formatting-edits document-formatting-edit-provider
document
options
token)
Provide formatting edits for a whole document.
Parameters:
document
: TextDocument
- The document in which the command was invoked.options
: FormattingOptions
- Options controlling formatting.token
: CancellationToken
- A cancellation token.Returns: ProviderResult<TextEdit[]>
- A set of text edits or a thenable that resolves to such. The lack of a result can be
signaled by returning undefined
, null
, or an empty array.
Provide formatting edits for a whole document. **Parameters:** - `document`: `TextDocument` - The document in which the command was invoked. - `options`: `FormattingOptions` - Options controlling formatting. - `token`: `CancellationToken` - A cancellation token. **Returns:** `ProviderResult<TextEdit[]>` - A set of text edits or a thenable that resolves to such. The lack of a result can be signaled by returning `undefined`, `null`, or an empty array.
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close