Proposed formatMultipleRanges throws in intersecting edit check

[c-claeys]

Does this issue occur when all extensions are disabled?: No

• VS Code Version:
• OS Version:

Steps to Reproduce:

1. Use the new formatMultipleRanges proposed API in an extension to format multiple ranges at once, such that the provider canFormatMultipleRanges.
2. Format >1 range via e.g. via the FormatModifiedLines command.
3. hasIntersectingEdit will throw around here.

While result is guaranteed to be truthy, rawEditsList will then always have a length of 1. One solution is thus to change this line to rawEditsList.push(...result); but I think this may still be problematic.

The loop surrounding hasIntersectingEdit has an assumption that the length of ranges is === to the length of rawEditsList. While this is clearly true when there is one provideDocumentRangeFormattingEdits call per range, as is the case in the non canFormatMultipleRanges situation, I don't think this assumption should or will hold for the canFormatMultipleRanges case. At the very least, given provideDocumentRangeFormattingEdits can return undefined, this fallback would need to be something more like )) || ranges.map(() => undefined);.

My PR initially kept the hasIntersectingEdit loop separate from the canFormatMultipleRanges case for this reason and I still lean towards restoring that behavior. If we instead want to keep the loop for this case, I think we would need some sort of attribution of which ranges correspond to which raw edits, in addition to the above suggestions.

[jrieken]

My PR initially kept the hasIntersectingEdit loop separate from the canFormatMultipleRanges case for this reason and I still lean towards restoring that behavior.

👍 that was an oversight on my end

[vscodenpa]

This bug has been fixed in the latest release of VS Code Insiders!

@c-claeys, you can help us out by commenting /verified if things are now working as expected.

If things still don't seem right, please ensure you're on version d6290ef of Insiders (today's or later - you can use Help: About in the command palette to check), and leave a comment letting us know what isn't working as expected.

Happy Coding!

[rzhao271]

provideDocumentRangesFormattingEdits LGTM. I wrote a small test extension, selected some ranges, ran a command that passed those ranges to that API, and it didn't throw.