Provide formatting edits for a range in a document.
The given range is a hint and providers can decide to format a smaller or larger range. Often this is done by adjusting the start and end of the range to full syntax nodes.
The document in which the command was invoked.
The range which should be formatted.
Options controlling formatting.
A cancellation token.
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.
Optional
provideProvide formatting edits for multiple ranges in a document.
This function is optional but allows a formatter to perform faster when formatting only modified ranges or when formatting a large number of selections.
The given ranges are hints and providers can decide to format a smaller or larger range. Often this is done by adjusting the start and end of the range to full syntax nodes.
The document in which the command was invoked.
The ranges which should be formatted.
Options controlling formatting.
A cancellation token.
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.
@monaco-uplift the current monaco version does not yet use this API
The document formatting provider interface defines the contract between extensions and the formatting-feature.