@microsoft-github-policy-service agree company="Google"

Hey Johannes, that makes sense to me. Can you point me to more context on "debt week"? I tried searching further through the wiki and couldn't find anything.

As noted in the associated issue, we find this approach provides significant performance improvements when formatting multiple ranges via a remote language server. I'm open to alternative approaches, but I believe this current PR follows the API guidelines. I understand the API phone call and implementation in vscode.proposed...d.ts is still missing here.

Discussed this with @dbaeumer and we are in favour of the following

• have an option when registering a DocumentRangeFormattingEditProvider that says "canFormatMultipleRanges"
• add a field to FormattingOption that contains all ranges

When invoking the provider always pass the array of ranges (even is length is 1) to provider that support it and always enforce that the returned text edits don't overlap. The latter is easy to enforce but something implementors need to be aware of - it might be easy to return overlapping edits when formatting multiple ranges.

add a field to FormattingOption that contains all ranges

I wasn't quite sure if you meant the way it's coded in the latest commit or if you meant as a flag in the options. Happy to change it if I misunderstood.