Interface DocumentRangeFormattingEditProvider

The document formatting provider interface defines the contract between extensions and the formatting-feature.

interface DocumentRangeFormattingEditProvider {
    displayName?: string;
    provideDocumentRangeFormattingEdits(model, range, options, token): ProviderResult<TextEdit[]>;
    provideDocumentRangesFormattingEdits?(model, ranges, options, token): ProviderResult<TextEdit[]>;


displayName?: string


  • 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.


    Returns ProviderResult<TextEdit[]>