feat: support acceptKind for text editor selections

Author: kermanx

docs/guide/editor.md

@@ -124,7 +124,7 @@ The following 4 composable can be used to **get and set** the selections of edit
 - `reactive::useNotebookEditorSelections` - All selections in the notebook editor.
 - `reactive::useNotebookEditorSelection` - The primary selection in the notebook editor.
 
-See their docs for more information.
+See their docs for more information. Note that `reactive::useTextEditorSelections` and `reactive::useTextEditorSelection` also support an `acceptKind` option to filter the change kind which has triggered this event (See `vscode::TextEditorSelectionChangeKind`).
 
 ## Editor Viewport
 

packages/core/src/composables/useNotebookEditorSelection.ts

@@ -1,29 +1,22 @@
 import type { NotebookEditor } from 'vscode'
-import { window } from 'vscode'
-import { computed, shallowRef } from '../reactivity'
+import { computed } from '../reactivity'
 import { createKeyedComposable } from '../utils'
-import { useDisposable } from './useDisposable'
+import { useNotebookEditorSelections } from './useNotebookEditorSelections'
 
 /**
  * @reactive `NotebookEditor.selection`
  * @category editor
  */
 export const useNotebookEditorSelection = createKeyedComposable(
   (notebookEditor: NotebookEditor) => {
-    const selection = shallowRef(notebookEditor.selection)
-
-    useDisposable(window.onDidChangeNotebookEditorSelection((ev) => {
-      if (ev.notebookEditor === notebookEditor)
-        selection.value = ev.selections[0]
-    }))
+    const selections = useNotebookEditorSelections(notebookEditor)
 
     return computed({
       get() {
-        return selection.value
+        return selections.value[0]
       },
       set(newSelection) {
-        selection.value = newSelection
-        notebookEditor.selection = newSelection
+        selections.value = selections.value.toSpliced(0, 1, newSelection)
       },
     })
   },

packages/core/src/composables/useTextEditorSelection.ts

@@ -1,29 +1,23 @@
-import type { TextEditor } from 'vscode'
-import { window } from 'vscode'
-import { computed, shallowRef } from '../reactivity'
+import type { TextEditor, TextEditorSelectionChangeKind } from 'vscode'
+import type { MaybeRefOrGetter } from '../reactivity'
+import { computed } from '../reactivity'
 import { createKeyedComposable } from '../utils'
-import { useDisposable } from './useDisposable'
+import { useTextEditorSelections } from './useTextEditorSelections'
 
 /**
  * @reactive `TextEditor.selection`
  * @category editor
  */
 export const useTextEditorSelection = createKeyedComposable(
-  (textEditor: TextEditor) => {
-    const selection = shallowRef(textEditor.selection)
-
-    useDisposable(window.onDidChangeTextEditorSelection((ev) => {
-      if (ev.textEditor === textEditor)
-        selection.value = ev.selections[0]
-    }))
+  (textEditor: TextEditor, acceptKind?: MaybeRefOrGetter<(TextEditorSelectionChangeKind | undefined)[]>) => {
+    const selections = useTextEditorSelections(textEditor, acceptKind)
 
     return computed({
       get() {
-        return selection.value
+        return selections.value[0]
       },
       set(newSelection) {
-        selection.value = newSelection
-        textEditor.selection = newSelection
+        selections.value = selections.value.toSpliced(0, 1, newSelection)
       },
     })
   },

packages/core/src/composables/useTextEditorSelections.ts

@@ -1,6 +1,7 @@
-import type { TextEditor } from 'vscode'
+import type { TextEditor, TextEditorSelectionChangeKind } from 'vscode'
 import { window } from 'vscode'
-import { computed, shallowRef } from '../reactivity'
+import type { MaybeRefOrGetter } from '../reactivity'
+import { computed, shallowRef, toValue } from '../reactivity'
 import { createKeyedComposable } from '../utils'
 import { useDisposable } from './useDisposable'
 
@@ -9,11 +10,12 @@ import { useDisposable } from './useDisposable'
  * @category editor
  */
 export const useTextEditorSelections = createKeyedComposable(
-  (textEditor: TextEditor) => {
+  (textEditor: TextEditor, acceptKind?: MaybeRefOrGetter<(TextEditorSelectionChangeKind | undefined)[]>) => {
     const selections = shallowRef(textEditor.selections)
 
     useDisposable(window.onDidChangeTextEditorSelection((ev) => {
-      if (ev.textEditor === textEditor)
+      const kinds = toValue(acceptKind)
+      if (ev.textEditor === textEditor && (!kinds || kinds.includes(ev.kind)))
         selections.value = ev.selections
     }))