Improved selection

Author: damolinx

CHANGELOG.md

@@ -2,7 +2,8 @@
 
 ## 0.4.21
 
-- Update description for line selection (*selection ...* changes to *lines ...*)
+- Add **Bookmarks: Selection Style** to control bookmark selection behavior, and default to `Full-line` as it provides better visibility.
+- Update description for line selection (*selection ...* changes to *lines ...*).
 
 ## 0.4.20
 

README.md

@@ -113,6 +113,9 @@ In the **Notes** context menu for a given bookmark, use:
 
 ## Navigation
 
+Clicking a bookmark in the **Bookmarks** view opens its target editor and selects the target range. For multi-line bookmarks the default *start-to-start* selection made ranges look like they were missing the last line and made single-line bookmarks harder to spot, so the default selection mode is now *full-line*. You can change this behavior in the **Bookmarks: Selection Mode** setting.
+
+
 ### Commands
 
 There are two commands, **Bookmarks: Go to Next in Current Editor** and **Bookmarks: Go to Previous in Current Editor**, that can be used to jump between bookmarks set in the current editor.
@@ -123,8 +126,7 @@ The following commands are available for other extensions to use: `bookmarks.nav
 
 ## Visualization
 
-Bookmarks are expected to be rendered as markers on the corresponding editor gutter. This is supported via the **Bookmarks: Toggle In-Editor Markers** command but it is disabled by default due to [VSCode #5923](https://github.com/Microsoft/vscode/issues/5923) which causes these markers to affect the breakpoint markers in some cases (unacceptable experience).
-You can also use the **Hide In-Editor Markers** and **Show In-Editor Markers** actions in the **Bookmarks** view menu.
+Clicking a bookmark in the **Bookmarks** view selects its target range in the appropriate editor. Bookmarks can also be rendered as markers on the corresponding editor gutter. This is supported via the **Bookmarks: Toggle In-Editor Markers** command but it is disabled by default due to [VSCode #5923](https://github.com/Microsoft/vscode/issues/5923) which causes these markers to affect the breakpoint markers in some cases (unacceptable experience). You can also use the **Hide In-Editor Markers** and **Show In-Editor Markers** actions in the **Bookmarks** view menu.
 
 <p align="center">
   <img width="448" alt="image" src="https://user-images.githubusercontent.com/38414719/185772569-eebf133d-adfc-4ff2-9c20-9066508a3345.png">

package.json

@@ -234,6 +234,24 @@
             "default": false,
             "description": "Render bookmark markers are displayed in editors.",
             "scope": "application"
+          },
+          "bookmarks.selectionStyle": {
+            "type": "string",
+            "default": "fullLine",
+            "description": "Controls how bookmarks select lines in the editor.",
+            "enum": [
+              "default",
+              "fullLine"
+            ],
+            "enumItemLabels": [
+              "Default",
+              "Full-line"
+            ],
+            "enumDescriptions": [
+              "Selects from the start of the first line to the start of the last line (VS Code default behavior).",
+              "Selects entire lines from start to end, including the last line fully."
+            ],
+            "scope": "application"
           }
         }
       }

src/commands/openBookmark.ts

@@ -0,0 +1,54 @@
+import { commands, Range, workspace } from 'vscode';
+import { Bookmark } from '../bookmark';
+
+export enum BookmarkSelectionStyle {
+  /**
+   * Uses VS Code's default behavior: selects from the start of the first line
+   * to the start of the last line (exclusive).
+   */
+  Default = 'default',
+
+  /**
+   * Selects entire lines from start to end, including the last line fully.
+   */
+  FullLine = 'fullLine',
+}
+
+/**
+ * Open bookmark.
+ */
+export async function openBookmark(
+  bookmark: Bookmark,
+  selectionStyle?: BookmarkSelectionStyle,
+): Promise<void> {
+  let args: any = undefined;
+
+  const targetSelectionStyle =
+    selectionStyle ??
+    workspace.getConfiguration().get('bookmarks.selectionStyle', BookmarkSelectionStyle.Default);
+  if (targetSelectionStyle === BookmarkSelectionStyle.FullLine) {
+    const selection = await getSelection();
+
+    args = { selection };
+  }
+
+  await commands.executeCommand('vscode.open', bookmark.uri, args);
+
+  async function getSelection() {
+    let selection: Range | undefined;
+    const document = await workspace
+      .openTextDocument(bookmark.uri)
+      .then(undefined, () => undefined);
+    if (document) {
+      const zeroStart = bookmark.start - 1;
+      if (bookmark.end === undefined) {
+        selection = document.lineAt(zeroStart).range;
+      } else {
+        const zeroEnd = bookmark.end - 1;
+        selection = new Range(zeroStart, 0, zeroEnd, document.lineAt(zeroEnd).range.end.character);
+      }
+    }
+
+    return selection;
+  }
+}

src/extension.ts

@@ -9,6 +9,7 @@ import { addBookmarkAsync } from './commands/addBookmark';
 import { addBookmarkFolderAsync } from './commands/addBookmarkFolder';
 import { exportBookmarks } from './commands/exportBookmarks';
 import { importBookmarks } from './commands/importBookmarks';
+import { openBookmark } from './commands/openBookmark';
 import { openFolderBookmarks } from './commands/openFolderBookmarks';
 import { removeBookmarkOrFolderAsync } from './commands/removeBookmarkOrFolder';
 import { renameBookmarkFolderAsync } from './commands/renameBookmarkFolder';
@@ -130,6 +131,10 @@ export async function activate(context: vscode.ExtensionContext) {
       'bookmarks.navigate.previous.editor',
       (pathOrUri?: string | vscode.Uri): Thenable<void> => navigateAsync(manager, false, pathOrUri),
     ),
+    vscode.commands.registerCommand(
+      '_bookmarks.open',
+      (bookmark: Bookmark): Thenable<void> => openBookmark(bookmark),
+    ),
     vscode.commands.registerCommand(
       'bookmarks.openFolder.tree',
       (container: BookmarkContainer): Thenable<void> => openFolderBookmarks(container),

src/tree/treeItemProvider.ts

@@ -33,8 +33,8 @@ export abstract class TreeItemProvider {
 
     treeItem.command = {
       title: 'Open',
-      command: 'vscode.open',
-      arguments: [bookmark.uri],
+      command: '_bookmarks.open',
+      arguments: [bookmark],
     };
 
     treeItem.contextValue = 'bookmark';