New interface for performing edits and updating ranges

[AndreasArvidsson]

This introduces a new interface to perform updates. The requirements I had was:

1. Support both selections and ranges
2. Support both edits and callback
3. Support setting range expansion behavior per range/selection
4. Support updating selection internally

What this pr doesn't try to do:

1. Improve the range updater logic

Example

const {
  selections: [updatedContentSelections],
  ranges: [updatedEditRanges]
} = await new EditsUpdater(rangeUpdater, editableEditor, edits)
  .selections(contentSelections)
  .ranges(editRanges, RangeExpansionBehavior.openOpen)
  .updateEditorSelections()
  .run();

Ponderings

1. Should updating editor selections be opt out instead?
2. Here I'm using two separate classes EditsUpdater and CallbackUpdater. I'm a bit tempted to just use a single class and a polymorphic argument. editsOrCallback: Edit[] | () => Promise<void>. Something like that.
3. Strict necessary we don't actually need the two separate return lists. Internally the range updater works with selections so we converting ranges to selections internally. We could just return a single list of selections and since all selections are also ranges I don't think any of the actions would actually care?

If we embrace this polymorphic nature it could look something like this:

const [updatedEditSelections, updatedContentSelections] =
  await new EditsUpdater(rangeUpdater, editableEditor, edits)
    .add(contentSelections)
    .add(editRanges, RangeExpansionBehavior.openOpen)
    .updateEditorSelections()
    .run();

Personally I am a fan of the above since it became cleaner and simpler, but I know that @pokey generally doesn't prefer union arguments if it can be avoided.

We could of course get rid of new if we wanted to make it even cleaner.

const [updatedEditSelections, updatedContentSelections] =
  await performUpdates(rangeUpdater, editableEditor, edits)
    .add(contentSelections)
    .add(editRanges, RangeExpansionBehavior.openOpen)
    .updateEditorSelections()
    .run();

Related to #729

Checklist

• [/] I have added tests
• [/] I have updated the docs and cheatsheet
• [/] I have not broken the cheatsheet

[pokey]

Proposed new interface:

const {
  sourceEditRanges: updatedSourceEditRanges,
  destinationEditRanges: updatedDestinationEditRanges,
} = await performEditsAndUpdateSelections({
  rangeUpdator,
  editor: editableEditor,
  edits: filteredEdits.map(({ edit }) => edit),
  // callback: async () => {...do whatever},
  selections: {
    sourceEditRanges,
    destinationEditRanges: {
      selections: destinationEditRanges,
      behavior: RangeExpansionBehavior.openOpen,
    },
  },
  // preserveEditorSelections: true,
});

In the future we can do something fancier eg put it on the ide or on the editableEditor or only ever have editableEditor as something that gets passed into the callback function, etc

Note that the values in the map passed to selections can be Range | Selection | {selections: Range | Selection, behavior: RangeExpansionBehavior}

[AndreasArvidsson]

@pokey Updated according to the new interface now

[pokey]

bunch of very minor nits. Feel free to merge once you've addressed the ones that seem important enough to address 😅

Happy with how the interface turned out tho; nice to rip out all those extra functions

[pokey]

tempting to have shorthand

Suggested change

	const { contentRanges: updatedRanges } =
	await performEditsAndUpdateSelections({
	rangeUpdater: this.rangeUpdater,
	editor: editableEditor,
	edits,
	selections: {
	contentRanges,
	},
	});
	const updatedRanges =
	await performEditsAndUpdateSelections({
	rangeUpdater: this.rangeUpdater,
	editor: editableEditor,
	edits,
	selections: contentRanges,
	});

but that might be getting a bit too overloaded 😅

[AndreasArvidsson]

Yeah I think that is to much