feat: Cursor Placement Setting & Behavior When Bookmarking

[metal-gabe]

Add bookmarks.cursorPosition setting

Introduces a new configuration setting, bookmarks.cursorPosition, that controls which column position is stored when a bookmark is created.

New setting: bookmarks.cursorPosition

Value	Behavior
currentPosition (default)	Stores the cursor's current column position (existing behavior)
lineStart	Always stores column 0 (the very start of the line)
contentStart	Stores the column of the first non-whitespace character on the line
contentEnd	Stores the column just after the last non-whitespace character on the line

Changes

• package.json — Registers the new bookmarks.cursorPosition configuration contribution with its enum values and descriptions.
• package.nls.json — Adds localization keys for the new setting's description and all enum option descriptions.
• src/core/controller.ts — Adds a resolveColumn private method that reads the setting and computes the appropriate column value at bookmark creation time. Both labeled and unlabeled bookmark paths now use resolveColumn instead of position.character directly. The method opens the text document to inspect line content when needed, with a fallback to the active editor.

Note

• Resolves PR [FEATURE] - Cursor Placement Setting & Behavior When Bookmarking #875

[alefragnani]

Hi @metal-gabe ,

As discussed in the issue, I would take a different approach. So, the changes in controller could be reverted. You should take a closer look at revealPosition in src/utils/reveal.ts file (since it handles all navigation);list in src/extension.ts and listBookmarks in src/core/operations.ts since it is used by Command Palette and Side Bar to display the bookmarks and their previews.

Let'me know if you need any help

[alefragnani]

As discussed in the issue, I would take a different approach. And the settings would have a slight different id/options too.

bookmarks.navigation.columnMode

• "stored" (default) — current behavior, cursor lands at stored column
• "lineStart" — always go to column 0
• "firstNonWhitespace" — go to first non-whitespace character
• "lineEnd" — go to end of line

[metal-gabe]

@alefragnani alright, the feature has been updated with this new approach

please let me know how everything looks!

[alefragnani]

Hi @metal-gabe ,

First of all, sorry for the late reply, and thanks for the update in the PR.

I was able to test it, and it seems to be almost perfect. I noticed two small issues, and would like you to address it.

• 1. Behavior regression in cursor restore flow: Since revelPosition now always rewrites the target column via navigation.columnMode, when the user cancels the quick-picks from Bookmarks: List and Bookmarks: List from All Files commands, the cursor does not return to the original position, but instead, goes to the position defined in the bookmarks.navigation.columnMode setting. I would suggest adding an optional param to revealPosition function that when set, jump reveal the exact location. Something like:

export function revealPosition(line: number, column: number, directJump?: boolean): void {
    if (isNaN(column)) {
        revealLine(line);
    } else {
        const resolvedColumn = directJump ? column : resolveNavigationColumn(line, column);
        ...

And, in extension.ts on both list() and listFromAllFiles() functions, when selection === undefined, the revealPosition should use directJump as true.

• 2. Localization missed for other languages: The new entries in package.json should be added to other (than english) languages as well.

Thank you